picsart creative apis java sdk Télécharger - picsart creative apis java sdk Téléchargement du code source

API CRÉATIVES PICSART

Description

Il s'agit d'un SDK Java 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 Java ou Kotlin.

Installation

Pour utiliser le SDK, ajoutez la dépendance suivante à votre fichier Maven pom.xml :

< dependency >
    < groupId >com.picsart</ groupId >
    < artifactId >picsart-creative-apis-java-sdk</ artifactId >
    < version >1.0.0</ version >
</ dependency >

Si vous utilisez Gradle, ajoutez ce qui suit à votre fichier build.gradle :

implementation ' com.picsart:picsart-creative-apis-java-sdk:1.0.0 '

Attention : Le SDK utilise Reactor Java et a une dépendance transitive sur io.projectreactor:reactor-core . Si vous utilisez une version différente de Reactor, vous risquez de rencontrer des problèmes de compatibilité. Dans ce cas, vous pouvez exclure la dépendance transitive et ajouter votre propre version de Reactor à votre projet.

Usage

Obtenir une instance d'API

 import com . picsart . creativeapis . PicsartEnterprise ;
import com . picsart . creativeapis . image . ImageApi ;
import com . picsart . creativeapis . genai . GenAIApi ;

// Get an instance of Image API with default baseUrl and timeout
ImageApi imageApi = PicsartEnterprise . createImageApi ( "YOUR_API_KEY" );

// Get an instance of Image API with custom baseUrl and timeout
ImageApi customBaseUrlImageApi = PicsartEnterprise . createImageApi ( "YOUR_API_KEY" )
                        . withBaseUrl ( "https://custom-base-url.com" )
                        . withTimeout ( Duration . ofSeconds ( 10 ));

// Get an instance of GenAI API
GenAIApi genaiApi = PicsartEnterprise . createGenAIApi ( "YOUR_API_KEY" );

// Get an instance of GenAI API with custom baseUrl and timeout
GenAIApi customBaseUrlGenaiApi = PicsartEnterprise . createGenAIApi ( "YOUR_API_KEY" )
                        . withBaseUrl ( "https://custom-base-url.com" )
                        . withTimeout ( Duration . ofSeconds ( 10 ));

Créer une instance ImageSource

 import com . picsart . busobj . image . ImageSource ;
import com . picsart . creativeapis . image . ImageApi ;
import com . picsart . creativeapis . image . models . ImageSource ;

import java . io . File ;

var imageUrl = ImageSource . fromUrl ( "https://url-to-your-image.jpg" );
// or
var imageFile = ImageSource . fromFile ( new File ( "path/to/your-image.jpg" ));
// or
var imageId = ImageSource . fromImageId ( "your-image-id" );

Supprimer l'arrière-plan

 RemoveBackgroundParameters parameters = RemoveBackgroundParameters . builder ( mainImageSource )
        . bgImage ( backgroundImageSource )
        . build ();
Mono < RemoveBackgroundResult > removeBackgroundResultMono = imageApi . removeBackground ( parameters );
removeBackgroundResultMono
        . subscribe ( result -> { // non-blocking subscribe
            System . out . println ( "Result Image: " + result . image ());
            System . out . println ( "Result metadata: " + result . metadata ());
        });

Pour plus de détails, veuillez consulter RemoveBackgroundExample.java.

Ajuster l'image

 AdjustParameters parameters = AdjustParameters . builder ( imageSource )
                . brightness ( 20 )
                . contrast ( 30 )
                . saturation ( 40 )
                . build ();
Mono < AdjustResult > adjustResultMono = imageApi . adjust ( parameters );
adjustResultMono
        . subscribe ( result -> { // non-blocking subscribe
            System . out . println ( "Result Image: " + result . image ());
            System . out . println ( "Result metadata: " + result . metadata ());
        });

Pour plus de détails, veuillez consulter AdjustExample.java.

Appliquer l'effet

 EffectParameters parameters = EffectParameters . builder ( imageSource , effectName )
        . build ();
Mono < EffectResult > resultMono = imageApi . effect ( parameters );
resultMono
        . subscribe ( result -> { // non-blocking subscribe
            System . out . println ( "Result Image: " + result . image ());
            System . out . println ( "Result metadata: " + result . metadata ());
        });

Pour plus de détails, veuillez consulter EffectExample.java.

Obtenir la liste des effets

 Mono < ListEffectsResult > resultMono = imageApi . listEffects ();
