picsart creative apis ts sdk

Picsart 創意 API

描述

這是 Picsart 可程式圖像 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 GengenApi. ）；

建立圖像實例

// 來自公開圖片 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.pngSource"); . fromStream(readStream);

刪除背景

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

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

調整影像

  const result =等待imageApi.調整（新的AdjustRequest（）.setImage（imageSource）.setBrightness（90）.setSharpen（40））;
  console.log(結果.image.url);

應用效果

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

  console.log(結果.image.url);

生成背景紋理

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

  console.log(結果.image.url);

預覽影像上選定的效果

  const result = wait imageApi.effectPreviews( new EffectPreviewsRequest().setImage(imageSource).addEffect(EffectName.a1972).addEffect(EffectName.brnz2).addEffect(EffectName.y3);

  console.log(結果.縮圖);

增強臉型

  常數結果 = 等待 imageApi
  .enhanceFace(newEnhanceFaceRequest().setImage(imageSource),
  ）；

  console.log(結果.image.url);

獲得平衡

  const 結果 = 等待 imageApi.getBalance();
  console.log(結果.credits);

取得效果列表

  const 結果 = 等待 imageApi.getEffects();
  console.log(結果.效果)

表面圖

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

  console.log(結果.image.url);

文字轉圖像

  const result = wait genaiApi.text2Image( new Text2ImageRequest().setCount(10).setPrompt("一直在編碼").setNegativePrompt("放鬆休息"));
  console.log(結果.圖片);

上傳圖片

  const fileContent = readFileSync("examples/image.png");
  const blob = new Blob([文件內容]);

  const imageSource = ImageApi.fromFile(blob);
  const 結果 = 等待 imageApi.upload(new UploadRequest() .setImage(imageSource)
  ）；

  console.log(結果.image.url);

高級

  const 結果 = 等待 imageApi.upscale(new UpscaleRequest() .setImage(imageSource) .setUpscaleFactor(UpscaleFactor.R2000x2000)
  ）；

  console.log(結果.image.url);

超增強

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

  console.log(結果.image.url);

超高級

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

  console.log(結果.image.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：

釀造安裝gnu-sed

產生 API 參考

API 引用是根據程式碼中的 TSDoc 註解使用 TypeDoc 產生的。運行以下命令來產生它：

 npm 運行生成文檔

該命令將在/docs目錄中產生 HTML 格式的 API 文件。

測試

若要執行測試，請使用以下命令：

 npm測試

執照

Picsart Creative API SDK 是根據 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 APIs SDK 並希望為這個開源專案做出貢獻，請查看貢獻指南。