Chat-completions maken (streaming)

Referentie naar officiële documentatie: OpenAI Chat Create

Beschrijving van de API

Gegeven een prompt retourneert het model één of meer voorspelde aanvullingen op het gesprek. Deze API ondersteunt zowel standaardantwoorden als streaming-antwoorden (SSE), en kan ook de waarschijnlijkheden van alternatieve tokens per positie retourneren.

Verzoekbeschrijving

• HTTP-methode: POST
• Request-URL: https://api.codingplanx.ai/v1/chat/completions

Requestheaders (Headers)

Requestbody (Request Body)

Voorbeeldrequest

{
  "model": "gpt-5-mini",
  "max_tokens": 1000,
  "messages": [
    {
      "role": "system",
      "content": "Je bent een behulpzame assistent."
    },
    {
      "role": "user",
      "content": "Hallo"
    }
  ],
  "temperature": 1.0,
  "stream": true,
  "stream_options": {
    "include_usage": true
  }
}

---

Beschrijving van de response

• Content-Type: application/json (niet-streaming) of text/event-stream (bij streaming wanneer stream: true)

Responseparameters (niet-streamingstructuur)

Voorbeeldresponse (niet-streaming / geaggregeerd streamingresultaat)

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

(Opmerking: als in de aanvraag stream: true is opgegeven, bestaat de responsebody uit een SSE-eventstream gescheiden door regeleinden. Elke regel begint met data: {...}, en eindigt met data: [DONE].)

---

FAQs (veelgestelde vragen)

V1: Hoe parse ik een streaming-response wanneer stream: true is ingeschakeld?
A: Wanneer stream: true is ingeschakeld, retourneert de API gegevens via het Server-Sent Events (SSE)-protocol. De client moet de responsestream regel voor regel uitlezen, regels zoeken die beginnen met data: , en deze vervolgens als JSON parsen. Let erop dat het laatste bericht in de stream altijd data: [DONE] is; dit markeert het einde van de stream. Tijdens het parsen moet deze eindmarkering worden uitgefilterd.

V2: Waarom blijft mijn verzoek hangen of retourneert het een eindeloze stroom witruimte nadat ik response_format op JSON heb gezet?
A: Wanneer u { "type": "json_object" } gebruikt om de JSON-modus in te schakelen, moet u in de meegegeven messages (meestal in de system prompt) expliciet aangeven dat het model JSON moet genereren. Zonder zo’n instructie kan het model vastlopen en eindeloos witruimte genereren totdat de limiet van max_tokens wordt bereikt.

V3: Kunnen de parameters temperature en top_p tegelijk worden aangepast?
A: Officieel wordt sterk afgeraden om beide tegelijk aan te passen. Beide parameters regelen de mate van willekeur in de modeloutput. Als u stabielere en voorspelbaardere resultaten wilt, verlaag dan temperature of verklein top_p; als u creatievere antwoorden wilt, verhoog dan een van beide. Het gelijktijdig aanpassen van beide maakt het resultaat moeilijk voorspelbaar.

V4: Wat doet extra_body.enable_thinking?
A: Dit is een specifieke uitbreidingsparameter van deze API. Wanneer {"enable_thinking": true} wordt meegegeven, zal het model, indien ondersteund door de backend, de denkmodus inschakelen (Thinking Mode/CoT), zoals bij sommige redeneer-geoptimaliseerde grote modellen. Als het model dit niet ondersteunt, wordt deze parameter doorgaans genegeerd.

V5: Waarom is finish_reason in de response length in plaats van stop?
A: Wanneer finish_reason de waarde length heeft, betekent dit dat het model werd afgekapt voordat het een volledig antwoord kon genereren. Dit komt meestal doordat max_tokens te laag is ingesteld, of omdat de totale hoeveelheid invoer- en outputtokens de maximale contextwindow van het huidige model overschrijdt. Probeer max_tokens te verhogen.