Retour à l'accueil

Documentation de l'API Image Describer - Génération de Descriptions d'Images par IA

Aperçu

L'API Image Describer est un outil puissant de génération de descriptions d'images qui produit de manière intelligente des descriptions précises, détaillées et pertinentes d'images en fonction de l'image fournie et de l'invite (prompt). Cette API de reconnaissance d'images basée sur l'IA comprend et analyse le contenu des images, générant des descriptions textuelles correspondantes selon vos invites. Elle est largement applicable à divers scénarios impliquant la compréhension d'images, l'analyse d'images et la génération de contenu d'images, vous permettant de mettre en œuvre facilement la réponse aux questions sur les images et la conversion image-texte.

Scénarios d'Application

L'API Image Describer peut vous aider à réaliser efficacement la compréhension d'images et la génération de contenu dans les domaines suivants :

Clés API

Pour accéder à l'API Image Describer, vous devez d'abord obtenir une clé API valide. Cette clé est utilisée pour authentifier vos requêtes et garantir un accès sécurisé à l'API.

Obtention d'une Clé API

  1. Accéder à la Page de Gestion des Clés API : Connectez-vous au système, puis cliquez sur votre avatar d'utilisateur dans le coin supérieur droit. Dans le menu déroulant, cliquez sur "Apply for API" (Demander une API) pour ouvrir la page de gestion des clés API.

  2. Créer une Nouvelle Clé : Cliquez sur "Create New Key" (Créer une Nouvelle Clé), saisissez un nom pour votre clé dans la boîte de dialogue contextuelle, puis cliquez sur "Create" (Créer).

  3. Copier et Stocker Votre Clé : Notez que la clé ne sera affichée intégralement qu'une seule fois. Cliquez sur l'icône de copie pour copier la clé dans votre presse-papiers, puis cliquez sur "Confirm" (Confirmer) pour fermer la boîte de dialogue.

Important : Ne la partagez pas avec d'autres et ne l'exposez pas dans le navigateur, le code côté client ou tout autre emplacement non sécurisé. Conservez votre clé en lieu sûr pour éviter tout accès non autorisé.

Point de Terminaison de l'API

POST https://api.imagedescriber.app/api/v1/generate_content

Paramètres de la Requête

En-têtes de la Requête

En-têteTypeObligatoireDescription
content-typestringOui`application/json`
authorizationstringOui`Bearer ${api_key}`, où `${api_key}` est votre clé API.

Corps de la Requête

{
  "image": "data:image/jpeg;base64,{données_base64_de_l_image}",
  "prompt": "Quel est cet objet ? Décrivez ses utilisations possibles.",
  "lang": "fr"
}
ParamètreTypeObligatoireDescription
imagestringOui

L’URL ou les données de l’image encodées en Base64. Les formats d’image supportés sont listés dans Détails sur le Format d’Image.

promptstringNonLa question ou la demande de description pour l’image, par exemple, "Qu’est-ce que c’est ?" ou "Décrivez cette image."
langstringNonLe code de langue pour la description retournée. La valeur par défaut est `en` (Anglais). Les codes de langue supportés sont listés ci-dessous.

Langues Supportées

CodeLangue
enAnglais (Par défaut)
zhChinois
frFrançais
deAllemand
esEspagnol
jaJaponais
koCoréen

Exemple de Requête (cURL)

curl --location 'https://api.imagedescriber.app/api/v1/generate_content' \
--header 'content-type: application/json' \
--header 'authorization: Bearer votre_clé_api' \
--data '{
    "image":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQE...", 
    "prompt":"Quel est cet objet ? Décrivez ses utilisations possibles.",
    "lang":"fr"
}'

Exemple de Requête (Python)

import requests
import base64

def image_to_base64(image_path):
  """Convertir une image en encodage Base64"""
  with open(image_path, "rb") as image_file:
    encoded_string = base64.b64encode(image_file.read()).decode("utf-8")
  return encoded_string

def generate_image_description(api_key, image_path, prompt, lang="fr"):
  """Générer une description d'image en utilisant l'API Image Describer"""
  url = "https://api.imagedescriber.app/api/v1/generate_content"
  headers = {
      "content-type": "application/json",
      "authorization": f"Bearer {api_key}"
  }
  
  image_base64_data = image_to_base64(image_path)
  payload = {
      "image": f"data:image/jpeg;base64,{image_base64_data}",
      "prompt": prompt,
      "lang": lang
  }

  response = requests.post(url, headers=headers, json=payload)

  if response.status_code == 200:
      result = response.json()
      print(result["data"]["content"])
  else:
    print(f"Erreur : {response.status_code}")
    print(response.text)

