Skip to content

数据模型: ChatCompletionRequest

ResponseFormat

字段类型必选描述
typestring
json_schemaobjectJSON Schema 定义

数据模型示例

json
{
  "type": "string",
  "json_schema": {}
}

ChatCompletionRequest

字段类型必选描述
modelstring模型 ID
messagesarray of any对话消息列表
temperaturenumber采样温度
top_pnumber核采样参数
ninteger生成数量
streamboolean是否流式响应
stream_optionsobject
stream_options.include_usageboolean
stopany停止序列
max_tokensinteger最大生成 Token 数
max_completion_tokensinteger最大补全 Token 数
presence_penaltynumber
frequency_penaltynumber
logit_biasobject
userstring
toolsarray of any
tool_choiceany
response_formatany
seedinteger
reasoning_effortstring推理强度 (用于支持推理的模型)
modalitiesarray of string
audioobject
audio.voicestring
audio.formatstring

数据模型示例

json
{
  "model": "gpt-4",
  "messages": [
    {
      "role": "string",
      "content": null,
      "name": "string",
      "tool_calls": [
        {
          "id": "string",
          "type": "function",
          "function": {
            "name": "string",
            "arguments": "string"
          }
        }
      ],
      "tool_call_id": "string",
      "reasoning_content": "string"
    }
  ],
  "temperature": 0,
  "top_p": 0,
  "n": 0,
  "stream": true,
  "stream_options": {
    "include_usage": true
  },
  "stop": null,
  "max_tokens": 0,
  "max_completion_tokens": 0,
  "presence_penalty": 0,
  "frequency_penalty": 0,
  "logit_bias": {},
  "user": "string",
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "string",
        "description": "string",
        "parameters": {}
      }
    }
  ],
  "tool_choice": null,
  "response_format": {
    "type": "string",
    "json_schema": {}
  },
  "seed": 0,
  "reasoning_effort": "string",
  "modalities": [
    "string"
  ],
  "audio": {
    "voice": "string",
    "format": "string"
  }
}

ToolCall

字段类型必选描述
idstring
typestring
functionobject
function.namestring
function.argumentsstring

数据模型示例

json
{
  "id": "string",
  "type": "function",
  "function": {
    "name": "string",
    "arguments": "string"
  }
}

Tool

字段类型必选描述
typestring
functionobject
function.namestring
function.descriptionstring
function.parametersobjectJSON Schema 格式的参数定义

数据模型示例

json
{
  "type": "function",
  "function": {
    "name": "string",
    "description": "string",
    "parameters": {}
  }
}

MessageContent

字段类型必选描述
typestring
textstring
image_urlobject
image_url.urlstring图片 URL 或 base64
image_url.detailstring
input_audioobject
input_audio.datastringBase64 编码的音频数据
input_audio.formatstring
fileobject
file.filenamestring
file.file_datastring
file.file_idstring
video_urlobject
video_url.urlstring

数据模型示例

json
{
  "type": "string",
  "text": "string",
  "image_url": {
    "url": "string",
    "detail": "string"
  },
  "input_audio": {
    "data": "string",
    "format": "string"
  },
  "file": {
    "filename": "string",
    "file_data": "string",
    "file_id": "string"
  },
  "video_url": {
    "url": "string"
  }
}

Message

字段类型必选描述
rolestring消息角色
contentany消息内容
namestring发送者名称
tool_callsarray of any
tool_call_idstring工具调用 ID(用于 tool 角色消息)
reasoning_contentstring推理内容

数据模型示例

json
{
  "role": "string",
  "content": null,
  "name": "string",
  "tool_calls": [
    {
      "id": "string",
      "type": "function",
      "function": {
        "name": "string",
        "arguments": "string"
      }
    }
  ],
  "tool_call_id": "string",
  "reasoning_content": "string"
}

Released under the MIT License.