Sign in

v1

latestOpenAPI 3.1.02026-07-2634132204.7 KB
Response

创建响应接口

用于创建响应的接口，目前仅 OpenAI 支持，可配置各种参数来控制响应的生成结果。

post/responses

Request body

metadataMetadata nullable

一对可以附加到对象的 16 个键值对。这对于以结构化格式存储有关对象的附加信息以及通过 API 或仪表板查询对象非常有用。

键是长度最多为 64 个字符的字符串。值是长度最多为 512 个字符的字符串。

temperaturenumber nullable

要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较低的值（如 0.2）将使其更聚焦和确定。 我们通常建议修改此项或 top_p，但不要同时修改两者。

top_pnumber nullable

采样温度的另一种方法，称为核采样，模型会考虑具有 top_p 概率质量的 token 的结果。因此，0.1 意味着只考虑包含前 10% 概率质量的 token。

我们通常建议修改此项或 temperature，但不要同时修改两者。

userstring

最终用户的稳定标识符。 用于通过更好地对类似请求进行分桶来提高缓存命中率，并帮助 OpenAI 检测和防止滥用。了解更多。

service_tier'auto' | 'default' | 'flex' | 'scale' nullable

指定用于处理请求的延迟等级。此参数适用于订阅了按量计费服务的客户： - 如果设置为“auto”，并且项目启用了按量计费服务，系统将使用按量计费积分直至用尽。 - 如果设置为“auto”，但项目未启用按量计费服务，则请求将使用默认服务等级进行处理，该等级的正常运行时间服务水平协议较低，且无延迟保证。 - 如果设置为“default”，请求将使用默认服务等级进行处理，该等级的正常运行时间服务水平协议较低，且无延迟保证。 - 如果设置为“flex”，请求将使用弹性处理服务等级进行处理。了解更多。 - 如果未设置，则默认行为是“auto”。 设置此参数后，响应体将包含所使用的 service_tier。

previous_response_idstring nullable

模型上一个响应的唯一 ID。使用此 ID 来创建多轮对话。了解有关对话状态的更多信息。

backgroundboolean nullable

是否在后台运行模型响应。 了解更多.

max_output_tokensinteger nullable

可以为响应生成的 token 的上限，包括可见的输出 token 和推理 token。

truncation'auto' | 'disabled' nullable

用于模型响应的截断策略。

  • auto：如果此响应及之前的响应的上下文超出了模型的上下文窗口大小，模型将通过删除对话中间的输入项来截断响应以适应上下文窗口。
  • disabled（默认）：如果模型响应将超出模型的上下文窗口大小，请求将失败并返回 400 错误。
includeIncludable[] nullable

指定模型响应中需额外包含的数据。目前支持以下值：

  • file_search_call.results: 包含文件搜索工具调用所产生的搜索结果。
  • message.input_image.image_url: 包含输入消息中的图片链接。
  • computer_call_output.output.image_url: 包含计算机调用（computer call）输出的图片链接。
  • reasoning.encrypted_content: 在推理项（reasoning item）的输出中，包含对推理过程令牌（reasoning tokens）的加密版本。如此一来，当以无状态方式使用 Responses API 时（例如，当 store 参数设置为 false，或当组织加入了“零数据保留”计划时），推理项便可在多轮对话中继续使用。
  • code_interpreter_call.outputs: 包含代码解释器工具调用项中，Python 代码的执行输出。
parallel_tool_callsboolean nullable

是否允许模型并行执行工具调用

storeboolean nullable

是否存储生成的模型响应，以供后续通过 API 检索

instructionsstring nullable

插入到模型上下文中的系统（或开发者）消息。

当与 previous_response_id 一同使用时，先前响应中的指令将不会被沿用至新的响应中。这使得在新响应中可以轻松地替换系统（或开发者）消息。

streamboolean nullable

若设为 true，模型响应数据将在生成时，通过 Server-Sent Events 流式传输至客户端。 代码示例

Response

OK

metadataMetadata nullable required

一对可以附加到对象的 16 个键值对。这对于以结构化格式存储有关对象的附加信息以及通过 API 或仪表板查询对象非常有用。

