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 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 = 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.icy3).addEffect(EffectName.apr3),);

  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 并希望为这个开源项目做出贡献，请查看贡献指南。