picsart creative apis ts sdk

PICSART KREATIV-APIS

Beschreibung

Dies ist ein TypeScript-SDK von Picsart Programmable Image APIs und Picsart GenAI APIs. Sie können ganz einfach viele Aktionen mit Ihren Bildern ausführen, indem Sie einfach ein paar Codezeilen zu Ihren JavaScript- oder Typescript-Projekten hinzufügen.

Installation

Um das Paket zu installieren, führen Sie den folgenden Befehl aus:

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

Verwendung

Holen Sie sich eine API-Instanz

 import PicsartEnterprise from "picsart-creative-apis-ts-sdk";// Holen Sie sich eine Instanz des Bild-APIconst imageApi = PicsartEnterprise.createImageApi('YOUR_API_KEY');// Holen Sie sich eine Instanz von GenAI APIconst genaiApi = PicsartEnterprise.createGenAIApi('YOUR_API_KEY ');

Erstellen Sie eine Image-Instanz

 // Von der öffentlichen Bild-URLconst imageSource = ImageApi.fromUrl('https://....');// Von der Picsart-Bild-IDconst imageSource = ImageApi.fromImageId('your-image-id-here');// Von binärconst fileContent = fs.readFileSync("examples/image.png");const imageSource = ImageApi.fromFile(fileContent);// From streamconst readStream = fs.createReadStream("examples/image.png");const imageSource = ImageApi.fromStream(readStream);

Hintergrund entfernen

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

  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);

Bild anpassen

  const result = waiting imageApi.adjust( new AdjustRequest().setImage(imageSource).setBrightness(90).setSharpen(40));
  console.log(result.image.url);

Effekte anwenden

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

  console.log(result.image.url);

Erzeugen Sie Hintergrundtexturen

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

  console.log(result.image.url);

Vorschau ausgewählter Effekte auf einem Bild

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

  console.log(result.thumbnails);

Gesicht verbessern

  const result = Warten auf imageApi
  .enhanceFace(new EnhanceFaceRequest() .setImage(imageSource),
  );

  console.log(result.image.url);

Schaffen Sie Balance

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

Liste der Effekte abrufen

  const result = wait imageApi.getEffects();
  console.log(result.effects)

Oberflächenkarte

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

  console.log(result.image.url);

Text zu Bild

  const result = waiting genaiApi.text2Image( new Text2ImageRequest().setCount(10).setPrompt("ständig codieren").setNegativePrompt("entspannen und ausruhen"));
  console.log(result.images);

Bild hochladen

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

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

  console.log(result.image.url);

Gehoben

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

  console.log(result.image.url);

Ultra-Enhance

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

  console.log(result.image.url);

Ultra-gehoben

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

  console.log(result.image.url);

Bauen

Um ein Paket zu erstellen, verwenden Sie den folgenden Befehl:

 npm run build

Es wird das Verzeichnis /lib im Stammverzeichnis des Projekts erstellt, das das zur Veröffentlichung bereite npm-Paket enthält.

Standardlizenzhinweis hinzugefügt

Führen Sie den folgenden Befehl aus, um den Boilerplate-Lizenzhinweis in allen *.ts-Dateien hinzuzufügen:

 npm-Lauflizenz

Dieser Befehl fügt nicht nur den Header zu allen neuen Dateien hinzu, sondern korrigiert bei Bedarf auch vorhandene Dateien.

Um dies unter macOS ausführen zu können, müssen Sie GNU sed installieren. Wenn Sie es noch nicht installiert haben, gehen Sie folgendermaßen vor:

1. Homebrew installieren : Wenn Sie Homebrew nicht installiert haben, öffnen Sie Terminal und führen Sie Folgendes aus:

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

2. GNU sed installieren : Sobald Homebrew installiert ist, führen Sie den folgenden Befehl aus, um GNU sed zu installieren:

 brew install gnu-sed

Generieren von API-Referenzen

API-Referenzen werden mithilfe von TypeDoc basierend auf TSDoc-Kommentaren im Code generiert. Führen Sie den folgenden Befehl aus, um es zu generieren:

 npm führen Sie „generate-docs“ aus

Dieser Befehl generiert eine API-Dokumentation im HTML-Format im Verzeichnis /docs .

Tests

Um Tests auszuführen, verwenden Sie den folgenden Befehl:

 NPM-Test

Lizenz

Das Picsart Creative APIs SDK wird unter der MIT-Lizenz bereitgestellt, die in der LICENSE-Datei zu finden ist. Durch die Nutzung, Verbreitung oder Mitwirkung an diesem Projekt stimmen Sie den Bedingungen dieser Lizenz zu.

Dieses Projekt weist einige Abhängigkeiten von Drittanbietern auf, die jeweils über eine unabhängige Lizenzierung verfügen können:

• axios:^1.7.2, (MIT): Wird als http-Client verwendet

• axios-retry:^4.3.0, (Apache-Lizenz V2.0): Wird als Erweiterung für Axios zur Handhabung von Wiederholungsversuchen verwendet

• form-data:^4.0.0, (MIT): Wird zum Erstellen mehrteiliger/Formulardaten-Nutzlasten verwendet

• yup:^1.4.0, (MIT): Wird für clientseitige Anforderungsvalidierungen verwendet

Wie kann ich einen Beitrag leisten?

Wenn Ihnen das Picsart Creative APIs SDK gefällt und Sie zu diesem Open-Source-Projekt beitragen möchten, lesen Sie bitte den Beitragsleitfaden.