Enum SseMessageEvent

pub enum SseMessageEvent {
    Message {
        base: Option<MessageBase>,
        id: String,
        task_id: String,
        answer: String,
        extra: HashMap<String, Value>,
    },
    MessageFile {
        base: Option<MessageBase>,
        id: String,
        type_: FileType,
        belongs_to: BelongsTo,
        url: String,
        extra: HashMap<String, Value>,
    },
    MessageEnd {
        base: Option<MessageBase>,
        id: String,
        task_id: String,
        metadata: HashMap<String, Value>,
        extra: HashMap<String, Value>,
    },
    MessageReplace {
        base: Option<MessageBase>,
        task_id: String,
        answer: String,
        extra: HashMap<String, Value>,
    },
    WorkflowStarted {
        base: Option<MessageBase>,
        task_id: String,
        workflow_run_id: String,
        data: WorkflowStartedData,
        extra: HashMap<String, Value>,
    },
    NodeStarted {
        base: Option<MessageBase>,
        task_id: String,
        workflow_run_id: String,
        data: NodeStartedData,
        extra: HashMap<String, Value>,
    },
    NodeFinished {
        base: Option<MessageBase>,
        task_id: String,
        workflow_run_id: String,
        data: NodeFinishedData,
        extra: HashMap<String, Value>,
    },
    WorkflowFinished {
        base: Option<MessageBase>,
        task_id: String,
        workflow_run_id: String,
        data: WorkflowFinishedData,
        extra: HashMap<String, Value>,
    },
    AgentMessage {
        base: Option<MessageBase>,
        id: String,
        task_id: String,
        answer: String,
        extra: HashMap<String, Value>,
    },
    AgentThought {
        base: Option<MessageBase>,
        id: String,
        task_id: String,
        position: u32,
        thought: String,
        observation: String,
        tool: String,
        tool_labels: Value,
        tool_input: String,
        message_files: Vec<String>,
    },
    Error {
        base: Option<MessageBase>,
        status: u32,
        code: String,
        message: String,
        extra: HashMap<String, Value>,
    },
    Ping,
}

流式模式分块数据事件

Variants

Message

LLM 返回文本块事件，即：完整的文本以分块的方式输出。

Fields

base: Option<MessageBase>

消息基础信息

id: String

消息 ID

task_id: String

任务 ID，用于请求跟踪和下方的停止响应接口

answer: String

LLM 返回文本块内容

extra: HashMap<String, Value>

MessageFile

文件事件，表示有新文件需要展示

Fields

base: Option<MessageBase>

消息基础信息

id: String

文件唯一 ID

type_: FileType

文件类型，目前仅为 image

belongs_to: BelongsTo

文件归属，user 或 assistant，该接口返回仅为 assistant

url: String

文件访问地址

extra: HashMap<String, Value>

MessageEnd

消息结束事件，收到此事件则代表流式返回结束。

Fields

base: Option<MessageBase>

消息基础信息

id: String

消息 ID

task_id: String

任务 ID，用于请求跟踪和下方的停止响应接口

metadata: HashMap<String, Value>

元数据

extra: HashMap<String, Value>

MessageReplace

消息内容替换事件
开启内容审查和审查输出内容时，若命中了审查条件，则会通过此事件替换消息内容为预设回复。

Fields

base: Option<MessageBase>

消息基础信息

task_id: String

任务 ID，用于请求跟踪和下方的停止响应接口

answer: String

替换内容（直接替换 LLM 所有回复文本）

extra: HashMap<String, Value>

WorkflowStarted

workflow 开始执行

Fields

base: Option<MessageBase>

消息基础信息

task_id: String

任务 ID，用于请求跟踪和下方的停止响应接口

workflow_run_id: String

workflow 执行 ID

data: WorkflowStartedData

workflow 详细内容

extra: HashMap<String, Value>

NodeStarted

node 执行开始

Fields

base: Option<MessageBase>

消息基础信息

task_id: String

任务 ID，用于请求跟踪和下方的停止响应接口

workflow_run_id: String

workflow 执行 ID

data: NodeStartedData

node 详细内容

extra: HashMap<String, Value>

NodeFinished

node 执行结束, 成功失败同一事件中不同状态

Fields

base: Option<MessageBase>

消息基础信息

task_id: String

任务 ID，用于请求跟踪和下方的停止响应接口

workflow_run_id: String

workflow 执行 ID

data: NodeFinishedData

node 执行结束详细内容

extra: HashMap<String, Value>

WorkflowFinished

workflow 执行结束，成功失败同一事件中不同状态

Fields

base: Option<MessageBase>

消息基础信息

task_id: String

任务 ID，用于请求跟踪和下方的停止响应接口

workflow_run_id: String

workflow 执行 ID

data: WorkflowFinishedData

workflow 详细内容

extra: HashMap<String, Value>

AgentMessage

Agent模式下返回文本块事件，即：在Agent模式下，文章的文本以分块的方式输出（仅Agent模式下使用）

Fields

base: Option<MessageBase>

消息基础信息

id: String

消息 ID

task_id: String

任务 ID，用于请求跟踪和下方的停止响应接口

answer: String

LLM 返回文本块内容

extra: HashMap<String, Value>

AgentThought

Agent模式下有关Agent思考步骤的相关内容，涉及到工具调用（仅Agent模式下使用）

Fields

base: Option<MessageBase>

消息基础信息

id: String

消息 ID

task_id: String

任务 ID，用于请求跟踪和下方的停止响应接口

position: u32

agent_thought在消息中的位置，如第一轮迭代position为1

thought: String

agent的思考内容

observation: String

工具调用的返回结果

tool: String

使用的工具列表，以 ; 分割多个工具

tool_labels: Value

工具的标签

tool_input: String

工具的输入，JSON格式的字符串

message_files: Vec<String>

当前 agent_thought 关联的文件ID

Error

流式输出过程中出现的异常会以 stream event 形式输出，收到异常事件后即结束。

Fields

base: Option<MessageBase>

消息基础信息

status: u32

HTTP 状态码

code: String

错误码

message: String

错误消息

extra: HashMap<String, Value>

Ping

Trait Implementations

impl Clone for SseMessageEvent

fn clone(&self) -> SseMessageEvent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SseMessageEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SseMessageEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SseMessageEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.