MiniMax
  1. Run Step
MiniMax
  • 公告通知
  • 产品定价
  • 概述
  • FAQ
  • 大模型介绍
    • 文本大模型
    • 语音大模型
  • 接入说明
    • 新手指南
    • 速率说明
  • 开发指南
    • 快速开始
  • 文本大模型接口
    • ChatCompletion Pro(对话)
      • 概述
      • ChatCompletion Pro API 文档
        • ChatCompletion Pro API
        • 示例对话功能
        • 限制返回格式功能(glyph)
        • 函数调用功能(function calling)
        • 插件功能(plugins)
        • 知识库检索功能(retrieval)
    • ChatCompletion(对话)
      • 概述
      • ChatCompletion 快速接入
      • ChatCompletion 调优指南
      • ChatCompletion API 文档
        • ChatCompletion API
        • 知识库检索功能(retrieval)
  • Assistants 接口
    • Assistants 操作指南
    • Assistans API 文档
      • Assistant
        • 创建 Assistant
        • 检索 Assistants
        • 删除 assistant
        • 查看 assistant 列表
      • Assistant File
        • 创建 assistant 文件
        • 检索 assistant 关联的文件
        • 列出 assistant 文件
      • Thread
        • 创建 thread
        • 检索 thread
      • Message
        • 创建 message
        • 检索 message
        • message 列表
      • Run
        • 创建 run
        • 检索 run
        • 列表 run
        • Submit tool outputs to run
      • Run Step
        • 检索 run step
          GET
        • 列表 run step
          GET
  • File(文档)
    • File(文档)
      GET
    • Upload 接口
      GET
    • Retrieve 接口
      GET
    • Delete 接口
      POST
    • RetrieveContent 接口
      GET
  • Retrieval(知识库检索)
    • 新建知识库
    • 删除知识库
    • 查看知识库详情
    • 查看知识库列表
    • 增加知识库文档
    • 删除知识库文档
    • 修改知识库文档
    • 查看知识库文档
    • 检索 Chatcompletion
    • 检索 Chatcompletion pro
  • 微调
    • Finetune 操作指南
    • Finetune API文档
      • 创建微调任务
      • 列出微调任务
      • 检索微调任务
      • 删除微调任务
      • 列出微调事件
      • 列举微调模型
      • 查询微调模型
      • 删除微调模型
  • 向量化
    • Embeddings(向量化)
  • 语音大模型接口
    • T2A (语音生成)
      • T2A 快速接入
      • T2A API 接口
        • T2A API接口
        • 字典功能(Dictionary)
    • T2A pro(长文本语音生成)
      • T2A Pro 快速接入
      • T2A Pro API 接口
      • 字典功能(Dictionary)
    • T2A large(异步超长文本语音生成)
      • T2A Large 快速接入
      • T2A Large API 接口
        • T2A Large API 接口
        • 字典功能(Dictionary)
    • T2A Stream(流式语音生成)
      • T2A Stream(流式语音生成)
      • 字典功能(Dictionary)
    • 快速复刻(Voice Cloning)
      • 上传文件
      • 音频复刻
  • 有声内容创作
    • Role Classification (文本角色分类)
      • 创建并异步运行角色识别任务
      • 查询角色识别任务
    • Role Audio Generation (角色音频生成)
      • 角色音频生成
  1. Run Step

列表 run step

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
GET
/v1/threads/run_steps/list

您可以在此object下进行对run step的操作,包括检索、列出列表行为,object如下:

参数类型含义
idstringRun 步骤 id
objectstring对象:run step
created_atint64创建时间戳
run_idstringRun id
assistant_idstringassistantid
thread_idstringthreadid
typestring类型
statusstring状态
cancelled_atint64取消时间戳
completed_atint64完成时间戳
expired_atint64过期时间戳
failed_atint64失败时间戳
last_errormap<string,string>错误信息
step_detailsStepDetails步骤详情
  • StepDetails 结构
参数类型含义
typestring取值message_creation或者tool_calls
message_creationobject创建message的详细信息
message_creation.message_idstring当前Step所创建message的ID
tool_callslist工具调用的详细信息
tool_calls[0].typestring包含code_interpreterweb_searchretrievalfunction
tool_calls[0].code_interpreterCodeInterpreter当工具调用为code_interpreter时显示
tool_calls[0].web_searchWebSearch当工具调用为web_search时显示
tool_calls[0].retrievalRetrieval当工具调用为retrieval时显示
tool_calls[0].functionFunction当工具调用为function时显示

Code Interpreter结构

参数类型含义
idstringtool ID
typestring类型
code_interpreterobject
code_interpreter.inputstringCode interpreter输入
code_interpreter.outputsobjectCode interpreter输出

Web Search结构

参数类型含义
idstringtool ID
typestring类型
web_searchobject
web_search.querystring搜索问题
web_search.outputsstring搜索结果

Retrieval结构

