Créer une API de Chat avec Reconnaissance d'Image (Streaming / Non-streaming)

Cette API prend en charge les entrées multimodales, permettant aux utilisateurs d'envoyer du texte ainsi que des URL d'images dans la conversation. Le modèle génère des réponses correspondantes basées sur le prompt (invite) et le contenu de l'image fournis. La sortie en continu (Streaming) est prise en charge pour offrir une expérience d'interaction plus fluide.

• URL de l'API : https://api.codingplanx.ai/v1/chat/completions
• Méthode de requête : POST
• Référence officielle : OpenAI Chat Completion API

---

Paramètres de la requête

Paramètres d'en-tête (Header)

Paramètres du corps (Body)

Structure de l'objet messages

Chaque élément de la liste des messages contient les champs suivants :

• role: (string) Rôle, options disponibles : system, user, assistant, tool.
• content: (string ou array) Contenu du message.
  • En mode reconnaissance d'image, content est un tableau (array) contenant des objets de type text et image_url.

---

Exemple de requête

Requête mixte Texte et Image (JSON)

{
    "model": "gpt-4o",
    "messages": [
      {
        "role": "system",
        "content": "Vous êtes un assistant professionnel en analyse d'images."
      },
      {
            "role": "user",
            "content": [
                {
                    "type": "text", 
                    "text": "Que contient cette image ? Veuillez la décrire en détail."
                },
                {
                    "type": "image_url",
                    "image_url": {
                        "url": "https://example.com/image.png"
                    }
                }
            ]
        }
    ],
    "stream": true
}

---

Description de la réponse

Réponse non-streaming (stream: false)

Exemple de réponse

{
    "id": "chatcmpl-123",
    "object": "chat.completion",
    "created": 1677652288,
    "choices": [
        {
            "index": 0,
            "message": {
                "role": "assistant",
                "content": "Cette image montre un lac paisible avec une chaîne de montagnes en arrière-plan."
            },
            "finish_reason": "stop"
        }
    ],
    "usage": {
        "prompt_tokens": 120,
        "completion_tokens": 35,
        "total_tokens": 155
    }
}

Réponse en streaming (stream: true)

Lorsque stream est configuré sur true, l'API renvoie text/event-stream. Chaque ligne commence par data: , suivi d'une chaîne JSON. Le tout dernier message est data: [DONE].

---

FAQ (Foire Aux Questions)

Q1 : Comment puis-je uploader une image directement au lieu d'utiliser une URL ? R : Cette API prend principalement en charge les URL d'images. Si vous n'avez que des images locales, il est recommandé de les uploader d'abord sur votre hébergeur d'images ou un stockage objet (OSS), ou de convertir l'image en une chaîne codée en Base64 au format data:image/jpeg;base64,{base64_encode_data} et de la placer dans le champ url.

Q2 : Pourquoi ma requête en streaming ne renvoie-t-elle pas les statistiques usage ? R : Dans le protocole de streaming standard compatible OpenAI, usage n'est généralement renvoyé que dans le dernier bloc de données ou en configurant un paramètre spécial stream_options. Veuillez vérifier si la version de votre modèle prend en charge le renvoi du comptage des tokens dans le flux (stream).

Q3 : Quelles sont les restrictions de taille et de format pour la reconnaissance d'image ? R : Généralement, les formats PNG, JPEG, WEBP et GIF (non animés) sont pris en charge. Il est recommandé que la taille de l'image ne dépasse pas 20 Mo. Pour obtenir les meilleurs résultats de reconnaissance, une résolution supérieure à 512x512 est recommandée.

Q4 : Que dois-je faire si ma requête renvoie l'erreur "401 Unauthorized" ? R : Assurez-vous d'avoir correctement transmis le champ Authorization dans l'en-tête (Header), au format Bearer suivi de votre CLÉ API (API KEY), et vérifiez que la clé est valide et que le solde de votre compte est suffisant.

Q5 : Le paramètre temperature affecte-t-il la reconnaissance d'image ? R : Oui. Le paramètre temperature influence la créativité linguistique du modèle lors de la description de l'image. Si vous avez besoin d'une description très objective et rigoureuse, il est recommandé de définir une valeur faible (ex. 0.2) ; si vous souhaitez une description plus vivante et intéressante, vous pouvez définir une valeur plus élevée (ex. 0.8).

Q6 : Comment traiter la reconnaissance de plusieurs images ? R : Vous pouvez placer plusieurs objets de type image_url dans le tableau messages.content. Le modèle essaiera de comprendre le contenu de toutes ces images simultanément.