流式处理 (v1)
Legacy

流式传输执行 Run 的结果或在提交工具输出后恢复 Run。source

您可以从 Create Thread 和 Run (运行)、Create Run (创建运行) 和 Submit Tool Outputs (提交工具输出) 终端节点流式传输事件,方法是将"stream": true.响应将是 Server-Sent 事件流。source

我们的 Node 和 Python SDK 提供了有用的实用程序,使流式传输变得容易。请参阅 Assistants API 快速入门以了解更多信息。source

消息 delta 对象 (v1)
Legacy

表示消息增量,即流式处理期间消息上的任何更改字段。source

消息的标识符,可在 API 端点中引用。source

对象类型,始终为thread.message.delta.source

包含 Message 上已更改的字段的增量。source

OBJECT 消息 delta 对象 (v1)
1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "id": "msg_123",
  "object": "thread.message.delta",
  "delta": {
    "content": [
      {
        "index": 0,
        "type": "text",
        "text": { "value": "Hello", "annotations": [] }
      }
    ]
  }
}

运行步骤 delta 对象 (v1)
Legacy

表示运行步骤增量,即流式处理期间运行步骤上任何更改的字段。source

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

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

包含在 run 步骤中已更改的字段的 delta。source

OBJECT 运行步骤 delta 对象 (v1)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "id": "step_123",
  "object": "thread.run.step.delta",
  "delta": {
    "step_details": {
      "type": "tool_calls",
      "tool_calls": [
        {
          "index": 0,
          "id": "call_123",
          "type": "code_interpreter",
          "code_interpreter": { "input": "", "outputs": [] }
        }
      ]
    }
  }
}

Assistant 流事件 (v1)
Legacy

表示流式传输 Run 时发出的事件。source

服务器发送的事件流中的每个事件都有一个eventdata财产:source

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

每当创建新对象、转换到新状态或正在 分部分流式传输 (delta)。例如,我们发出thread.run.created当新运行 创建时,thread.run.completed运行完成时间,依此类推。当 Assistant 选择 为了在运行期间创建消息,我们发出一个thread.message.created event一个thread.message.in_progress事件,许多thread.message.delta事件,最后是thread.message.completed事件。source

随着时间的推移,我们可能会添加其他事件,因此我们建议妥善处理未知事件 在你的代码中。请参阅 Assistants API 快速入门,了解如何 将 Assistants API 与流式处理集成。source

在创建新线程时发生。source

在创建新运行时发生。source

运行移动到queued地位。source

运行移动到in_progress地位。source

运行移动到requires_action地位。source

运行完成时发生。source

运行失败时发生。source

运行移动到cancelling地位。source

在取消运行时发生。source

运行过期时发生。source

在创建运行步骤时发生。source

运行步骤移动到in_progress州。source

在流式传输运行步骤的某些部分时发生。source

在运行步骤完成时发生。source

运行步骤失败时发生。source

在取消运行步骤时发生。source

运行步骤过期时发生。source

在创建消息时发生。source

邮件移动到in_progress州。source

在流式传输 Message 的某些部分时发生。source

消息完成时发生。source

消息在完成之前结束时出现。source

发生错误时回调。这可能是由于内部服务器错误或超时而发生的。source

在流结束时发生。source