Documentation de l'API : Créer un appel de fonction de chat (Function Calling)

Description de l'API

À partir d'un prompt (invite), le modèle renverra un ou plusieurs résultats de complétion prédits, et peut également renvoyer les probabilités des tokens alternatifs à chaque position. Cet endpoint prend spécifiquement en charge la fonctionnalité d'Appel de fonction (Function Calling), permettant au modèle de choisir intelligemment entre la génération d'un message et l'appel d'une fonction spécifique.

• Référence officielle : Guide du Function Calling

Informations de base

• Méthode de requête : POST
• URL de la requête : https://api.codingplanx.ai/v1/chat/completions
• Format des données : application/json

---

En-têtes de requête (Headers)

---

Corps de la requête (Body)

Exemple de corps de requête

{
    "model": "gpt-4o",
    "messages": [
        {
            "role": "system",
            "content": "You are a helpful customer support assistant. Use the supplied tools to assist the user."
        },
        {
            "role": "user",
            "content": "Hi, can you tell me the delivery date for my order?"
        },
        {"role": "assistant", "content": "Hi there! I can help with that. Can you please provide your order ID?"},
        {"role": "user", "content": "i think it is order_12345"}
    ],
    "tools": [
        {
            "type": "function",
            "function": {
                "name": "get_delivery_date",
                "description": "Get the delivery date for a customer's order. Call this whenever you need to know the delivery date, for example when a customer asks 'Where is my package'",
                "parameters": {
                    "type": "object",
                    "properties": {
                        "order_id": {
                            "type": "string",
                            "description": "The customer's order ID."
                        }
                    },
                    "required": [
                        "order_id"
                    ],
                    "additionalProperties": false
                }
            }
        }
    ]
}

---

Paramètres de réponse (Response)

Exemple de réponse (200 OK)

{
    "id": "chatcmpl-123",
    "object": "chat.completion",
    "created": 1677652288,
    "choices": [
        {
            "index": 0,
            "message": {
                "role": "assistant",
                "content": "\r
\r
Hello there, how may I assist you today?"
            },
            "finish_reason": "stop"
        }
    ],
    "usage": {
        "prompt_tokens": 9,
        "completion_tokens": 12,
        "total_tokens": 21
    }
}

---

Foire Aux Questions (FAQs)

Q1 : Comment forcer le modèle à appeler une fonction spécifique que j'ai désignée ? R : Vous pouvez accomplir cela en configurant le paramètre tool_choice. Par exemple, si le nom de votre fonction est get_weather, vous pouvez définir tool_choice sur : {"type": "function", "function": {"name": "get_weather"}}. Ainsi, le modèle ignorera les réponses textuelles normales et sera contraint de générer les arguments pour cette fonction spécifique.

Q2 : Pourquoi le contenu de ma réponse est-il tronqué ? R : Veuillez vérifier la valeur de choices[0].finish_reason dans la réponse. S'il s'agit de "length", cela signifie que le texte généré a dépassé la limite du paramètre max_tokens que vous avez défini, ou qu'il a atteint la longueur maximale de contexte du modèle. Vous pouvez essayer d'augmenter la valeur de max_tokens.

Q3 : temperature et top_p permettent tous deux de contrôler l'aléatoire, comment dois-je les utiliser ? R : Ces deux paramètres ajustent effectivement la diversité de la sortie du modèle. Des valeurs élevées rendront la sortie plus créative, tandis que des valeurs plus basses la rendront plus rigoureuse et déterministe. La recommandation officielle est de ne modifier qu'un seul de ces paramètres et de conserver l'autre à sa valeur par défaut. Ne modifiez pas les deux simultanément pour éviter des résultats imprévisibles.

Q4 : Quel est le format des données renvoyées par l'API lorsque stream: true est activé ? R : Une fois le mode de streaming activé, l'API ne renvoie plus un objet JSON unique, mais un flux de données au format Server-Sent Events (SSE). Les données seront envoyées par blocs progressifs sous la forme data: {"id": "...", "choices": [{"delta": {"content": "..."}}]}. Lorsque la transmission est terminée, le dernier message envoyé sera data: [DONE].

Q5 : Quelles sont les précautions à prendre lors de l'activation du mode JSON via response_format ? R : Lorsque vous définissez response_format sur { "type": "json_object" }, vous devez absolument indiquer explicitement au modèle de générer des données au format JSON dans les messages (dans le prompt système ou utilisateur). Si vous ne le faites pas, le modèle risque de s'enfermer dans une boucle infinie en générant des espaces blancs, ce qui entraînera une expiration de la requête (timeout) ou l'atteinte de la limite maximale de tokens.