API-interface-documentatie: chatfunctieaanroepen aanmaken

Beschrijving van de interface

Gegeven een prompt retourneert het model een of meer voorspelde completions en kan het ook de waarschijnlijkheden van alternatieve tokens per positie teruggeven. Deze interface ondersteunt in het bijzonder functieaanroepen (Function Calling), waardoor het model intelligent kan kiezen tussen het genereren van berichten en het aanroepen van opgegeven functies.

• Officiële referentie: Handleiding voor functieaanroepen

Basisinformatie

• Verzoekmethode: POST
• Verzoek-URL: https://api.codingplanx.ai/v1/chat/completions
• Gegevensformaat: application/json

---

Verzoekheaders (Headers)

---

Verzoekbody (Body)

Voorbeeld van de verzoekbody

{
    "model": "gpt-4o",
    "messages": [
        {
            "role": "system",
            "content": "Je bent een behulpzame klantenservice-assistent. Gebruik de meegeleverde tools om de gebruiker te helpen."
        },
        {
            "role": "user",
            "content": "Hoi, kun je me de leverdatum van mijn bestelling vertellen?"
        },
        {"role": "assistant", "content": "Hoi! Ik kan je daarmee helpen. Kun je alsjeblieft je bestel-ID doorgeven?"},
        {"role": "user", "content": "ik denk dat het order_12345 is"}
    ],
    "tools": [
        {
            "type": "function",
            "function": {
                "name": "get_delivery_date",
                "description": "Haal de leverdatum van de bestelling van een klant op. Roep deze functie aan wanneer je de leverdatum moet weten, bijvoorbeeld als een klant vraagt: 'Waar is mijn pakket?'",
                "parameters": {
                    "type": "object",
                    "properties": {
                        "order_id": {
                            "type": "string",
                            "description": "De bestel-ID van de klant."
                        }
                    },
                    "required": [
                        "order_id"
                    ],
                    "additionalProperties": false
                }
            }
        }
    ]
}

---

Responsparameters (Response)

Responsvoorbeeld (200 OK)

{
    "id": "chatcmpl-123",
    "object": "chat.completion",
    "created": 1677652288,
    "choices": [
        {
            "index": 0,
            "message": {
                "role": "assistant",
                "content": "\r
\r
Hallo! Hoe kan ik je vandaag helpen?"
            },
            "finish_reason": "stop"
        }
    ],
    "usage": {
        "prompt_tokens": 9,
        "completion_tokens": 12,
        "total_tokens": 21
    }
}

---

Veelgestelde vragen (FAQs)

Q1: Hoe dwing ik het model om een specifieke functie aan te roepen?
A: U kunt dit instellen via de parameter tool_choice. Als uw functienaam bijvoorbeeld get_weather is, kunt u tool_choice instellen op: {"type": "function", "function": {"name": "get_weather"}}. Het model zal dan een normale tekstreactie negeren en verplicht de parameters voor die functie genereren.

Q2: Waarom is mijn antwoord afgekapt?
A: Controleer de waarde van choices[0].finish_reason in de respons. Als deze "length" is, betekent dit dat de gegenereerde tekst de limiet van uw parameter max_tokens heeft overschreden, of dat de maximale contextlengte van het model is bereikt. U kunt proberen de waarde van max_tokens te verhogen.

Q3: Zowel temperature als top_p kunnen de willekeurigheid regelen. Hoe moet ik die gebruiken?
A: Deze twee parameters kunnen inderdaad allebei de diversiteit van de uitvoer beïnvloeden. Hogere waarden maken de uitvoer creatiever, terwijl lagere waarden die zorgvuldiger en deterministischer maken. Officieel wordt aanbevolen om slechts één van beide aan te passen en de andere op de standaardwaarde te laten, zodat onverwacht gedrag wordt voorkomen.

Q4: Welk gegevensformaat retourneert de interface wanneer stream: true is ingeschakeld?
A: Wanneer streaming is ingeschakeld, retourneert de interface niet langer één JSON-object, maar een Server-Sent Events (SSE)-datastroom. De gegevens worden in blokken verzonden in de vorm van data: {"id": "...", "choices": [{"delta": {"content": "..."}}]}. Wanneer de overdracht is voltooid, is het laatste bericht data: [DONE].

Q5: Waar moet ik op letten bij het inschakelen van response_format in JSON-modus?
A: Wanneer u response_format instelt op { "type": "json_object" }, moet u ook expliciet in messages (systeemprompt of gebruikersprompt) aangeven dat het model JSON-formaat moet genereren. Als u dit niet doet, kan het model in een lus terechtkomen waarin alleen witruimte wordt gegenereerd, wat kan leiden tot time-outs of het bereiken van de tokenlimiet.