picsart creative apis ts sdk
0.0.2
Este es un SDK de TypeScript de las API de imágenes programables de Picsart y las API de Picsart GenAI. Puede realizar fácilmente muchas acciones con sus imágenes simplemente agregando unas pocas líneas de código a sus proyectos de JavaScript o Typecript.
Para instalar el paquete, ejecute el siguiente comando:
instalación npm --save picsart-creative-apis-ts-sdk
import PicsartEnterprise from "picsart-creative-apis-ts-sdk";// Obtener una instancia de API de imagenconst imageApi = PicsartEnterprise.createImageApi('YOUR_API_KEY');// Obtener una instancia de API de GenAIconst genaiApi = PicsartEnterprise.createGenAIApi('YOUR_API_KEY '); // De imagen pública urlconst imageSource = ImageApi.fromImageId('https://....');// De imagen de Picsart idconst imageSource = ImageApi.fromImageId('your-image-id-here');// De binarioconst fileContent = fs.readFileSync("examples/image.png");const imageSource = ImageApi.fromFile(fileContent);// De streamconst readStream = fs.createReadStream("examples/image.png");const imageSource = ImageApi.fromStream(readStream); resultado constante = await imageApi.removeBackground( new RemoveBackgroundRequest().setImage(imageSource).setBgColor("green"));
console.log(resultado.imagen.url);
console.log(resultado.metadata.creditosDisponible);
console.log(result.metadata.rateLimitResetTime);
console.log(resultado.metadata.rateLimit);
console.log(resultado.metadata.rateLimitAvailable);
console.log(resultado.metadata.correlationId);resultado constante = esperar imageApi.adjust( new AjustaRequest().setImage(imageSource).setBrightness(90).setSharpen(40)); console.log(resultado.imagen.url);
resultado constante = esperar imageApi.effect( new EffectRequest().setImage(imageSource).setEffectName(EffectName.a1972)); console.log(resultado.imagen.url);
resultado constante = esperar imageApi.backgroundTexture( new BackgroundTextureRequest().setImage(imageSource).setPattern(TexturePattern.diamond).setHeight(800)); console.log(resultado.imagen.url);
resultado constante = await imageApi.effectPreviews( new EffectPreviewsRequest().setImage(imageSource).addEffect(EffectName.a1972).addEffect(EffectName.brnz2).addEffect(EffectName.icy3).addEffect(EffectName.apr3),); console.log(resultado.miniaturas);
resultado constante = esperar imageApi .enhanceFace(nueva EnhanceFaceRequest() .setImage(imageSource), ); console.log(resultado.imagen.url);
resultado constante = esperar imageApi.getBalance(); console.log(resultado.créditos);
resultado constante = esperar imageApi.getEffects(); console.log(resultado.efectos)
resultado constante = esperar imageApi.surfacemap( new SurfacemapRequest().setImage(imageSource1).setMask(imageSource2).setSticker(imageSource3)); console.log(resultado.imagen.url);
resultado const = await genaiApi.text2Image( new Text2ImageRequest().setCount(10).setPrompt("codificando todo el tiempo").setNegativePrompt("relajarse y descansar"));
console.log(resultado.imagenes); const fileContent = readFileSync("ejemplos/imagen.png");
const blob = nuevo Blob([archivoContenido]);
const imageSource = ImageApi.fromFile(blob);
resultado constante = esperar imageApi.upload(nueva UploadRequest() .setImage(imageSource)
);
console.log(resultado.imagen.url);resultado constante = esperar imageApi.upscale(new UpscaleRequest() .setImage(imageSource) .setUpscaleFactor(UpscaleFactor.R2000x2000) ); console.log(resultado.imagen.url);
resultado constante = esperar imageApi.ultraEnhance( new UltraEnhanceRequest().setImage(imageSource).setUpscaleFactor(6),); console.log(resultado.imagen.url);
resultado constante = esperar imageApi.ultraUpscale( new UltraUpscaleRequest().setImage(imageSource).setUpscaleFactor(4).setMode(ProcessingMode.async),); console.log(resultado.imagen.url);
Para construir un paquete use el siguiente comando:
compilación de ejecución npm
Creará el directorio /lib en el directorio raíz del proyecto que contendrá el paquete npm listo para publicar.
Ejecute el siguiente comando para agregar el aviso de licencia repetitivo en todos los archivos *.ts:
licencia de ejecución npm
Este comando no solo agregará el encabezado a todos los archivos nuevos, sino que también corregirá los archivos existentes si es necesario.
Para poder ejecutar esto en macOS, necesita instalar GNU sed. Si aún no lo has instalado, sigue estos pasos:
Instale Homebrew : si no tiene Homebrew instalado, abra Terminal y ejecute:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
Instale GNU sed : una vez instalado Homebrew, ejecute el siguiente comando para instalar GNU sed:
instalar cerveza gnu-sed
Las referencias de API se generan utilizando TypeDoc en función de los comentarios de TSDoc en el código. Ejecute el siguiente comando para generarlo:
npm ejecuta generar-docs
Este comando generará documentación API en formato HTML en el directorio /docs .
Para ejecutar pruebas, utilice el siguiente comando:
prueba de NPM
El SDK de Picsart Creative API se proporciona bajo la licencia MIT que se puede encontrar en el archivo LICENCIA. Al usar, distribuir o contribuir a este proyecto, acepta los términos y condiciones de esta licencia.
Este proyecto tiene algunas dependencias de terceros, cada una de las cuales puede tener licencias independientes:
axios:^1.7.2, (MIT): utilizado como cliente http
axios-retry:^4.3.0, (Licencia Apache V2.0): se utiliza como una extensión de axios para manejar los reintentos
form-data:^4.0.0, (MIT): se utiliza para crear cargas útiles de datos de formulario/multiparte
sí:^1.4.0, (MIT): se utiliza para validaciones de solicitudes del lado del cliente
Si te gusta el SDK de Picsart Creative API y te gustaría contribuir a este proyecto de código abierto, consulta la guía de contribución.
