picsart creative apis ts sdk
0.0.2
Il s'agit d'un SDK TypeScript d'API d'images programmables Picsart et d'API Picsart GenAI. Vous pouvez facilement effectuer de nombreuses actions avec vos images en ajoutant simplement quelques lignes de code à vos projets JavaScript ou Typescript.
Pour installer le package, exécutez la commande suivante :
npm install --save picsart-creative-apis-ts-sdk
importer PicsartEnterprise depuis "picsart-creative-apis-ts-sdk" ;// Obtenir une instance de l'API d'imageconst imageApi = PicsartEnterprise.createImageApi('YOUR_API_KEY');// Obtenir une instance de GenAI APIconst genaiApi = PicsartEnterprise.createGenAIApi('YOUR_API_KEY '); // Depuis l'urlconst de l'image publique imageSource = ImageApi.fromUrl('https://....');// Depuis l'idconst de l'image Picsart imageSource = ImageApi.fromImageId('your-image-id-here');// Depuis binaireconst fileContent = fs.readFileSync("examples/image.png");const imageSource = ImageApi.fromFile(fileContent);// Depuis streamconst readStream = fs.createReadStream("examples/image.png");const imageSource = ImageApi.fromStream(readStream); const result = wait 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);const result = wait imageApi.adjust( new AdjustRequest().setImage(imageSource).setBrightness(90).setSharpen(40)); console.log(result.image.url);
const result = wait imageApi.effect( new EffectRequest().setImage(imageSource).setEffectName(EffectName.a1972)); console.log(result.image.url);
const result = wait imageApi.backgroundTexture( new BackgroundTextureRequest().setImage(imageSource).setPattern(TexturePattern.diamond).setHeight(800)); console.log(result.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(result.thumbnails);
résultat const = attendre imageApi .enhanceFace(nouveau EnhanceFaceRequest() .setImage(imageSource), ); console.log(result.image.url);
résultat const = attendre imageApi.getBalance(); console.log(result.crédits);
résultat const = attendre imageApi.getEffects(); console.log(result.effects)
const result = wait imageApi.surfacemap( new SurfacemapRequest().setImage(imageSource1).setMask(imageSource2).setSticker(imageSource3)); console.log(result.image.url);
const result = wait genaiApi.text2Image( new Text2ImageRequest().setCount(10).setPrompt("coder tout le temps").setNegativePrompt("détendez-vous et reposez-vous"));
console.log(result.images); const fileContent = readFileSync("exemples/image.png");
const blob = nouveau Blob([fileContent]);
const imageSource = ImageApi.fromFile(blob);
résultat const = attendre imageApi.upload(new UploadRequest() .setImage(imageSource)
);
console.log(result.image.url);résultat const = attendre imageApi.upscale(new UpscaleRequest() .setImage(imageSource) .setUpscaleFactor(UpscaleFactor.R2000x2000) ); console.log(result.image.url);
const result = wait imageApi.ultraEnhance( new UltraEnhanceRequest().setImage(imageSource).setUpscaleFactor(6),); console.log(result.image.url);
const result = wait imageApi.ultraUpscale( new UltraUpscaleRequest().setImage(imageSource).setUpscaleFactor(4).setMode(ProcessingMode.async),); console.log(result.image.url);
Pour créer un package, utilisez la commande suivante :
npm exécuter la construction
Il créera le répertoire /lib dans le répertoire racine du projet qui contiendra le package npm prêt à publier.
Exécutez la commande suivante pour ajouter l'avis de licence passe-partout dans tous les fichiers *.ts :
licence d'exécution npm
Cette commande ajoutera non seulement l'en-tête à tous les nouveaux fichiers, mais corrigera également les fichiers existants si nécessaire.
Pour pouvoir l'exécuter sur macOS, vous devez installer GNU sed. Si vous ne l'avez pas encore installé, procédez comme suit :
Installer Homebrew : Si Homebrew n'est pas installé, ouvrez Terminal et exécutez :
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
Installer GNU sed : Une fois Homebrew installé, exécutez la commande suivante pour installer GNU sed :
Brew installer Gnu-sed
Les références API sont générées à l'aide de TypeDoc sur la base des commentaires TSDoc dans le code. Exécutez la commande suivante pour le générer :
npm exécuter générer-docs
Cette commande générera la documentation de l'API au format HTML dans le répertoire /docs .
Pour exécuter des tests, utilisez la commande suivante :
test npm
Le SDK Picsart Creative APIs est fourni sous la licence MIT qui se trouve dans le fichier LICENSE. En utilisant, distribuant ou contribuant à ce projet, vous acceptez les termes et conditions de cette licence.
Ce projet comporte des dépendances tierces, chacune pouvant avoir une licence indépendante :
axios : ^ 1.7.2, (MIT) : utilisé comme client http
axios-retry : ^ 4.3.0, (Licence Apache V2.0) : utilisé comme extension pour axios pour gérer les nouvelles tentatives
form-data:^4.0.0, (MIT) : utilisé pour créer des charges utiles multipart/form-data
ouais : ^ 1.4.0, (MIT) : utilisé pour les validations de requêtes côté client
Si vous aimez le SDK Picsart Creative APIs et souhaitez contribuer à ce projet open source, veuillez consulter le guide de contribution.
