Skip to content

Openai Responses 接口返回参数大全 ​

Openai API官方网址(以官方为准) ​

https://platform.openai.com/docs/api-reference/responses

核心返回信息 ​

id ​

  • 类型: 字符串
  • 说明: 响应的唯一标识符。

object ​

  • 类型: 字符串
  • 说明: 对象类型, 固定值为 "response"。

created_at ​

  • 类型: 整数
  • 说明: 响应创建时间的 Unix 时间戳。

status ​

  • 类型: 字符串
  • 说明: 响应状态,例如 "completed"、"in_progress" 等。

模型输出 ​

output ​

  • 类型: 数组
  • 说明: 包含生成的回复和工具调用。可能包含:
    • 消息对象 (type: "message")
    • 工具使用对象 (type: "tool_use")

usage ​

  • 类型: 对象
  • 说明: Token 使用统计信息。
  • 属性:
    • input_tokens: 输入使用的 token 数。
    • input_tokens_details: 输入 token 的详细信息。
    • output_tokens: 输出使用的 token 数。
    • output_tokens_details: 输出 token 的详细信息。
    • total_tokens: 总 token 数。

模型配置与参数 ​

model ​

  • 类型: 字符串
  • 说明: 使用的模型名称。

instructions ​

  • 类型: 字符串 或 null
  • 说明: 提供给模型的系统指令。

max_output_tokens ​

  • 类型: 整数 或 null
  • 说明: 限制模型生成的最大 token 数量。

temperature ​

  • 类型: 数字
  • 说明: 采样的温度。值越高,输出越随机;值越低,输出越确定。

top_p ​

  • 类型: 数字
  • 说明: 核采样阈值。

truncation ​

  • 类型: 字符串
  • 说明: 截断策略。

text ​

  • 类型: 对象
  • 说明: 文本输出格式的配置。

工具调用 ​

tools ​

  • 类型: 数组
  • 说明: 提供给模型的可用工具列表。

tool_choice ​

  • 类型: 字符串
  • 说明: 工具选择的策略。

parallel_tool_calls ​

  • 类型: 布尔值
  • 说明: 是否启用并行工具调用。

状态与元数据 ​

error ​

  • 类型: 对象 或 null
  • 说明: 如果请求过程中发生错误,此字段将包含详细的错误信息。

incomplete_details ​

  • 类型: 对象 或 null
  • 说明: 如果响应因某种原因不完整,此字段将包含相关信息。

previous_response_id ​

  • 类型: 字符串 或 null
  • 说明: 前一个响应的 ID,用于维持多轮对话的上下文。

reasoning ​

  • 类型: 对象
  • 说明: 与模型推理过程相关的信息。

store ​

  • 类型: 布尔值
  • 说明: 是否存储此响应。

user ​

  • 类型: 字符串 或 null
  • 说明: 用户的唯一标识符。

metadata ​

  • 类型: 对象
  • 说明: 可以附加到对象的附加元数据信息。

一个 Key 用全球大模型