Skip to main content

Référence de l'API de complétion par effacement d'image

Ce document détaille les paramètres du modèle de complétion par effacement d'image. Ce modèle supprime un ou plusieurs éléments d'une image (personnes, animaux, objets, texte ou filigranes) tout en préservant l'arrière-plan. Spécifiez les zones à supprimer à l'aide d'une image masque.

Guide associé : Complétion par effacement d'image
  • Ce document s'applique uniquement à la région China (Beijing). Pour utiliser le modèle, procurez-vous une clé API dans la région China (Beijing).
  • Le modèle image-erase-completion est actuellement disponible uniquement en version d'essai gratuite. Une fois le quota gratuit épuisé, l'appel du modèle n'est plus possible, car aucune option payante n'est prise en charge. Nous vous recommandons d'utiliser plutôt Édition d'image - Qwen ou Édition d'image - Wan2.1.

Prérequis

Obtenir une clé API et exporter la clé API en tant que variable d'environnement.

Appel HTTP

Pour réduire les temps d'attente et éviter les délais d'expiration des requêtes, le service traite les demandes de manière asynchrone. Effectuez deux requêtes :
  • Créer une tâche : envoyez une requête pour créer une tâche de génération d'image. Cette requête retourne un ID de tâche.
  • Interroger le résultat par ID de tâche : utilisez l'ID de tâche retourné pour interroger le résultat.

Étape 1 : Créer une tâche

POST https://dashscope.aliyuncs.com/api/v1/services/aigc/image2image/image-synthesis

En-têtes de requête

  • Complétion par effacement d'image
curl --location --request POST 'https://dashscope.aliyuncs.com/api/v1/services/aigc/image2image/image-synthesis' \
--header 'X-DashScope-Async: enable' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "image-erase-completion",
    "input": {
            "image_url": "http://xxx/input.png",
            "mask_url": "http://xxx/mask.png",
            "foreground_url": "http://xxx/foreground.png"
        },
    "parameters":{
        "dilate_flag":true
    }
}'
Content-TypestringObligatoireType de contenu de la requête. La valeur doit être application/json.
AuthorizationstringObligatoireNous vous recommandons d'utiliser votre clé API Model Studio. Vous pouvez également utiliser votre clé API DashScope. Exemple : Bearer d1xxx2a.
X-DashScope-AsyncstringObligatoireActive ou désactive le traitement asynchrone. Définissez ce paramètre sur enable.

Corps de la requête

modelstringObligatoireModèle à appeler.
inputobjectObligatoireDétails de l'image d'entrée, tels que l'URL de l'image.

Propriétés

image_urlstringObligatoireURL ou données encodées en Base64 de l'image d'entrée.L'URL doit être accessible publiquement et utiliser HTTP ou HTTPS.Exigences relatives à l'image :
  • Formats : JPEG, PNG, JPG, BMP, WEBP.
  • Résolution : comprise entre 512×512 et 4096×4096 pixels.
  • Longueur des côtés : [512, 4096] pixels.
  • Taille du fichier : 10 Mo maximum.
  • L'URL ne doit pas contenir de caractères chinois.
mask_urlstringObligatoireURL ou données encodées en Base64 de l'image masque définissant la zone à effacer.L'URL doit être accessible publiquement et utiliser HTTP ou HTTPS.Exigences relatives à l'image :
  • Formats : JPG, JPEG, PNG, HEIF, WEBP.
  • Résolution : comprise entre 512×512 et 4096×4096 pixels.
  • Longueur des côtés : [512, 4096] pixels.
  • Taille du fichier : 10 Mo maximum.
Pour créer un masque, peignez sur un canevas vierge aux mêmes dimensions que l'image d'entrée. Les zones avec des valeurs de pixels non nulles servent de masque d'effacement. Vous pouvez aussi utiliser la segmentation d'instance humaine pour générer directement un résultat de segmentation comme masque d'effacement.foreground_urlstring FacultatifURL ou données encodées en Base64 de l'image masque définissant la zone à préserver.L'URL doit être accessible publiquement et utiliser HTTP ou HTTPS.Exigences relatives à l'image :
  • Formats : JPG, JPEG, PNG, HEIF, WEBP.
  • Résolution : comprise entre 512×512 et 4096×4096 pixels.
  • Longueur des côtés : [512, 4096] pixels.
  • Taille du fichier : 10 Mo maximum.
Pour créer un masque de préservation, peignez sur un canevas vierge aux mêmes dimensions que l'image d'entrée. Les zones avec des valeurs de pixels non nulles servent de masque de préservation. Vous pouvez aussi utiliser la segmentation d'instance humaine pour spécifier un ID de personne, ce qui isole la zone de masque correspondante et empêche son effacement.
parametersobject FacultatifParamètres de traitement d'image.

Propriétés

