cognis-core 0.2.1

Core traits and types for the Cognis LLM framework
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

//! Log stream tracer for streaming run logs.
//!
//! Mirrors Python `langchain_core.tracers.log_stream`.

use std::collections::HashMap;

use serde::{Deserialize, Serialize};
use serde_json::Value;

/// A single entry in the run log.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct LogEntry {
    /// The unique ID of this log entry's run.
    pub id: String,
    /// The name of the component.
    pub name: String,
    /// The type of run.
    pub run_type: String,
    /// Tags associated with this run.
    #[serde(default)]
    pub tags: Vec<String>,
    /// Metadata about the run.
    #[serde(default)]
    pub metadata: HashMap<String, Value>,
    /// Start time as ISO string.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub start_time: Option<String>,
    /// End time as ISO string.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub end_time: Option<String>,
    /// Streamed output chunks.
    #[serde(default)]
    pub streamed_output: Vec<Value>,
    /// Streamed output string (for LLM output).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub streamed_output_str: Option<Vec<String>>,
    /// Final output.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub final_output: Option<Value>,
}

/// The state of a run, containing all log entries.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct RunState {
    /// The unique ID of the root run.
    pub id: String,
    /// All streamed output from the root run.
    #[serde(default)]
    pub streamed_output: Vec<Value>,
    /// Final output of the root run.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub final_output: Option<Value>,
    /// Log entries for all nested runs, keyed by run name.
    #[serde(default)]
    pub logs: HashMap<String, LogEntry>,
    /// The name of the root runnable.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// The type of the root runnable.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub run_type: Option<String>,
}

/// A JSON Patch operation for incremental log updates.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct JsonPatchOp {
    /// The operation type: "add", "replace", "remove".
    pub op: String,
    /// The JSON Pointer path to the target location.
    pub path: String,
    /// The value for add/replace operations.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub value: Option<Value>,
}

/// A collection of JSON Patch operations representing an incremental update.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RunLogPatch {
    /// The list of patch operations.
    pub ops: Vec<JsonPatchOp>,
}

impl RunLogPatch {
    /// Create a new patch from a list of operations.
    pub fn new(ops: Vec<JsonPatchOp>) -> Self {
        Self { ops }
    }

    /// Create a patch that adds a new log entry.
    pub fn add_log_entry(name: &str, entry: &LogEntry) -> Self {
        Self::new(vec![JsonPatchOp {
            op: "add".to_string(),
            path: format!("/logs/{}", name),
            value: Some(serde_json::to_value(entry).unwrap_or_default()),
        }])
    }

    /// Create a patch that adds streamed output.
    pub fn add_streamed_output(index: usize, value: Value) -> Self {
        Self::new(vec![JsonPatchOp {
            op: "add".to_string(),
            path: format!("/streamed_output/{}", index),
            value: Some(value),
        }])
    }

    /// Create a patch that sets the final output.
    pub fn set_final_output(value: Value) -> Self {
        Self::new(vec![JsonPatchOp {
            op: "replace".to_string(),
            path: "/final_output".to_string(),
            value: Some(value),
        }])
    }
}