Skip to content

数据模型: ChatCompletionRequest ​

ResponseFormat ​

字段类型必选描述
typestring否
json_schemaobject否JSON 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.parametersobject否JSON 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.datastring否Base64 编码的音频数据
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.