llmrix-rust-sdk 1.0.0

Official Rust SDK for the llmrix AI Agent Platform API
Documentation 
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

use serde::Deserialize;
use std::collections::HashMap;

// ---------------------------------------------------------------------------
// Lifecycle
// ---------------------------------------------------------------------------

#[derive(Debug, Clone, Deserialize, Default)]
pub struct RunStartEvent {
    #[serde(default)]
    pub run_id: String,
    #[serde(default)]
    pub thread_id: String,
}

#[derive(Debug, Clone, Deserialize, Default)]
pub struct RunEndEvent {
    #[serde(default)]
    pub run_id: String,
    #[serde(default)]
    pub thread_id: String,
}

// ---------------------------------------------------------------------------
// Messages
// ---------------------------------------------------------------------------

/// Incremental text fragment from the assistant.
/// Concatenate successive `content` values to reconstruct the full message.
#[derive(Debug, Clone, Deserialize, Default)]
pub struct MessageChunkEvent {
    #[serde(default)]
    pub content: String,
    #[serde(default)]
    pub id: String,
}

// ---------------------------------------------------------------------------
// Tools
// ---------------------------------------------------------------------------

#[derive(Debug, Clone, Deserialize, Default)]
pub struct ToolStartEvent {
    #[serde(default)]
    pub id: String,
    #[serde(default)]
    pub name: String,
    #[serde(default)]
    pub args: HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Deserialize, Default)]
pub struct ToolEndEvent {
    #[serde(default)]
    pub id: String,
    #[serde(default)]
    pub name: String,
    #[serde(default)]
    pub result: String,
    #[serde(default)]
    pub error: bool,
}

#[derive(Debug, Clone, Deserialize, Default)]
pub struct SubagentStartEvent {
    #[serde(default)]
    pub id: String,
    #[serde(default)]
    pub agent_name: String,
}

#[derive(Debug, Clone, Deserialize, Default)]
pub struct SubagentEndEvent {
    #[serde(default)]
    pub id: String,
    #[serde(default)]
    pub agent_name: String,
    #[serde(default)]
    pub error: bool,
}

// ---------------------------------------------------------------------------
// HITL
// ---------------------------------------------------------------------------

/// Emitted when the agent pauses awaiting human approval.
/// Call `ChatResource::decide` to resume the run.
#[derive(Debug, Clone, Deserialize, Default)]
pub struct HitlInterruptEvent {
    #[serde(default)]
    pub id: String,
    #[serde(default)]
    pub action_name: String,
    #[serde(default)]
    pub action_args: HashMap<String, serde_json::Value>,
    #[serde(default)]
    pub description: String,
}

// ---------------------------------------------------------------------------
// Error / cancel
// ---------------------------------------------------------------------------

#[derive(Debug, Clone, Deserialize, Default)]
pub struct ErrorEvent {
    #[serde(default)]
    pub message: String,
    #[serde(default)]
    pub error_code: String,
}

#[derive(Debug, Clone, Deserialize, Default)]
pub struct CancelledEvent {
    #[serde(default)]
    pub reason: String,
}

// ---------------------------------------------------------------------------
// Heartbeat
// ---------------------------------------------------------------------------

/// Periodic keep-alive. Applications may safely ignore this variant.
#[derive(Debug, Clone, Default)]
pub struct HeartbeatEvent;

// ---------------------------------------------------------------------------
// Sealed sum type
// ---------------------------------------------------------------------------

/// All SSE event variants. Match on this enum to handle specific events:
///
/// ```rust,no_run
/// # use llmrix_rust_sdk::streaming::event::StreamEvent;
/// # let event = StreamEvent::Heartbeat;
/// match &event {
///     StreamEvent::MessageChunk(e) => print!("{}", e.content),
///     StreamEvent::RunEnd(_) => println!("\n[done]"),
///     _ => {}
/// }
/// ```
#[derive(Debug, Clone)]
pub enum StreamEvent {
    RunStart(RunStartEvent),
    RunEnd(RunEndEvent),
    MessageChunk(MessageChunkEvent),
    ToolStart(ToolStartEvent),
    ToolEnd(ToolEndEvent),
    SubagentStart(SubagentStartEvent),
    SubagentEnd(SubagentEndEvent),
    HitlInterrupt(HitlInterruptEvent),
    Error(ErrorEvent),
    Cancelled(CancelledEvent),
    Heartbeat,
}