切换语言

运行步骤
试用版

表示运行期间执行的步骤 （模型和工具调用）。source

相关指南： 助手source

列出运行步骤
试用版

获取 https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}/steps

返回属于运行的运行步骤列表。source

路径参数

thread_id

字符串source

必填

run 和 run steps 所属的线程的 ID。source

run_id

字符串source

必填

运行步骤所属的运行的 ID。source

查询参数

限制

整数source

可选
默认为 20

要返回的对象数量限制。Limit 的范围可以介于 1 和 100 之间，默认值为 20。source

次序

字符串source

可选
默认为 desc

按created_at对象的时间戳。asc对于升序和desc以降序排列。source

后

字符串source

可选

用于分页的游标。after是定义您在列表中的位置的对象 ID。例如，如果您发出列表请求并收到 100 个对象，以 obj_foo 结尾，则您的后续调用可以包含 after=obj_foo 以便获取列表的下一页。source

以前

字符串source

可选

用于分页的游标。before是定义您在列表中的位置的对象 ID。例如，如果您发出一个列表请求并收到 100 个对象，以 obj_foo 开头，则您的后续调用可以包含 before=obj_foo 以便获取列表的上一页。source

include[]

数组source

可选

要包含在响应中的其他字段的列表。目前唯一支持的值是step_details.tool_calls[*].file_search.results[*].content以获取文件搜索结果内容。source

有关更多信息，请参阅文件搜索工具文档。source

返回

运行步骤对象的列表。source

示例请求
1
2
3
4
curl https://api.openai.com/v1/threads/thread_abc123/runs/run_abc123/steps \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "Content-Type: application/json" \
  -H "OpenAI-Beta: assistants=v2"
响应
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
{
  "object": "list",
  "data": [
    {
      "id": "step_abc123",
      "object": "thread.run.step",
      "created_at": 1699063291,
      "run_id": "run_abc123",
      "assistant_id": "asst_abc123",
      "thread_id": "thread_abc123",
      "type": "message_creation",
      "status": "completed",
      "cancelled_at": null,
      "completed_at": 1699063291,
      "expired_at": null,
      "failed_at": null,
      "last_error": null,
      "step_details": {
        "type": "message_creation",
        "message_creation": {
          "message_id": "msg_abc123"
        }
      },
      "usage": {
        "prompt_tokens": 123,
        "completion_tokens": 456,
        "total_tokens": 579
      }
    }
  ],
  "first_id": "step_abc123",
  "last_id": "step_abc456",
  "has_more": false
}

检索运行步骤
试用版

获取 https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}/steps/{step_id}

检索运行步骤。source

路径参数

thread_id

字符串source

必填

run 和 run step 所属的线程的 ID。source

run_id

字符串source

必填

运行步骤所属的运行的 ID。source

step_id

字符串source

必填

要检索的运行步骤的 ID。source

查询参数

include[]

数组source

可选

要包含在响应中的其他字段的列表。目前唯一支持的值是step_details.tool_calls[*].file_search.results[*].content以获取文件搜索结果内容。source

有关更多信息，请参阅文件搜索工具文档。source

返回

与指定 ID 匹配的 run step 对象。source

示例请求
1
2
3
4
curl https://api.openai.com/v1/threads/thread_abc123/runs/run_abc123/steps/step_abc123 \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "Content-Type: application/json" \
  -H "OpenAI-Beta: assistants=v2"
响应
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
  "id": "step_abc123",
  "object": "thread.run.step",
  "created_at": 1699063291,
  "run_id": "run_abc123",
  "assistant_id": "asst_abc123",
  "thread_id": "thread_abc123",
  "type": "message_creation",
  "status": "completed",
  "cancelled_at": null,
  "completed_at": 1699063291,
  "expired_at": null,
  "failed_at": null,
  "last_error": null,
  "step_details": {
    "type": "message_creation",
    "message_creation": {
      "message_id": "msg_abc123"
    }
  },
  "usage": {
    "prompt_tokens": 123,
    "completion_tokens": 456,
    "total_tokens": 579
  }
}

run step 对象
试用版

表示执行运行的步骤。source

身份证

字符串source

运行步骤的标识符，可在 API 终端节点中引用。source

对象

字符串source

对象类型，始终为thread.run.step.source

created_at

整数source

创建运行步骤时的 Unix 时间戳（以秒为单位）。source

assistant_id

字符串source

与运行步骤关联的助手的 ID。source

thread_id

字符串source

运行的线程的 ID。source

run_id

字符串source

此运行步骤所属的运行的 ID。source

类型

字符串source

运行步骤的类型，可以是message_creation或tool_calls.source

地位

字符串source

运行步骤的状态，可以是in_progress,cancelled,failed,completed或expired.source

step_details

对象source

run 步骤的详细信息。source

last_error

object 或 nullsource

与此运行步骤关联的最后一个错误。将是null如果没有错误。source

expired_at

整数或 nullsource

运行步骤过期时的 Unix 时间戳（以秒为单位）。如果父运行已过期，则认为步骤已过期。source

cancelled_at

整数或 nullsource

取消运行步骤时的 Unix 时间戳（以秒为单位）。source

failed_at

整数或 nullsource

运行步骤失败时的 Unix 时间戳（以秒为单位）。source

completed_at

整数或 nullsource

运行步骤完成时的 Unix 时间戳（以秒为单位）。source

元数据

地图source

一组 16 个可附加到对象的键值对。这对于以结构化格式存储有关对象的其他信息非常有用。键的长度最大为 64 个字符，值的长度最大为 512 个字符。source

用法

object 或 nullsource

与 run 步骤相关的使用情况统计信息。该值将为null当 Run Step 的 Status （运行步骤） 为in_progress.source

OBJECT 运行步骤对象
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
  "id": "step_abc123",
  "object": "thread.run.step",
  "created_at": 1699063291,
  "run_id": "run_abc123",
  "assistant_id": "asst_abc123",
  "thread_id": "thread_abc123",
  "type": "message_creation",
  "status": "completed",
  "cancelled_at": null,
  "completed_at": 1699063291,
  "expired_at": null,
  "failed_at": null,
  "last_error": null,
  "step_details": {
    "type": "message_creation",
    "message_creation": {
      "message_id": "msg_abc123"
    }
  },
  "usage": {
    "prompt_tokens": 123,
    "completion_tokens": 456,
    "total_tokens": 579
  }
}