会话线程
列出、中断和归档多智能体会话的线程,读取其事件,并跨线程处理工具权限。
在多智能体会话中,每个智能体都在自己的 "session thread"(会话线程) 中工作。本页介绍如何列出、中断和归档线程,线程发送的事件,以及工具权限如何跨线程运作。工作流运行也会创建会话线程。
主线程和会话线程
会话级事件流(/v1/sessions/{session_id}/events/stream)被视为 "primary thread"(主线程),其中包含所有线程中全部活动的精简视图。您看不到子智能体的完整活动,但可以看到其工作的开始和结束,以及工具权限请求等阻塞事件。
会话线程是您深入查看特定智能体活动的地方。
会话 status 是所有智能体活动的汇总;如果至少有一个线程处于 running 状态,则整个会话状态也为 running。正在运行的工作流运行也可以使会话保持 running,即使其线程都没有在工作。当没有线程在工作且某个线程正在等待您的客户端时,会话为 idle;请参阅了解工作何时完成。
会话预算是会话所有线程共享的单一上限。达到上限时,各线程会独立暂停,每个线程的成本按该线程自身所用的模型计价。
列出线程
按如下方式列出与会话关联的所有线程:
for thread in client.beta.sessions.threads.list(session.id):
agent = thread.agent
label = agent.type if agent.type == "advisor" else agent.name
print(f"[{label}] {thread.status}")完整列表包含主线程。主线程的 parent_thread_id 为 null。其他每个线程都是子线程。除运行的线程外,workflow_run_id 均为 null。
要仅列出具有特定状态的线程,请在请求中添加 statuses[],并重复该参数以指定多个状态,例如 ?statuses[]=running&statuses[]=idle。省略该参数则返回所有状态的线程。
中断会话线程
发送带有 session_thread_id 的 user.interrupt 以停止特定线程。省略 session_thread_id 会中断会话中所有未归档的线程,包括主线程。在使用动态工作流的会话中,中断不会结束任何运行,而指定某个运行线程的中断不会停止任何内容。中断会关闭其他子线程的待处理工具调用,但不要依赖它来关闭运行线程的待处理工具调用。请参阅在有打开的运行时中断会话。
client.beta.sessions.events.send(
session.id,
events=[{"type": "user.interrupt", "session_thread_id": thread.id}],
)对于阻塞在 requires_action 上的子智能体的线程,中断会以错误工具结果("Tool execution was interrupted before completion. Please retry.")关闭每个待处理的工具调用,并直接重新发出带有 stop_reason: end_turn 的 session.thread_status_idle;不会对模型进行采样。对于以 end_turn 或 budget_reached 处于空闲状态的子线程,中断不执行任何操作。指定已终止线程的中断会返回 400 错误。被中断的子线程不会向主线程的智能体发送其在轮次结束时通常发送的报告。当该智能体等待子线程时,在有其他内容到达之前(例如 user.message 或另一个线程的报告),它不会开始新的轮次。
归档会话线程
会话线程完成工作后,您可以选择将其归档。归档线程会释放其在 25 个子线程限制中占用的名额。服务器会自行归档工作流运行的线程。您无需归档它们,并且在运行处于打开状态时也无法归档。
archived = client.beta.sessions.threads.archive(thread.id, session_id=session.id)
print(archived.status, archived.archived_at)只有当线程处于 idle 状态时,归档才会成功。停留在 requires_action 上的线程视为空闲,可以直接归档;只有正在运行的线程必须先中断:
client.beta.sessions.events.send(
session.id,
events=[{"type": "user.interrupt", "session_thread_id": thread.id}],
)
archived = client.beta.sessions.threads.archive(thread.id, session_id=session.id)
print(archived.status, archived.archived_at)主线程事件
这些事件在 /v1/sessions/{session_id}/events/stream 的主线程上呈现多智能体活动。消息方向类事件的命名是相对于其所在流的线程而言的:agent.thread_message_received 表示有消息从另一个线程到达此线程,agent.thread_message_sent 表示此线程发送了一条消息。例如,主线程的智能体委派的任务会以 agent.thread_message_received 事件的形式到达子线程自己的流。
| 类型 | 描述 |
|---|---|
session.thread_created | 创建了一个线程。包含 session_thread_id 和 agent_name。 |
session.thread_status_running | 某个线程开始活动。 |
session.thread_status_idle | 与该线程关联的智能体正在等待输入。包含一个 stop_reason,指示智能体停止的原因。 |
session.thread_status_terminated | 某个线程已终止且不再接受任何输入,例如因为它已被归档或遇到了不可恢复的错误。顾问线程在其咨询结束时也会终止。 |
agent.thread_message_received | 在主线程上,子智能体向主线程的智能体发送了报告或问题。包含 from_session_thread_id、from_agent_name 和 content。 |
agent.thread_message_sent | 在主线程上,主线程的智能体向子智能体发送了任务或后续消息。包含 to_session_thread_id、to_agent_name 和 content。 |
顾问咨询会以保留名称 anthropic.advisor 发出这些相同的线程事件(在线程生命周期事件中作为 agent_name,在建议传递中作为 from_agent_name);有关事件顺序,请参阅为会话配置顾问。
工作流运行的线程在主事件流上的呈现方式如下:
- 生命周期事件: 每个运行线程都会发送带有该运行
workflow_run_id的session.thread_created,以及其session.thread_status_running、session.thread_status_idle和session.thread_status_terminated事件。 - 消息事件: 运行线程的提示(一个
agent.thread_message_received事件)保留在其自己的流上。 - 运行事件:
workflow_run.*事件也会到达此流;请参阅运行事件。 - 等待您处理的工具调用: 与任何子线程一样,运行线程中需要您的客户端处理的工具调用会被交叉发布到此流。请参阅工具权限和自定义工具。
会话线程事件
关键事件会被代理转发到主线程。不过,您可能仍希望调查特定智能体的推理和工具调用。为此,请对关联的会话线程的事件进行流式传输或列出。
每个会话线程在 /v1/sessions/{session_id}/threads/{thread_id}/stream 都有自己的事件流,并且它接受与会话级流相同的 event_deltas[] 参数,因此您可以在模型生成子智能体文本时预览该文本。一个连接只预览它正在读取的线程:子线程的预览永远不会出现在会话级流上,因此要实时观察子智能体,请打开其自己的线程流。有关选择启用、累积和协调预览的信息,请参阅预览会话线程事件。
在工作流运行中,服务器运行一个工作流:即由主线程的智能体编写的程序。在运行的每个线程上,第一个 agent.thread_message_received 是工作流编写的提示。其 from_session_thread_id 是主线程的 ID,并且它没有 from_agent_name。API 不保证提示的文本内容,因此请勿解析它。主线程流上该线程的 session.thread_status_terminated 事件会告诉您该线程已完成。没有任何事件记录它返回给工作流的结果。
线程的流不会重放较早的事件。在 session.thread_created 之后立即查看时,运行线程的事件列表可能为空,因为服务器在此之后才写入该线程的第一个事件。因此,请先打开线程的流,然后列出线程的事件,并跳过 id 已由列表返回的每个流式事件。
with client.beta.sessions.threads.events.stream(
thread.id,
session_id=session.id,
) as stream:
for event in stream:
match event.type:
case "agent.message":
for block in event.content:
if block.type == "text":
print(block.text, end="")
case "session.thread_status_idle":
break列出所有过去的会话线程事件以获取完整历史记录。
for event in client.beta.sessions.threads.events.list(
thread.id,
session_id=session.id,
):
print(f"[{event.type}] {event.processed_at}")工具权限和自定义工具
如果子智能体需要从您的客户端获取某些内容,例如运行工具调用的权限或自定义工具的结果,该事件会被交叉发布到主线程,并带有标识来源会话线程的 session_thread_id。在 always_ask 下,或在 auto 下服务器未能作出判定时,工具调用需要您的许可。
{
"type": "session.thread_status_idle",
"id": "sevt_01ABC...",
"session_thread_id": "sthr_01DEF...",
"agent_name": "code-reviewer",
"stop_reason": {
"type": "requires_action",
"event_ids": ["sevt_01XYZ..."]
}
}发布 user.tool_confirmation(带有 tool_use_id)或 user.custom_tool_result(带有 custom_tool_use_id);服务器会自动将响应路由到正确的线程。该响应可能以不同的 id 值同时出现在主线程和子智能体的线程上。要匹配这两个副本,请比较 type 和 tool_use_id(或 custom_tool_use_id),而不是 id。
只有当没有线程处于 running 状态时,会话才会变为 idle,因此 session.status_idle 可能在子智能体发起调用很久之后才到达。您不必等待它:一旦交叉发布的 agent.custom_tool_use 事件到达,就立即发送 user.custom_tool_result。
在 auto 下,您的 user.message 事件可能使服务器允许原本会拒绝的调用。子智能体线程中的任何内容都不算作您的意图。您的客户端不会在那里发布消息,而主线程的智能体发送给子智能体的消息也不算数。当服务器在 auto 下拒绝某个调用时,不会交叉发布任何内容:该事件和错误工具结果只出现在子智能体自己的线程流上,并且子智能体会继续运行。
以下示例位于工具确认处理程序的事件循环内。对于 stop_reason.event_ids 中的每个 ID,它都会发送一个允许该调用的 user.tool_confirmation。同样的模式也适用于 user.custom_tool_result。
for event_id in stop.event_ids:
client.beta.sessions.events.send(
session.id,
events=[
{
"type": "user.tool_confirmation",
"tool_use_id": event_id,
"result": "allow",
}
],
)上述模式响应的是空闲事件所列出的调用。在主事件流上,子智能体的 session.thread_status_idle 事件可能会先于其 stop_reason.event_ids 所列出的 agent.tool_use 或 agent.mcp_tool_use 事件到达。针对事件尚未到达的调用发送 user.tool_confirmation 可能会返回 400。为避免这种情况,请在每个 evaluated_permission 为 ask 的调用自身的事件到达主事件流时再对其作出响应。
Was this page helpful?