picsart creative apis ts sdk

PICSART КРЕАТИВНЫЙ APIS

Описание

Это TypeScript SDK API программируемых изображений Picsart и API Picsart GenAI. Вы можете легко выполнять множество действий с изображениями, просто добавив несколько строк кода в свои проекты JavaScript или Typescript.

Установка

Чтобы установить пакет, выполните следующую команду:

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

Использование

Получить экземпляр API

 импортировать PicsartEnterprise из "picsart-creative-apis-ts-sdk"; // Получить экземпляр изображения APIconst imageApi = PicsartEnterprise.createImageApi('YOUR_API_KEY'); // Получить экземпляр GenAI APIconst genaiApi = PicsartEnterprise.createGenAIApi('YOUR_API_KEY'); // Получить экземпляр GenAI APIconst 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);// Из потока readStream = fs.createReadStream("examples/image.png");const imageSource = ImageApi.fromStream(readStream);

Удалить фон

  const result = await imageApi.removeBackground(new RemoveBackgroundRequest().setImage(imageSource).setBgColor("зеленый"));

  console.log(result.image.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(result.image.url);

Применение эффектов

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

  console.log(result.image.url);

Генерация фоновых текстур

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

  console.log(result.image.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);

Улучшить лицо

  константный результат = ожидание imageApi
  .enhanceFace(новый EnhanceFaceRequest() .setImage(imageSource),
  );

  console.log(result.image.url);

Получить баланс

  const result = await imageApi.getBalance();
  console.log(result.credits);

Получить список эффектов

  const result = await imageApi.getEffects();
  console.log(результат.эффекты)

Карта поверхности

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

  console.log(result.image.url);

Текст в изображение

  const result = await genaiApi.text2Image( new Text2ImageRequest().setCount(10).setPrompt("все время кодирую").setNegativePrompt("расслабьтесь и отдохните"));
  console.log(result.images);

Загрузить изображение

  const fileContent = readFileSync("examples/image.png");
  const blob = новый Blob([fileContent]);

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

  console.log(result.image.url);

высококлассный

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

  console.log(result.image.url);

Ультра Улучшение

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

  console.log(result.image.url);

Ультра Высококлассный

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

  console.log(result.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 генерируются с помощью TypeDoc на основе комментариев TSDoc в коде. Запустите следующую команду, чтобы сгенерировать его:

 npm запустить генерировать документы

Эта команда создаст документацию API в формате HTML в каталоге /docs .

Тесты

Для запуска тестов используйте следующую команду:

 НПМ-тест

Лицензия

Picsart Creative APIs SDK предоставляется по лицензии MIT, которую можно найти в файле LICENSE. Используя, распространяя или внося свой вклад в этот проект, вы соглашаетесь с условиями этой лицензии.

Этот проект имеет некоторые сторонние зависимости, каждая из которых может иметь независимое лицензирование:

• axios:^1.7.2, (MIT): используется в качестве http-клиента.

• axios-retry:^4.3.0, (лицензия Apache V2.0): используется как расширение для axios для обработки повторных попыток.

• form-data:^4.0.0, (MIT): используется для создания полезных данных multipart/form-data.

• да:^1.4.0, (MIT): используется для проверки запросов на стороне клиента.

Как внести свой вклад?

Если вам нравится Picsart Creative APIs SDK и вы хотите внести свой вклад в этот проект с открытым исходным кодом, ознакомьтесь с руководством по участию.