resultMono
        . subscribe ( result -> { // non-blocking subscribe
            System . out . println ( "Effects: " + result . effects ());
            System . out . println ( "Result metadata: " + result . metadata ());
        });

Pour plus de détails, veuillez consulter ListEffectsExample.java.

//Aperçus des effets

Aperçu des effets sélectionnés sur une image

 EffectsPreviewsParameters parameters = EffectsPreviewsParameters . builder ( imageSource )
                . addEffectName ( effectName1 )
                . addEffectName ( effectName2 )
                . addEffectName ( effectName3 )
                . format ( ImageFormat . PNG )
                . build ();
Mono < EffectsPreviewsResult > resultMono = imageApi . effectsPreviews ( parameters );
resultMono
        . subscribe ( result -> { // non-blocking subscribe
            System . out . println ( "Result images with effects" + result . effectsPreviews ());
            System . out . println ( "Result metadata: " + result . metadata ());
        });

Pour plus de détails, veuillez consulter EffectsPreviewsExample.java.

Télécharger une image

 Mono < UploadResult > resultMono = imageApi . upload ( imageFile ); // either imageFile or imageUrl
resultMono
        . subscribe ( result -> { // non-blocking subscribe
            System . out . println ( "Result Image: " + result . image ());
            System . out . println ( "Result metadata: " + result . metadata ());
        });

Pour plus de détails, veuillez consulter UploadExample.java.

Haut de gamme

 UpscaleParameters parameters = UpscaleParameters . builder ( imageSource )
        . upscaleFactor ( 4 )
        . format ( ImageFormat . PNG )
        . build ();
Mono < UpscaleResult > resultMono = imageApi . upscale ( parameters );
resultMono
        . subscribe ( result -> { // non-blocking subscribe
            System . out . println ( "Result Image: " + result . image ());
            System . out . println ( "Result metadata: " + result . metadata ());
        });

Pour plus de détails, veuillez consulter UpscaleExample.java.

Ultra haut de gamme

 UltraUpscaleParameters parameters = UltraUpscaleParameters . builder ( imageSource )
        . mode ( UpscaleMode . ASYNC )
        . upscaleFactor ( 4 )
        . format ( ImageFormat . PNG )
        . build ();
Mono < UltraUpscaleResult > resultMono = imageApi . ultraUpscale ( parameters );
resultMono
        . subscribe ( result -> { // non-blocking subscribe
            System . out . println ( "Result Image: " + result . image ());
            System . out . println ( "Result metadata: " + result . metadata ());
        });

Pour plus de détails, veuillez consulter UltraUpscaleExample.java.

Ultra-amélioration

 UltraEnhanceParameters parameters = UltraEnhanceParameters . builder ( imageSource )
        . upscaleFactor ( 4 )
        . format ( ImageFormat . PNG )
        . build ();
Mono < UltraEnhanceResult > resultMono = imageApi . ultraEnhance ( parameters );
resultMono
        . subscribe ( result -> { // non-blocking subscribe
            System . out . println ( "Result Image: " + result . image ());
            System . out . println ( "Result metadata: " + result . metadata ());
        });

Pour plus de détails, veuillez consulter UltraEnhanceExample.java.

Améliorer le visage

 EnhanceFaceParameters parameters = EnhanceFaceParameters . builder ( imageSource )
                . format ( ImageFormat . PNG )
                . build ();
Mono < EnhanceFaceResult > resultMono = imageApi . enhanceFace ( parameters );
resultMono
        . subscribe ( result -> { // non-blocking subscribe
            System . out . println ( "Result Image: " + result . image ());
            System . out . println ( "Result metadata: " + result . metadata ());
        });

Pour plus de détails, veuillez consulter EnhanceFaceExample.java.

Carte des surfaces

 SurfaceMapParameters parameters = SurfaceMapParameters . builder ( mainImageSource , maskSource , stickerSource )
                . format ( ImageFormat . PNG )
                . build ();
Mono < SurfaceMapResult > resultMono = imageApi . surfaceMap ( parameters );
resultMono
        . subscribe ( result -> { // non-blocking subscribe
            System . out . println ( "Result Image: " + result . image ());
            System . out . println ( "Result metadata: " + result . metadata ());
        });

Pour plus de détails, veuillez consulter SurfaceMapExample.java.

