流式获取异步应用运行的事件消息 - ListRunEvents

DataArtsPlatform:application:getRunEvents

Read

-

-

-

-

project_id

是

String

参数解释：

项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

小写字母和数字组成的32位十六进制字符，例如：ff8080817d30ff7b017d3213ba600001。

默认取值：

不涉及。

application_id

是

String

参数解释：

应用ID，应用的唯一标识，可以通过应用开发控制台或应用查询接口获取。

约束限制：

不涉及。

取值范围：

标准的 UUID 格式，即由连字符（-）分隔的 32 位十六进制字符，格式为 8-4-4-4-12，例如：fc078dfc-b2da-4052-8aad-4c67c4302264。

默认取值：

不涉及。

run_id

是

String

参数解释：

运行ID，用于唯一标识一次运行，通过运行应用相关接口生成并返回。

约束限制：

不涉及。

取值范围：

标准的 UUID 格式，即由连字符（-）分隔的 32 位十六进制字符，格式为 8-4-4-4-12，例如：59e2e4ed-ad2c-44ec-a52f-5ba8295e68eb。

默认取值：

不涉及。

stop_mode

否

String

参数解释：

结束模式，用于指定本次SSE请求什么时候结束。

说明：不管哪种模式，当本次请求在由timeout指定的时间内未收到运行消息，则会超时结束SSE请求。

约束限制：

不涉及。

取值范围：

• NEVER：不会主动结束请求。

• INTERACT：当收到交互消息时结束请求。

• FINISHED：当收到应用运行结束消息时结束请求。

• BOTH：当收到交互或运行结束消息时结束请求。

默认取值：

BOTH。

timeout

否

Integer

参数解释：

超时时间，单位秒，在该时间内无新的消息，则结束SSE。

约束限制：

不涉及。

取值范围：

0-30。

默认取值：

10。

next_key

否

String

参数解释：

下一条信息的开始标记，由服务端返回：messages接口里的next_key或events消息里的ID，用于指定从哪条消息开始获取消息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Workspace-Id

是

String

参数解释：

工作空间ID。

获取方法请参见获取项目ID，例如：6280b8733aea43a2a0799c55aeeb0e68。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

id

String

参数解释：

当前消息的消息ID。

取值范围：

不涉及。

event

String

参数解释：

事件类型。

取值范围：

• workflow_started：应用开始执行。

• workflow_finished：应用执行结束。

• node_started：节点开始执行。

• node_finished：节点执行结束。

• loop_started：循环开始执行。

• loop_finished：循环执行结束。

• llm_started：大模型开始执行。

• llm_finished：大模型执行结束。

• tool_started：工具开始执行。

• tool_finished：工具执行结束。

• message：消息。

type

String

参数解释：

当event为message时，消息的类型，即content里内容是什么。

取值范围：

• text: 纯文本消息。

• tool: 工具运行信息。

• interact：交互问答。

• params：参数。

• sub_workflow：子工作流的运行消息。

• status：状态的消息，比如节点或任务推理消息的开始，结束等。

content

String

参数解释：

事件消息的内容。

取值范围：

不涉及。

data

Object

参数解释：

非消息事件的数据，通常为节点或应用运行状态信息，如节点开/结束时的状态，可能包括状态、输入输出、起止时间等。

取值范围：

不涉及。

is_finished

Boolean

参数解释：

标记是否运行结束。

取值范围：

• true：运行结束。

• false：运行未结束。

message_id

String

参数解释：

运行消息ID，由系统生成。应用的一次运行会生成一个消息ID。因应用可能涉及交互问答，同一次运行可能涉及多次交互，因此会产生不同的消息ID。

取值范围：

标准的 UUID 格式，即由连字符（-）分隔的 32 位十六进制字符，格式为 8-4-4-4-12，例如：2c1f93a2-cfc3-4799-abae-bda8edf36d7f。

node_parent_run_id

String

参数解释：

节点的父运行ID。

取值范围：

标准的 UUID 格式，即由连字符（-）分隔的 32 位十六进制字符，格式为 8-4-4-4-12，例如：451f93a2-cfc3-4799-abae-bda8edf36d33。

node_run_id

String

参数解释：

节点的运行ID。

取值范围：

标准的 UUID 格式，即由连字符（-）分隔的 32 位十六进制字符，格式为 8-4-4-4-12，例如：42a1f931-cfc3-4799-abae-bda8edf36dfa。

parent_run_id

String

参数解释：

父运行ID，当前运行的父运行ID的唯一标识，通常出现在子应用中。

取值范围：

标准的 UUID 格式，即由连字符（-）分隔的 32 位十六进制字符，格式为 8-4-4-4-12，例如：67s1f93a-cfc3-4799-abae-bda8edf36d9f。

role

String

参数解释：

角色。

取值范围：

• user：用户。

• assistant：助手。

• system：系统。

run_id

String

参数解释：

运行ID，用于唯一标识一次运行。

取值范围：

标准的 UUID 格式，即由连字符（-）分隔的 32 位十六进制字符，格式为 8-4-4-4-12，例如：2c1f93a2-cfc3-4799-abae-bda8edf36d7f。

session_id

String

参数解释：

会话ID，单次会话的唯一标识。

取值范围：

标准的 UUID 格式，即由连字符（-）分隔的 32 位十六进制字符，格式为 8-4-4-4-12，例如：2350bb6e-7f05-40d6-b65f-2cf0d3fde0a2。

version

String

参数解释：

当前应用运行的应用版本。

取值范围：

不涉及。

200

流式获取应用运行事件消息成功响应。