Oapi接口文档
  1. 运行(Runs)
Oapi接口文档
  • 介绍
  • 项目说明
  • 导言
  • 身份验证
  • 发出请求
  • 参数详情
  • oapi专属接口
    • 返回价格列表
      GET
    • 模型厂家接口
      GET
    • 获取指定日期使用量
      GET
    • 获取可使用模型
      GET
    • Gemini原生接口
      POST
    • Claude原生接口
      POST
  • 聊天(Chat)
    • 聊天完成对象
    • 聊天完成块对象
    • 创建聊天补全
      POST
  • 音频(Audio)
    • 创建语音
      GET
    • 创建转录
      GET
    • 创建翻译
      GET
  • 自动补全(Completions)
    • 完成对象
    • 创建完成
  • 嵌入(Embeddings)
    • 嵌入对象
    • 创建嵌入
  • 微调(Fine-tuning)
    • 微调作业对象
    • 微调作业事件对象
    • 创建微调作业
    • 列出微调作业
    • 检索微调作业
    • 取消微调
    • 列出微调事件
  • 图像(Images)
    • README
    • 图像对象
    • 创建图像
    • 创建图片编辑
    • 创建图像变体
  • 模型(Models)
    • 模型对象
    • 列出模型
    • 检索模型
    • 删除微调模型
  • 文件(Files)
    • README
    • 文件对象
    • 上传文件
    • 删除文件
    • 检索文件
    • 检索文件内容
    • 列出文件
  • 审查(Moderations)
    • 调节对象
    • 创建内容审核
  • 助手测试版(AssistantsBeta)
    • 辅助对象
    • 辅助文件对象
    • 创建助手
    • 检索助手
    • 修改助手
    • 删除助手
    • 列出助手
    • 创建辅助文件
    • 检索助手文件
    • 删除辅助文件
    • 列出助手文件
  • 线程数(Threads)
    • 线程对象
    • 创建线程
    • 检索线程
    • 修改线程
    • 删除话题
  • 留言(Messages)
    • 消息对象
    • 消息文件对象
    • 创建消息
    • 检索消息
    • 修改留言
    • 列出消息
    • 检索消息文件
    • 列出消息文件
  • 运行(Runs)
    • 运行对象
    • 运行步骤对象
    • 创建运行
      POST
    • 检索运行
      GET
    • 修改运行
      GET
    • 列表运行
      GET
    • 提交工具输出以运行
      POST
    • 取消运行
      POST
    • 创建线程并运行
      POST
    • 检索运行步骤
      GET
    • 列出运行步骤
      GET
  • 已弃用-音频(Audio)
    • 创建转录
    • 创建翻译
  1. 运行(Runs)

提交工具输出以运行

开发中
POST
/v1/threads/{thread_id}/runs/{run_id}/submit_tool_outputs
当运行具有status: "requires_action"和required_action.typeis时submit_tool_outputs,此端点可用于在工具调用全部完成后提交输出。所有输出必须在单个请求中提交。
与指定 ID 匹配的修改后的运行对象。

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
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"
    }
  ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://oapi.czl.net/v1/threads//runs//submit_tool_outputs' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tool_outputs": [
      {
        "tool_call_id": "call_MbELIQcB72cq35Yzo2MRw5qs",
        "output": "28C"
      }
    ]
  }'

返回响应

🟢200成功
application/json
Body
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": {}
}
修改于 2024-01-08 06:38:13
上一页
列表运行
下一页
取消运行
Built with