提交工具输出以运行
POST
https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}/submit_tool_outputs当运行具有status: "requires_action"
和required_action.type
is时submit_tool_outputs
,此端点可用于在工具调用全部完成后提交输出。所有输出必须在单个请求中提交。
与指定 ID 匹配的修改后的运行对象。
请求参数
Path 参数
thread_id
string
必需
此运行所属线程的 ID 。
run_id
string
必需
需要提交工具输出的运行的 ID。
Body 参数application/json
tool_outputs
array [object {2}]
必需
为其提交输出的工具列表。
tool_call_id
string
可选
required_action正在提交输出的运行对象内的对象中的工具调用的 ID 。
output
string
可选
要提交以继续运行的工具调用的输出。
示例
{
"tool_outputs": [
{
"tool_call_id": "call_MbELIQcB72cq35Yzo2MRw5qs",
"output": "28C"
}
]
}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
id
string
必需
object
string
必需
created_at
integer
必需
assistant_id
string
必需
thread_id
string
必需
status
string
必需
started_at
integer
必需
expires_at
integer
必需
cancelled_at
null
必需
failed_at
null
必需
completed_at
null
必需
last_error
null
必需
model
string
必需
instructions
string
必需
tools
array [object {2}]
必需
type
string
可选
function
object
可选
file_ids
array[string]
必需
metadata
object
必需
示例
{
"id": "run_PHLyHQYIQn4F7JrSXslEYWwh",
"object": "thread.run",
"created_at": 1699075592,
"assistant_id": "asst_IgmpQTah3ZfPHCVZjTqAY8Kv",
"thread_id": "thread_EdR8UvCDJ035LFEJZMt3AxCd",
"status": "queued",
"started_at": 1699075592,
"expires_at": 1699076192,
"cancelled_at": null,
"failed_at": null,
"completed_at": null,
"last_error": null,
"model": "gpt-4",
"instructions": "You tell the weather.",
"tools": [
{
"type": "function",
"function": {
"name": "get_weather",
"description": "Determine weather in my location",
"parameters": {
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "The city and state e.g. San Francisco, CA"
},
"unit": {
"type": "string",
"enum": [
"c",
"f"
]
}
},
"required": [
"location"
]
}
}
}
],
"file_ids": [],
"metadata": {}
}
修改于 10 个月前