fast_modeboolFacultatifActive ou désactive le mode rapide. La valeur par défaut est false. En mode rapide, l'inférence prend environ un quart du temps nécessaire en mode standard. Ce mode convient aux scénarios ne nécessitant pas un niveau de détail élevé.dilate_flagboolFacultatifLa valeur par défaut est true. Nous vous recommandons de définir cette valeur sur true si un algorithme génère le masque d'effacement, et sur false si vous peignez manuellement le masque d'effacement.add_watermark booleanFacultatifAjoute un filigrane Generated by AI. La valeur par défaut est true, ce qui ajoute le filigrane dans le coin inférieur gauche de l'image de sortie.

Réponse

{
    "output": {
        "task_status": "PENDING",
        "task_id": "53950fb7-281a-4e60-b543-xxxxxxxxxxxx"
    },
    "request_id": "1027557e-8c3f-9db5-8cd2-xxxxxxxxxxxx"
}
outputobjectDétails de la sortie de la tâche.

Propriétés

task_idstringIdentifiant unique de la tâche.task_statusstringÉtat de la tâche.
  • PENDING : la tâche est en file d'attente.
  • RUNNING : la tâche est en cours d'exécution.
  • SUSPENDED : la tâche est suspendue.
  • SUCCEEDED : la tâche s'est terminée avec succès.
  • FAILED : la tâche a échoué.
codestringCode d'erreur. Ce paramètre n'est pas retourné si la requête aboutit.
messagestringMessage d'erreur. Ce paramètre n'est pas retourné si la requête aboutit.
request_idstringID unique de la requête. Utilisez cet ID pour tracer et résoudre les problèmes.

Étape 2 : Interroger le résultat

GET https://dashscope.aliyuncs.com/api/v1/tasks/{task_id}

En-têtes de requête

  • Résultat de la tâche
curl -X GET \
--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
https://dashscope.aliyuncs.com/api/v1/tasks/53950fb7-281a-4e60-b543-xxxxxxxxxxxx
AuthorizationstringObligatoireVotre clé API. Exemple : Bearer d1**2a.

Paramètres de chemin

task_idstringObligatoireID de la tâche.

Réponse

  • Tâche terminée
  • Tâche en cours
  • Tâche échouée
Les résultats des tâches terminées restent disponibles pendant 24 heures. Passé ce délai, le système supprime la tâche et ses résultats. L'URL de l'image générée expire également après 24 heures ; enregistrez l'image dès la récupération du résultat de la tâche.
{
    "request_id": "b67df059-ca6a-9d51-afcd-9b3c4456b1e2",
    "output": {
        "task_id": "53950fb7-281a-4e60-b543-xxxxxxxxxxxx",
        "task_status": "SUCCEEDED",
        "submit_time": "2024-05-16 13:50:01.247",
        "scheduled_time": "2024-05-16 13:50:01.354",
        "end_time": "2024-05-16 13:50:27.795",
        "output_image_url": "http://xxx/result.png"
    },
    "usage": {
        "image_count": 1
    }
}
outputobjectDétails de la sortie de la tâche.

Propriétés

task_id stringID de la tâche.task_status stringÉtat de la tâche.
  • PENDING : la tâche est en file d'attente.
  • RUNNING : la tâche est en cours d'exécution.
  • SUSPENDED : la tâche est suspendue.
  • SUCCEEDED : la tâche s'est terminée avec succès.
  • FAILED : la tâche a échoué.
task_metrics objectStatistiques de la tâche.

Propriétés

TOTAL integerNombre total de tâches.SUCCEEDED integerNombre de tâches réussies.FAILED integerNombre de tâches ayant échoué.
submit_time stringHeure de soumission de la tâche.scheduled_time stringHeure de début d'exécution de la tâche.end_time stringHeure de fin de la tâche.output_image_url stringURL de l'image de sortie.codestringCode d'erreur. Ce paramètre n'est pas retourné si la requête aboutit.messagestringMessage d'erreur. Ce paramètre n'est pas retourné si la requête aboutit.
usageobjectStatistiques d'utilisation.

Propriétés

image_countintegerNombre d'images générées.
request_idstringID unique de la requête. Utilisez cet ID pour tracer et résoudre les problèmes.

Codes d'état

Pour les codes d'état courants des services Model Studio, consultez Messages d'erreur. Cette API retourne également les codes d'état spécifiques suivants :

Code d'état HTTP

Code d'erreur

Message d'erreur

Description

400

InvalidParameter.JsonPhrase

input json error

JSON invalide dans la requête.

400

InvalidParameter.FileDownload

oss download error

Échec du téléchargement de l'image d'entrée.

400

InvalidParameter.ImageFormat

read image error

Échec de la lecture de l'image.

400

InvalidParameter.ImageContent

The image content is not compliant.

Le contenu de l'image n'est pas conforme.

400

InvalidParameter

An input parameter value is out of range: xxx

Une valeur de paramètre d'entrée est hors limites.

400

InvalidParameter.ImageResolution

The input image size is too small or too large.

La taille de l'image d'entrée est trop petite ou trop grande.

500

InternalError.Algo

algorithm process error

Erreur d'algorithme.

500

InternalError.FileUpload

oss upload error

Échec du téléchargement du fichier.