umf 0.2.6

Universal Message Format (UMF) - Provider-agnostic message representation for LLM interactions with ChatML formatting, internal hub model, and MCP support
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

//! Event trait definitions

use serde::{Deserialize, Serialize};

/// Event type discriminator
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum EventType {
    /// A message in the conversation
    Message,
    /// A tool call request
    ToolCall,
    /// A tool execution result
    ToolResult,
    /// System signal (e.g., session start/end)
    SystemSignal,
    /// An error event
    Error,
}

impl EventType {
    /// Convert to string representation
    pub fn as_str(&self) -> &str {
        match self {
            Self::Message => "message",
            Self::ToolCall => "tool_call",
            Self::ToolResult => "tool_result",
            Self::SystemSignal => "system_signal",
            Self::Error => "error",
        }
    }
}

impl std::fmt::Display for EventType {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.as_str())
    }
}

/// Base event trait for all conversation events
pub trait Event: Send + Sync {
    /// Get the unique event ID
    fn event_id(&self) -> &str;

    /// Get the event type
    fn event_type(&self) -> EventType;

    /// Get the session ID this event belongs to
    fn session_id(&self) -> &str;

    /// Get the event timestamp (Unix milliseconds)
    fn timestamp_ms(&self) -> u64;

    /// Get the sequence number (for ordering within session)
    fn sequence(&self) -> u32;

    /// Serialize to JSON value
    fn to_json(&self) -> serde_json::Value;
}