Générer des textures d'arrière-plan

 BackgroundTextureParameters parameters = BackgroundTextureParameters . builder ( imageSource )
                . format ( ImageFormat . PNG )
                . width ( 800 )
                . height ( 800 )
                . pattern ( BackgroundTexturePattern . DIAMOND )
                . build ();
        Mono < BackgroundTextureResult > resultMono = imageApi . backgroundTexture ( parameters );
        resultMono
                . subscribe ( result -> { // non-blocking subscribe
                    System . out . println ( "Result Image: " + result . image ());
                    System . out . println ( "Result metadata: " + result . metadata ());
                });

Pour plus de détails, veuillez consulter BackgroundTextureExample.java.

Obtenez l'équilibre

 Mono < BalanceResult > resultMono = imageApi . balance ();
resultMono
        . subscribe ( result -> { // non-blocking subscribe
            System . out . println ( "Result credits: " + result . credits ());
        });

Pour plus de détails, veuillez consulter BalanceExample.java.

Générez des images à partir de texte avec GenAI

 Text2ImageParameters parameters = Text2ImageParameters . builder ( "your-prompt" , "your-negative-prompt" )
        . count ( 1 )
        . width ( 512 )
        . height ( 512 )
        . build ();
Mono < Text2ImageResult > resultMono = genAIApi . text2Image ( parameters );
resultMono
        . subscribe ( result -> { // non-blocking subscribe
            System . out . println ( "Result Images: " + result . images ());
            System . out . println ( "Result metadata: " + result . metadata ());
        });

Pour plus de détails, veuillez consulter Text2ImageExample.java.

Appliquer plusieurs modifications

Dans l'exemple ci-dessous, nous générons une image à partir de texte, puis supprimons l'arrière-plan de l'image générée et enfin mettons à l'échelle le résultat.

 Text2ImageParameters parameters = Text2ImageParameters . builder ( "your-prompt" , "your-negative-prompt" )
        . count ( 10 )
        . width ( 512 )
        . height ( 512 )
        . build ();
Mono < Text2ImageResult > resultMono = genAIApi . text2Image ( parameters );
resultMono
        . flatMapIterable ( Text2ImageResult :: images ) // flatMapIterable is used to iterate over the result images and process each of them individually
        . flatMap ( image -> { // this will be called for each image in the result (10 times in this case)
            RemoveBackgroundParameters removeBackgroundParameters = RemoveBackgroundParameters
                    . builder ( image . toImageSource ())
                    . build ();
            return imageApi . removeBackground ( removeBackgroundParameters ); // remove background from each image
        })
        . flatMap ( removeBackgroundResult -> { // this will be called for each image in the result (10 times in this case)
            var imageSource = removeBackgroundResult . image (). toImageSource ();
            UpscaleParameters upscaleParameters = UpscaleParameters . builder ( imageSource )
                     . upscaleFactor ( 2 )
                     . build ();
            return imageApi . upscale ( upscaleParameters ); // upscale each image
        })
        . subscribe ( result -> { // non-blocking subscribe
            // each image will be printed separately
            System . out . println ( "Result Image: " + result . image ());
            System . out . println ( "Result metadata: " + result . metadata ());
        });

Pour plus de détails, veuillez consulter Text2ImageRemoveBackgroundUpscaleExample.java.

Gestion des erreurs et tentatives

Les exceptions API sont gérées par le SDK et sont générées en tant qu'ApiException ou enfant de celui-ci. Si l’état de la réponse est autre que 2xx, FailureResponseException ou son enfant est émis en fonction du code d’état de la réponse. Les exceptions qui peuvent potentiellement être résolues en réessayant la demande comme ServiceUnavailableException sont marquées avec une interface récupérable. Vous pouvez intercepter ces exceptions et réessayer la demande si nécessaire.

Exemple de nouvelle tentative de requête en cas d'exception récupérable :

 Mono < BalanceResult > resultMono = imageApi . balance ();
resultMono
        // can be used to perform a side-effect in case of an error
        . doOnError ( throwable -> {
            System . out . println ( "exception: " + throwable . getMessage ());
        })
        // Retry 3 times with an initial backoff of 2 seconds. 
        // The delay between retries will increase exponentially up to max delay of 5 seconds.
        . retryWhen ( Retry . backoff ( 3 , Duration . ofSeconds ( 2 ))
                . maxBackoff ( Duration . ofSeconds ( 5 ))
                 . filter ( throwable -> throwable instanceof Recoverable )
                . onRetryExhaustedThrow (( retryBackoffSpec , retrySignal ) -> new RuntimeException ( "Retry exhausted" , retrySignal . failure ()))
        )
        . subscribe ( result -> { // non-blocking subscribe
            System . out . println ( "Result credits: " + result . credits ());
        });

Licence

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 :