picsart creative apis ts sdk

Picsart クリエイティブ API

説明

これは、Picsart Programmable Image API および Picsart GenAI API の TypeScript SDK です。 JavaScript または Typescript プロジェクトに数行のコードを追加するだけで、画像に対して多くのアクションを簡単に実行できます。

インストール

パッケージをインストールするには、次のコマンドを実行します。

 npm install --save picsart-creative-apis-ts-sdk

使用法

APIインスタンスを取得する

import PicsartEnterprise from "picsart-creative-apis-ts-sdk";// 画像 API のインスタンスを取得しますconst imageApi = PicsartEnterprise.createImageApi('YOUR_API_KEY');// GenAI API のインスタンスを取得しますconst genaiApi = PicsartEnterprise.createGenAIApi('YOUR_API_KEY ');

イメージインスタンスを作成する

// 公開画像から urlconst imageSource = ImageApi.fromUrl('https://....');// Picsart から 画像 idconst imageSource = ImageApi.fromImageId('your-image-id-here');// からbinaryconst fileContent = fs.readFileSync("examples/image.png");const imageSource = ImageApi.fromFile(fileContent);// ストリームからconst readStream = fs.createReadStream("examples/image.png");const imageSource = ImageApi.fromStream(readStream);

背景を削除する

  const result = await imageApi.removeBackground( new RemoveBackgroundRequest().setImage(imageSource).setBgColor("green"));

  console.log(結果.画像.url);
  console.log(result.metadata.creditsAvailable);
  console.log(result.metadata.rateLimitResetTime);
  console.log(result.metadata.rateLimit);
  console.log(result.metadata.rateLimitAvailable);
  console.log(result.metadata.correlationId);

画像を調整する

  const result = await imageApi.adjust( new AdjustRequest().setImage(imageSource).setBrightness(90).setSharpen(40));
  console.log(結果.画像.url);

エフェクトを適用する

  const result = await imageApi.effect( new EffectRequest().setImage(imageSource).setEffectName(EffectName.a1972));

  console.log(結果.画像.url);

背景テクスチャを生成する

  const result = await imageApi.backgroundTexture( new BackgroundTextureRequest().setImage(imageSource).setPattern(TexturePattern.diamond).setHeight(800));

  console.log(結果.画像.url);

画像上の選択した効果をプレビューする

  const result = await imageApi.effectPreviews( new EffectPreviewsRequest().setImage(imageSource).addEffect(EffectName.a1972).addEffect(EffectName.brnz2).addEffect(EffectName.icy3).addEffect(EffectName.apr3),);

  console.log(result.thumbnails);

顔を強化する

  const result = imageApiを待つ
  .enhanceFace(new EnhanceFaceRequest() .setImage(imageSource),
  );

  console.log(結果.画像.url);

バランスを取る

  const result = await imageApi.getBalance();
  console.log(結果.クレジット);

エフェクトのリストを取得する

  const result = await imageApi.getEffects();
  console.log(結果.効果)

表面マップ

  const result = await imageApi.surfacemap( new SurfacemapRequest().setImage(imageSource1).setMask(imageSource2).setSticker(imageSource3));

  console.log(結果.画像.url);

テキストから画像へ

  const result = await genaiApi.text2Image( new Text2ImageRequest().setCount(10).setPrompt("ずっとコーディング").setNegativePrompt("リラックスして休む"));
  console.log(結果.画像);

画像をアップロードする

  const fileContent = readFileSync("examples/image.png");
  const blob = 新しい Blob([ファイルコンテンツ]);

  const imageSource = ImageApi.fromFile(blob);
  const result = await imageApi.upload(new UploadRequest() .setImage(imageSource)
  );

  console.log(結果.画像.url);

高級感のある

  const result = await imageApi.upscale(new UpscaleRequest() .setImage(imageSource) .setUpscaleFactor(UpscaleFactor.R2000x2000)
  );

  console.log(結果.画像.url);

ウルトラエンハンス

  const result = await imageApi.ultraEnhance( new UltraEnhanceRequest().setImage(imageSource).setUpscaleFactor(6),);

  console.log(結果.画像.url);

超高級

  const result = await imageApi.ultraUpscale( new UltraUpscaleRequest().setImage(imageSource).setUpscaleFactor(4).setMode(ProcessingMode.async),);

  console.log(結果.画像.url);

建てる

パッケージをビルドするには、次のコマンドを使用します。

 npm ビルドを実行する

プロジェクトのルート ディレクトリに/libディレクトリが作成され、公開できる npm パッケージが含まれます。

定型ライセンス通知の追加

次のコマンドを実行して、すべての *.ts ファイルにボイラープレート ライセンス通知を追加します。

 npm 実行ライセンス

このコマンドは、すべての新しいファイルにヘッダーを追加するだけでなく、必要に応じて既存のファイルも修正します。

これを macOS で実行できるようにするには、GNU sed をインストールする必要があります。まだインストールしていない場合は、次の手順に従ってください。

1. Homebrew をインストールする: Homebrew がインストールされていない場合は、ターミナルを開いて次を実行します。

 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

2. GNU sed をインストールする: Homebrew がインストールされたら、次のコマンドを実行して GNU sed をインストールします。

 brew インストール gnu-sed

API リファレンスの生成

API 参照は、コード内の TSDoc コメントに基づいて TypeDoc を使用して生成されます。次のコマンドを実行して生成します。

 npm run 生成ドキュメント

このコマンドは、API ドキュメントを HTML 形式で/docsディレクトリに生成します。

テスト

テストを実行するには、次のコマンドを使用します。

 npmテスト

ライセンス

Picsart Creative API SDK は、LICENSE ファイルにある MIT ライセンスに基づいて提供されます。このプロジェクトを使用、配布、または貢献すると、このライセンスの利用規約に同意したことになります。

このプロジェクトにはいくつかのサードパーティ依存関係があり、それぞれに独立したライセンスが付与されている場合があります。

• axios:^1.7.2、(MIT): http クライアントとして使用されます

• axios-retry:^4.3.0、(Apache License V2.0): 再試行を処理するための axios の拡張機能として使用されます。

• form-data:^4.0.0、(MIT): マルチパート/フォームデータ ペイロードの構築に使用されます

• yup:^1.4.0, (MIT): クライアント側のリクエストの検証に使用されます

貢献するにはどうすればよいですか?

Picsart Creative API SDK が気に入っており、このオープンソース プロジェクトに貢献したい場合は、貢献ガイドを確認してください。