参数类型含义
idstringtool ID
typestring类型
retrievalobject
retrieval.querystring检索问题
retrieval.outputsstring检索结果

Function结构

参数类型含义
idstringtool ID
typestring类型
functionobject
function.namestring函数名称
function.argumentsstring函数参数
function.outputstring函数结果

您可以通过此项操作列出已创建的Run的运行步骤的列表。

请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'http://dev-cn.your-api-server.com/v1/threads/run_steps/list?GroupId=${GroupId}' \
--header 'Authorization: Bearer ${API_KEY}' \
--header 'Content-Type: application/json' \
--data-raw '{
"thread_id": "$Thread_Id",
"run_id": "$Run_Id"
}'
响应示例响应示例
{
  "object": "list",
  "data": [
    {
      "id": "step_abc123",
      "object": "thread.run.step",
      "created_at": 1703318061,
      "run_id": "run_abc123",
      "assistant_id": "asst_abc123",
      "thread_id": "thread_abc123",
      "type": "tool_calls",
      "status": "completed",
      "step_details": {
        "type": "tool_calls",
        "tool_calls": [
          {
            "id": "call_abc123",
            "type": "web_search",
            "web_search": {
              "name": "get_web_search_result",
              "arguments": "{\"search_query\": \"明天 天气\"}",
              "output": "[{\"no\":1,\"content\":\"气象公报 更多. 12月22日20时:交通气象预报. 中国气象局与交通运输部2023年12月22日联合发布全国主要公路气象预报. 12月22日18时:天气公报. 我国中东部大部地区气温持续偏低. 12月22日08时:每日天气提示. 山东文登积雪深度达74厘米 未来三天全国雨雪稀少气温 ...\"},{\"no\":2,\"content\":\"明天 12/23 多云 -9~0° 周日 12/24 晴 -9~1° 周一 12/25 晴 -6~2° 周二 12/26 多云 -8~4° 周三 12/27 晴 -8~3° 周四 12/28 晴\"},{\"no\":3,\"content\":\"全国气象干旱综合监测 土壤水分监测 热带气旋监测公报. 官方权威发布天气预报,逐三小时天气预报,提供天气预报查询一周,天气预报15天查询,天气预报40天查询,天气资讯,空气质量,生活指数,旅游出行,交通天气等查询服务.\"},{\"no\":4,\"content\":\"明天. 城市 雷达 云图. 北京 [定制] 01:30更新. -13. 降水量 0mm. 西北风 微风. 相对湿度 62%. 今夜. 12/21.\"},{\"no\":5,\"content\":\"中国气象局-天气预报-城市预报. -8.6. 1034hPa. 23%. 0mm. 西北风 3级.\"},{\"no\":6,\"content\":\"明天预报 明天省份表 明天城市列表 后天预报 后天省份表 后天城市列表 7天预报 7天预报省份表 7天预报城市列表 10天预报 10天预报省份列表 10天预报城市列表 15天预报 15天预报省份列表 15天预报城市列表 空气指数 空气指数省份列表 空气指数城市列表 pm2.5\"},{\"no\":7,\"content\":\"今日天气、明日天气和未来几天的气象报告,并且为用户提供穿衣指数、生活指数、健康指数、交通指数、旅游指数,及各类天气预报资讯。 全国天气网\"},{\"no\":8,\"content\":\"中国气象局-天气预报-城市预报. 国内. 上海. 上海. 2023/12/22 07:05更新. -5℃. 1043hPa. 46%. 0mm.\"},{\"no\":9,\"content\":\"中国气象局-天气预报-城市预报. 2023/12/23 05:20更新. -4℃. 1015hPa. 45%. 0mm. 东南风 微风.\"},{\"no\":10,\"content\":\"中国气象局-天气预报-城市预报. 国内. 上海. 南汇. 2023/12/22 06:45更新. -5.1℃. 1042hPa. 50%. 0mm.\"}]"
            }
          }
        ]
      },
      "base_resp": {}
    }
  ],
  "base_resp": {
    "status_code": 0,
    "status_msg": "success"
  }
}

请求参数

Query 参数
GroupId
string 
必需
示例值:
${GroupId}
Header 参数
Authorization
string 
必需
示例值:
Bearer ${API_KEY}
Content-Type
string 
必需
示例值:
application/json
Body 参数application/json
thread_id
string 
必需
run_id
string 
必需
示例

返回响应

🟢200成功
application/json
Body
object
string 
必需
对象:run step object
data
array [object {10}] 
Run步骤列表
必需
id
string 
可选
object
string 
可选
created_at
integer 
可选
run_id
string 
可选
assistant_id
string 
可选
thread_id
string 
可选
type
string 
可选
status
string 
可选
step_details
object 
可选
base_resp
object 
可选
base_resp
object 
必需
status_code+status_message
status_code
integer 
必需
status_msg
string 
必需
上一页
检索 run step
下一页
File(文档)
Built with