Skip to main content

StreamingChoiceResponse

indexIndex (integer)required
delta objectrequired
roleRole (string)required

Possible values: [system, user, assistant, developer, tool, function]

content object
anyOf
string
reasoning_content object
anyOf
string
name object
anyOf
string
tool_calls object
anyOf
  • Array [
  • idId (string)required
    index object
    anyOf
    integer
    typeType (string)
    Constant value: function
    Default value: function
    function objectrequired
    idId (string)
    nameName (string)required
    argumentsArguments (string)required
  • ]
  • tool_call_id object
    anyOf
    string
    function_call object
    anyOf
    object
    logprobs object
    anyOf
    content object
    anyOf
  • Array [
  • tokenToken (string)required
    logprobLogprob (number)required
    bytes object
    anyOf
  • Array [
  • integer
  • ]
  • top_logprobs object[]required
  • Array [
  • tokenToken (string)required
    logprobLogprob (number)required
    bytes object
    anyOf
  • Array [
  • integer
  • ]
  • ]
  • ]
  • finish_reason object
    anyOf
    string

    Possible values: [stop, length, tool_calls, content_filter, function_call, error]

    usage object
    anyOf
    prompt_tokensPrompt Tokens (integer)required
    completion_tokensCompletion Tokens (integer)required
    total_tokensTotal Tokens (integer)required
    prompt_tokens_details objectrequired
    cached_tokensCached Tokens (integer)
    Default value: 0
    audio_tokensAudio Tokens (integer)
    Default value: 0
    completion_tokens_details objectrequired
    reasoning_tokensReasoning Tokens (integer)
    Default value: 0
    audio_tokensAudio Tokens (integer)
    Default value: 0
    accepted_prediction_tokensAccepted Prediction Tokens (integer)
    Default value: 0
    rejected_prediction_tokensRejected Prediction Tokens (integer)
    Default value: 0
    StreamingChoiceResponse
    {
    "index": 0,
    "delta": {
    "role": "system",
    "content": "string",
    "reasoning_content": "string",
    "name": "string",
    "tool_calls": [
    {
    "id": "string",
    "index": 0,
    "type": "function",
    "function": {
    "id": "string",
    "name": "string",
    "arguments": "string"
    }
    }
    ],
    "tool_call_id": "string",
    "function_call": {}
    },
    "logprobs": {
    "content": [
    {
    "token": "string",
    "logprob": 0,
    "bytes": [
    0
    ],
    "top_logprobs": [
    {
    "token": "string",
    "logprob": 0,
    "bytes": [
    0
    ]
    }
    ]
    }
    ]
    },
    "finish_reason": "stop",
    "usage": {
    "prompt_tokens": 0,
    "completion_tokens": 0,
    "total_tokens": 0,
    "prompt_tokens_details": {
    "cached_tokens": 0,
    "audio_tokens": 0
    },
    "completion_tokens_details": {
    "reasoning_tokens": 0,
    "audio_tokens": 0,
    "accepted_prediction_tokens": 0,
    "rejected_prediction_tokens": 0
    }
    }
    }