OpenAI · Responses
使用 Responses 请求格式获取模型响应;具体模型支持情况需确认。
/v1/responses查看候选模型 ID
没有符合条件的模型。请调整筛选或重置。
| 模型 ID | 厂商 | 类型 | 说明 | 上下文窗口 | 最大输出 Token | 媒体规格 | 价格 | 状态 |
|---|---|---|---|---|---|---|---|---|
| 暂无模型资料 | ||||||||
按公开标签归类,并补充模型广场资料;— 表示暂无明确资料。左右滑动查看完整表格。
Headers请求头
左右滑动查看完整参数表
| 参数名 | 类型 | 必填 | 说明 | 默认值 / 示例 |
|---|---|---|---|---|
Authorization | string | 必填 | 平台 API Key,使用 Bearer 认证。 | |
Content-Type | string | 必填 | 请求体编码格式。 |
Request Body请求体
application/json左右滑动查看完整参数表
| 参数名 | 类型 | 必填 | 说明 | 默认值 / 示例 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
model | string | 必填 | 模型 ID;请替换为账户可用且支持当前接口的模型。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
input | string | array<object> | 可选 | 输入文本或消息/工具结果数组。新建文本会话应提供输入。 | — | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 参数名 | 类型 | 必填 | 说明 | 默认值 / 示例 | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type | string | 可选 | 输入项目类型;消息通常为 message。 | — | ||||||||||||||||||||||||||||||
role | string | 可选 | 消息角色。 可选值 userassistantsystemdeveloper | — | ||||||||||||||||||||||||||||||
content | string | array<object> | 可选 | 文本或按顺序排列的输入内容块。 | — | ||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||
| 参数名 | 类型 | 必填 | 说明 | 默认值 / 示例 |
|---|---|---|---|---|
type | string | 必填 | 输入块类型。 可选值 input_textinput_imageinput_file | — |
text | string | 可选 | type=input_text 时的文本。 | — |
image_url | string | 可选 | type=input_image 时的图片 URL 或 Base64 data URL。 | — |
detail | string | 可选 | 图片处理精度;需模型支持。 可选值 autolowhigh | — |
file_url | string | 可选 | type=input_file 时可访问的文件 URL;需模型支持。 | — |
instructions本次响应的系统指令。
max_output_tokens输出 Token 上限,部分模型包含推理 Token。
temperature采样温度;需模型支持。
top_p核采样阈值;需模型支持。
stream是否返回 SSE 事件流。
tools可调用工具。函数工具使用平铺字段,与 Chat Completions 格式不同。
tools[] 的子字段 5
| 参数名 | 类型 | 必填 | 说明 | 默认值 / 示例 |
|---|---|---|---|---|
type | string | 必填 | 工具类型;此处展示函数工具。 | |
name | string | 可选 | type=function 时的函数名。 | — |
description | string | 可选 | 函数用途。 | — |
parameters | object | 可选 | 函数参数 JSON Schema。 | — |
strict | boolean | 可选 | 是否启用严格参数结构。 | — |
tool_choiceauto、none、required,或指定工具对象;需模型支持。
tool_choice 的子字段 2
| 参数名 | 类型 | 必填 | 说明 | 默认值 / 示例 |
|---|---|---|---|---|
type | string | 必填 | 工具类型。 | |
name | string | 可选 | 指定函数名称。 | — |
reasoning推理设置;仅限支持的模型。
reasoning 的子字段 2
| 参数名 | 类型 | 必填 | 说明 | 默认值 / 示例 |
|---|---|---|---|---|
effort | string | 可选 | 推理强度。 可选值 lowmediumhigh | — |
summary | string | 可选 | 请求的推理摘要模式;需模型支持。 | — |
previous_response_id用于继续已有响应的 ID;需平台开放会话状态能力。
truncation超过模型上下文时的截断策略。
autodisabledparallel_tool_calls是否允许并行工具调用;需模型支持。
text文本输出格式配置。
text 的子字段 1
| 参数名 | 类型 | 必填 | 说明 | 默认值 / 示例 | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
format | object | 可选 | 输出文本格式。 | — | |||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
| 参数名 | 类型 | 必填 | 说明 | 默认值 / 示例 |
|---|---|---|---|---|
type | string | 必填 | 格式类型。 可选值 textjson_schema | — |
name | string | 可选 | JSON Schema 名称;type=json_schema 时使用。 | — |
schema | object | 可选 | JSON Schema 定义;type=json_schema 时使用。 | — |
strict | boolean | 可选 | 是否严格遵循 Schema。 | — |
store是否请求保存响应;受账户与接口能力影响。
metadata键值形式的附加元数据。
include请求额外输出字段;支持项由具体模型及接口能力决定。
使用说明
- 此接口及会话状态、工具等能力按模型和平台配置开放。
- 响应文本通常位于 output 中 type=message 的 content[].text;不能按 Chat Completions 的 choices 路径读取。
- stream=true 时返回 response.* SSE 事件;下方为非流式结构说明样例。
流式请求与 SSE 消费
先将 MODEL_ID 替换为账户可用且支持相应能力的模型,并设置环境变量 KEDANG_API_KEY。流式、工具、图像和结构化输出分别依赖模型能力。以下 Python 示例可单独保存运行,API Key 仅在服务端读取。
| 文本增量 | 成功结束 | 异常处理 |
|---|---|---|
| response.output_text.delta | response.completed | HTTP 错误、error 事件、截断或缺少结束标记均停止处理 |
SSE 以空行分帧,多行 data: 用换行连接;不能把任意网络分块直接当作 JSON。示例读取文本增量;流式工具参数需要按调用 ID 或内容块索引累积后再解析,下面的工具示例采用非流式两步调用。
展开 Python:请求、解析事件与处理结束状态
# 安装依赖:python -m pip install requests
import base64
import json
import os
from pathlib import Path
from urllib.parse import quote
import requests
BASE_URL = "https://ai.kedang.net"
MODEL_ID = "MODEL_ID" # 替换为账户可用、支持当前能力的模型
def request_json(path, body, extra_headers=None):
headers = {"Authorization": "Bearer " + os.environ["KEDANG_API_KEY"]}
headers.update(extra_headers or {})
response = requests.post(BASE_URL + path, headers=headers, json=body, timeout=120)
response.raise_for_status()
result = response.json()
if result.get("error"):
raise RuntimeError(result["error"])
return result
def sse_lines(chunks):
"""增量解码 UTF-8,并跨网络分块正确识别 LF、CR 和 CRLF。"""
import codecs
decoder = codecs.getincrementaldecoder("utf-8")()
line, skip_lf = [], False
for chunk in chunks:
for char in decoder.decode(chunk):
if skip_lf:
skip_lf = False
if char == "\n":
continue
if char in ("\r", "\n"):
yield "".join(line)
line = []
skip_lf = char == "\r"
else:
line.append(char)
decoder.decode(b"", final=True) # 不接受 EOF 处截断的 UTF-8 字符。
if line:
yield "".join(line)
def iter_sse(lines):
"""只在空行处派发完整 SSE 帧。"""
event, data_lines = "message", []
first_line = True
for line in lines:
if first_line:
line = line.removeprefix("\ufeff")
first_line = False
if line == "":
if data_lines:
yield event, "\n".join(data_lines)
event, data_lines = "message", []
continue
if line.startswith(":"):
continue # 心跳或注释
field, separator, value = line.partition(":")
if separator and value.startswith(" "):
value = value[1:]
if field == "event":
event = value or "message"
elif field == "data":
data_lines.append(value)
# EOF 前没有空行的半帧不能当作完整事件;由下层检查终止事件。
def stream_text(events):
completed = False
for event, data in events:
if data.strip() == "[DONE]":
break
item = json.loads(data)
kind = item.get("type", event)
if kind in ("error", "response.failed", "response.incomplete") or item.get("error"):
raise RuntimeError(item)
if kind == "response.refusal.delta":
raise RuntimeError(item.get("delta", "请求未完成"))
if kind == "response.output_text.delta":
yield item.get("delta", "")
elif kind == "response.completed":
status = item.get("response", {}).get("status")
if status != "completed":
raise RuntimeError(item)
completed = True
break
if not completed:
raise RuntimeError("连接在 response.completed 前结束。")
def main():
path = "/v1/responses"
body = {"model": MODEL_ID, "input": "用三句话介绍杭州。", "stream": True}
headers = {"Authorization": "Bearer " + os.environ["KEDANG_API_KEY"],
"Accept": "text/event-stream"}
headers.update({})
with requests.post(BASE_URL + path, headers=headers, json=body,
stream=True, timeout=(10, 120)) as response:
response.raise_for_status()
if "text/event-stream" not in response.headers.get("Content-Type", ""):
raise RuntimeError("预期 SSE,请检查返回的 Content-Type 和错误信息。")
events = iter_sse(sse_lines(response.iter_content(chunk_size=128)))
for text in stream_text(events):
print(text, end="", flush=True)
print()
if __name__ == "__main__":
main()工具调用:返回结果后继续回答
第一步让模型提出工具调用,应用校验参数并执行本地函数;第二步将每个结果和原始调用上下文一起发回。示例只允许调用本地加法函数,第二轮关闭工具,避免无界循环。实际业务需自行设置允许执行的工具与轮次上限。
| 结果关联字段 | 本地工具 | 回传内容 |
|---|---|---|
| function_call_output.call_id | add_numbers(a, b) | JSON 对象 {"sum": 5} |
展开 Python:完整两步工具调用
# 安装依赖:python -m pip install requests
import base64
import json
import os
from pathlib import Path
from urllib.parse import quote
import requests
BASE_URL = "https://ai.kedang.net"
MODEL_ID = "MODEL_ID" # 替换为账户可用、支持当前能力的模型
def request_json(path, body, extra_headers=None):
headers = {"Authorization": "Bearer " + os.environ["KEDANG_API_KEY"]}
headers.update(extra_headers or {})
response = requests.post(BASE_URL + path, headers=headers, json=body, timeout=120)
response.raise_for_status()
result = response.json()
if result.get("error"):
raise RuntimeError(result["error"])
return result
PARAMETERS = {
"type": "object",
"properties": {"a": {"type": "number"}, "b": {"type": "number"}},
"required": ["a", "b"],
"additionalProperties": False,
}
def run_tool(name, args):
# 工具名和参数都先校验;只执行应用主动注册的函数。
if name != "add_numbers" or not isinstance(args, dict) or set(args) != {"a", "b"}:
raise ValueError("未知工具或参数不匹配")
if any(type(args[key]) not in (int, float) for key in ("a", "b")):
raise ValueError("a 和 b 必须为数字")
return {"sum": args["a"] + args["b"]}
def main():
tools = [{"type": "function", "name": "add_numbers",
"description": "计算两个数字之和", "parameters": PARAMETERS}]
items = [{"role": "user", "content": "请用工具计算 2 加 3。"}]
first = request_json("/v1/responses", {
"model": MODEL_ID, "input": items, "tools": tools, "tool_choice": "auto"})
output = first.get("output", [])
calls = [item for item in output if item.get("type") == "function_call"]
if not calls:
print(first)
return
items.extend(output) # 一并保留 reasoning 等输出项,不只保留 function_call。
for call in calls:
result = run_tool(call["name"], json.loads(call["arguments"]))
items.append({"type": "function_call_output", "call_id": call["call_id"],
"output": json.dumps(result, ensure_ascii=False)})
second = request_json("/v1/responses", {
"model": MODEL_ID, "input": items, "tools": tools, "tool_choice": "none"})
for item in second.get("output", []):
for part in item.get("content", []):
if part.get("type") == "output_text":
print(part["text"])
if __name__ == "__main__":
main()图片输入
示例读取本地 input.png。文件格式与 MIME 类型必须一致;图片数量、大小和支持格式以所选模型为准。这里展示图片理解输入,生成图片请使用图像生成接口。
展开 Python:发送本地 PNG 图片
# 安装依赖:python -m pip install requests
import base64
import json
import os
from pathlib import Path
from urllib.parse import quote
import requests
BASE_URL = "https://ai.kedang.net"
MODEL_ID = "MODEL_ID" # 替换为账户可用、支持当前能力的模型
def request_json(path, body, extra_headers=None):
headers = {"Authorization": "Bearer " + os.environ["KEDANG_API_KEY"]}
headers.update(extra_headers or {})
response = requests.post(BASE_URL + path, headers=headers, json=body, timeout=120)
response.raise_for_status()
result = response.json()
if result.get("error"):
raise RuntimeError(result["error"])
return result
def main():
image = base64.b64encode(Path("input.png").read_bytes()).decode("ascii")
result = request_json("/v1/responses", {"model": MODEL_ID, "input": [
{"role": "user", "content": [
{"type": "input_text", "text": "请描述这张图片。"},
{"type": "input_image", "image_url": "data:image/png;base64," + image}
]}]})
for item in result.get("output", []):
for part in item.get("content", []):
if part.get("type") == "output_text":
print(part["text"])
if __name__ == "__main__":
main()结构化输出
只有支持所选格式约束的模型才能使用此示例;普通 JSON 模式与严格 JSON Schema 的约束强度不同。 输出仍需处理拒绝、截断和字段类型错误。
| 当前协议字段 | 应用侧校验 |
|---|---|
| text.format | city 为字符串,days 为整数;仅接受完整返回结果 |
展开 Python:提取 JSON 对象并校验
# 安装依赖:python -m pip install requests
import base64
import json
import os
from pathlib import Path
from urllib.parse import quote
import requests
BASE_URL = "https://ai.kedang.net"
MODEL_ID = "MODEL_ID" # 替换为账户可用、支持当前能力的模型
def request_json(path, body, extra_headers=None):
headers = {"Authorization": "Bearer " + os.environ["KEDANG_API_KEY"]}
headers.update(extra_headers or {})
response = requests.post(BASE_URL + path, headers=headers, json=body, timeout=120)
response.raise_for_status()
result = response.json()
if result.get("error"):
raise RuntimeError(result["error"])
return result
SCHEMA = {
"type": "object",
"properties": {"city": {"type": "string"}, "days": {"type": "integer"}},
"required": ["city", "days"],
"additionalProperties": False,
}
def check_trip(value):
# 业务侧仍校验结果,尤其要区分拒绝、截断和有效 JSON。
if not isinstance(value, dict) or set(value) != {"city", "days"}:
raise ValueError("返回对象不匹配 Schema")
if not isinstance(value["city"], str) or type(value["days"]) is not int:
raise ValueError("字段类型不匹配 Schema")
return value
def main():
result = request_json("/v1/responses", {"model": MODEL_ID,
"input": "提取旅行信息:杭州,3 天。",
"text": {"format": {"type": "json_schema", "name": "trip", "strict": True, "schema": SCHEMA}}})
if result.get("status") != "completed":
raise RuntimeError("响应尚未完成或已截断")
texts = []
for item in result.get("output", []):
for part in item.get("content", []):
if part.get("type") == "refusal":
raise RuntimeError(part.get("refusal", "请求未完成"))
if part.get("type") == "output_text":
texts.append(part["text"])
print(check_trip(json.loads("".join(texts))))
if __name__ == "__main__":
main()