Yomi APIYomi API帮助文档 返回控制台

English

Yomi API / 帮助文档 / OpenAI Responses API

开发集成

OpenAI Responses API

Responses API 是 OpenAI 面向 Agent 场景的接口,在对话生成之上提供工具调用等 Agent 场景能力。Yomi API 支持 /v1/responses 与配套的上下文压缩接口。

接口地址

POST https://api.yomiapi.com/v1/responses
POST https://api.yomiapi.com/v1/responses/compact

快速调用

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.yomiapi.com/v1"
)

response = client.responses.create(
    model="gpt-5.6-sol",
    input="总结 Responses API 与 Chat Completions 的主要差异"
)
print(response.output_text)

多轮对话请在客户端累积完整历史,每轮全量发送(无状态模式):把每轮的 response.output 并入历史后再追加新一轮输入:

history = [{"role": "user", "content": "总结 Responses API 与 Chat Completions 的主要差异"}]
response = client.responses.create(model="gpt-5.6-sol", input=history)

history += response.output  # 把本轮输出并入历史
history.append({"role": "user", "content": "把上面的结论整理成三点"})
follow_up = client.responses.create(model="gpt-5.6-sol", input=history)
print(follow_up.output_text)
请勿使用 previous_response_id:当前 HTTP 接口不支持该字段(会返回 400 previous_response_id is only supported on Responses WebSocket v2)。请采用客户端维护完整对话历史的无状态调用方式,详见「常见问题速查」。

与 Chat Completions 对比

特性Chat CompletionsResponses API
定位基础对话生成Agent 应用构建
多轮状态客户端维护 messages客户端维护 input 历史
工具调用tools 定义,手动回传结果tools 定义,支持内置工具类型
适用场景常规对话、单次任务多步推理、工具协作任务

请求参数

  • model(必填): 模型 id,如 gpt-5.6-sol。
  • input: 用户输入,字符串或结构化内容列表。
  • instructions: 系统指令。
  • tools: 可用工具列表。
  • previous_response_id(请勿使用): 当前 HTTP 接口不支持,传入会返回 400 错误。
  • stream: 设为 true 开启流式输出。
  • max_output_tokens / temperature / top_p: 生成控制参数,语义与 Chat Completions 一致。
  • reasoning: 推理控制,配合 claude-opus-4-8、gpt-5.5 等推理模型使用。

上下文压缩

/v1/responses/compact 用于压缩长会话:将累积的对话输入压缩为更精简的上下文,降低后续请求的 token 消耗。参数为 model、input 与 instructions(input 携带待压缩的完整对话内容;同 /v1/responses 一样请勿传 previous_response_id),该接口不支持流式输出。

不同模型对 Responses API 工具类型的支持程度不同,可用性以实际调用结果与模型广场线路信息为准。