键是长度最多为 64 个字符的字符串。值是长度最多为 512 个字符的字符串。

temperaturenumber nullable required

要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较低的值（如 0.2）将使其更聚焦和确定。 我们通常建议修改此项或 top_p，但不要同时修改两者。

top_pnumber nullable required

采样温度的另一种方法，称为核采样，模型会考虑具有 top_p 概率质量的 token 的结果。因此，0.1 意味着只考虑包含前 10% 概率质量的 token。

我们通常建议修改此项或 temperature，但不要同时修改两者。

userstring

最终用户的稳定标识符。 用于通过更好地对类似请求进行分桶来提高缓存命中率，并帮助 OpenAI 检测和防止滥用。了解更多。

service_tier'auto' | 'default' | 'flex' | 'scale' nullable

指定用于处理请求的延迟等级。此参数适用于订阅了按量计费服务的客户： - 如果设置为“auto”，并且项目启用了按量计费服务，系统将使用按量计费积分直至用尽。 - 如果设置为“auto”，但项目未启用按量计费服务，则请求将使用默认服务等级进行处理，该等级的正常运行时间服务水平协议较低，且无延迟保证。 - 如果设置为“default”，请求将使用默认服务等级进行处理，该等级的正常运行时间服务水平协议较低，且无延迟保证。 - 如果设置为“flex”，请求将使用弹性处理服务等级进行处理。了解更多。 - 如果未设置，则默认行为是“auto”。 设置此参数后，响应体将包含所使用的 service_tier。

previous_response_idstring nullable

模型上一个响应的唯一 ID。使用此 ID 来创建多轮对话。了解有关对话状态的更多信息。

backgroundboolean nullable

是否在后台运行模型响应。 了解更多.

max_output_tokensinteger nullable

可以为响应生成的 token 的上限，包括可见的输出 token 和推理 token。

truncation'auto' | 'disabled' nullable

用于模型响应的截断策略。

  • auto：如果此响应及之前的响应的上下文超出了模型的上下文窗口大小，模型将通过删除对话中间的输入项来截断响应以适应上下文窗口。
  • disabled（默认）：如果模型响应将超出模型的上下文窗口大小，请求将失败并返回 400 错误。
idstring required

此响应的唯一标识符

object'response' required

该资源的对象类型 - 始终设置为 response。

status'completed' | 'failed' | 'in_progress' | 'cancelled' | 'queued' | 'incomplete'

响应生成的状态。可能的值有 completed、failed、 in_progress、cancelled、queued 或 incomplete。

created_atnumber required

此响应创建时的 Unix 时间戳（以秒为单位）。

output_textstring nullable

仅限 SDK 的便利属性，包含 output 数组中所有 output_text 项的聚合文本输出（如果存在）。 在 Python 和 JavaScript SDK 中支持。

parallel_tool_callsboolean required

是否允许模型并行运行工具调用。

Example response

{
  "id": "resp_67ccd3a9da748190baa7f1570fe91ac604becb25c45c1d41",
  "object": "response",
  "created_at": 1741476777,
  "status": "completed",
  "error": null,
  "incomplete_details": null,
  "instructions": null,
  "max_output_tokens": null,
  "model": "gpt-4o-2024-08-06",
  "output": [
    {
      "type": "message",
      "id": "msg_67ccd3acc8d48190a77525dc6de64b4104becb25c45c1d41",
      "status": "completed",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "The image depicts a scenic landscape with a wooden boardwalk or pathway leading through lush, green grass under a blue sky with some clouds. The setting suggests a peaceful natural area, possibly a park or nature reserve. There are trees and shrubs in the background.",
          "annotations": []
        }
      ]
    }
  ],
  "parallel_tool_calls": true,
  "previous_response_id": null,
  "reasoning": {
    "effort": null,
    "summary": null
  },
  "store": true,
  "temperature": 1,
  "text": {
    "format": {
      "type": "text"
    }
  },
  "tool_choice": "auto",
  "tools": [],
  "top_p": 1,
  "truncation": "disabled",
  "usage": {
    "input_tokens": 328,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 52,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 380
  },
  "user": null,
  "metadata": {}
}