# Exemple d'utilisation
api_key = "votre_clé_api"
image_path = "votre_image.jpg"
prompt = "Quel est cet objet ? Décrivez ses utilisations possibles."

generate_image_description(api_key, image_path, prompt, lang="fr")

Exemple de Requête (Next.js)

import fs from 'fs';

// Implémentation côté serveur
const buffer = await fs.readFileSync("/temp/test.jpg");
const base64Image = buffer.toString('base64');
const imageData = `data:image/jpeg;base64,${base64Image}`;

// Implémentation côté client
const file:File = /* fichier provenant d'un événement d'entrée ou de glisser-déposer */;
const arrayBuffer = await file.arrayBuffer();
const bytes = new Uint8Array(arrayBuffer);
const base64Image = btoa(String.fromCharCode.apply(null, bytes as any));
const imageData = `data:${file.type};base64,${base64Image}`;

const body = {
  "image": imageData,
  "prompt": "Décrivez l'image en détail",
  "lang": "fr"
};

const response = await fetch('https://api.imagedescriber.app/api/v1/generate_content', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {votre_clé_api}'
    },
    body: JSON.stringify(body),
});

const result = await response.json();
console.log(result);

Réponse

Corps de la Réponse (Réponse JSON)

L'API renvoie désormais la réponse complète dans un seul objet JSON. Le champ content au sein de l'objet data contient la description d'image générée au format Markdown.

{
  "code": 0,
  "message": "success",
  "request_id": "identifiant_de_requête_unique",
  "data": {
    "content": "Contenu généré au format Markdown" 
  }
}
ChampTypeDescription
codenumberCode de statut, `0` indique le succès, une valeur différente de `0` indique une erreur.
messagestringMessage de statut, décrit l’état de la requête.
request_idstringIdentifiant de requête unique, utilisé pour le suivi et le dépannage.
datastringContient le contenu généré. Format Markdown.
contentstringLe texte de la **description d’image** généré. Le format est **Markdown**.

Limites de Requête

Pour assurer la stabilité et l'équité du service, chaque clé API est limitée à 5 requêtes par minute (300 requêtes par heure). Les requêtes dépassant cette limite seront rejetées avec le code d'erreur 1004.

Système de Crédits

Comment Obtenir Plus de Crédits ?

Vous pouvez visiter la Page de Recharge de Crédits pour acheter des packs de crédits afin de prendre en charge davantage d'appels API. Nous proposons différents packs pour répondre aux besoins des différents utilisateurs.

Gestion des Erreurs

Le tableau suivant répertorie les codes d'erreur courants, leur signification et leurs solutions :

Code d’erreurDescriptionSolution
1002Non autoriséVeuillez vérifier que votre en-tête `authorization` est correctement configuré.
1003Clé API invalideVeuillez vérifier que votre clé API est correcte ou en obtenir une nouvelle.
1004Trop de requêtesVeuillez réduire la fréquence de vos requêtes, maximum 5 requêtes par minute.
1005Paramètres invalidesVeuillez vérifier que les paramètres de votre requête sont conformes aux spécifications.
2002Crédits insuffisants
2003Contenu bloqué par le filtreVeuillez modifier votre image ou votre invite pour vous assurer que le contenu est conforme à la réglementation.
2004Format d’image invalide

Veuillez utiliser un format d’image pris en charge, reportez-vous à la section Détails sur le Format d’Image.

2005Échec du téléchargement de l’imageVeuillez vérifier que l’URL de votre image est valide ou réessayer de la télécharger plus tard.
5050Erreur interne du serveurVeuillez contacter notre équipe de support technique et fournir l’identifiant de la requête (`request_id`).

Détails sur le Format d’Image

Les formats d'image actuellement pris en charge sont : JPG, JPEG, PNG, WebP. La taille maximale de l'image est de 4 Mo.

Nous Contacter

Si vous avez des questions ou des suggestions, n'hésitez pas à nous contacter par les moyens suivants :

Commencez à utiliser l'API Image Describer dès maintenant et débloquez les possibilités illimitées de la compréhension d'images !