API-Dokumentation: Erstellen eines Chat-Funktionsaufrufs

Schnittstellenbeschreibung

Basierend auf einem Prompt gibt das Modell eine oder mehrere vorhergesagte Vervollständigungen (Completions) zurück und kann optional die Wahrscheinlichkeiten alternativer Tokens an jeder Position liefern. Dieser Endpunkt unterstützt insbesondere die Funktion Function Calling (Funktionsaufruf), die es dem Modell ermöglicht, intelligent zwischen der Generierung einer Textnachricht und dem Aufruf einer bestimmten Funktion zu wählen.

• Offizielle Referenz: Function Calling Guide

Basisinformationen

• Anfragemethode: POST
• Anfrage-URL: https://api.codingplanx.ai/v1/chat/completions
• Datenformat: application/json

---

Anfrage-Header (Headers)

---

Anfrage-Body (Body)

Beispiel für einen Anfrage-Body

{
    "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
                }
            }
        }
    ]
}

---

Antwortparameter (Response)

Antwortbeispiel (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
    }
}

---

Häufig gestellte Fragen (FAQs)

F1: Wie zwinge ich das Modell, eine bestimmte von mir angegebene Funktion aufzurufen? A: Dies können Sie durch Festlegen des Parameters tool_choice erreichen. Wenn Ihre Funktion beispielsweise get_weather heißt, können Sie tool_choice auf {"type": "function", "function": {"name": "get_weather"}} setzen. Auf diese Weise ignoriert das Modell reguläre Antworten und wird gezwungen, die Parameter für diese Funktion auszugeben.

F2: Warum wurde der Inhalt meiner Antwort abgeschnitten? A: Bitte überprüfen Sie den Wert von choices[0].finish_reason in der Antwort. Wenn er "length" lautet, bedeutet dies, dass der generierte Text das von Ihnen festgelegte Limit des Parameters max_tokens überschritten hat oder die maximale Kontextlänge des Modells erreicht wurde. Sie können versuchen, den Wert von max_tokens zu erhöhen.

F3: Sowohl temperature als auch top_p steuern die Zufälligkeit. Wie sollte ich sie verwenden? A: Beide Parameter passen die Vielfalt der Modellausgabe an. Höhere Werte machen die Ausgabe kreativer, während niedrigere Werte sie strenger und deterministischer machen. Offiziell wird empfohlen, nur einen der beiden Parameter anzupassen und den anderen auf dem Standardwert zu belassen. Ändern Sie nicht beide gleichzeitig, um unvorhersehbare Ergebnisse zu vermeiden.

F4: Wie sieht das Datenformat der API-Antwort aus, wenn stream: true aktiviert ist? A: Nach der Aktivierung des Streamings gibt die API kein einzelnes JSON-Objekt mehr zurück, sondern einen Server-Sent Events (SSE)-Datenstrom. Die Daten werden stückweise in der Form data: {"id": "...", "choices": [{"delta": {"content": "..."}}]} gesendet. Wenn die Übertragung abgeschlossen ist, lautet die letzte Nachricht data: [DONE].

F5: Was muss beachtet werden, wenn response_format als JSON-Modus aktiviert wird? A: Wenn Sie response_format auf { "type": "json_object" } setzen, müssen Sie dem Modell in den messages (System-Prompt oder Benutzer-Prompt) explizit anweisen, Daten im JSON-Format zu generieren. Andernfalls könnte das Modell in eine Endlosschleife geraten, in der es Leerzeichen generiert, was zu Zeitüberschreitungen bei der Anfrage führt oder das Token-Limit erreicht.