serdes-ai-core 0.2.6

Core types, messages, and error handling for serdes-ai
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

//! # serdes-ai-core
//!
//! Core types, messages, and error handling for the serdes-ai framework.
//!
//! This crate provides the foundational types used throughout the serdes-ai ecosystem:
//!
//! - **Messages**: Request/response message types for LLM interactions
//! - **Errors**: Comprehensive error types with context
//! - **Usage**: Token usage tracking and limits
//! - **Settings**: Model configuration options
//! - **Identifiers**: Type-safe IDs for conversations, messages, runs
//!
//! ## Feature Flags
//!
//! - `tracing-integration`: Enable tracing instrumentation
//! - `otel`: Enable OpenTelemetry integration
//! - `full`: Enable all optional features
//!
//! ## Example
//!
//! ```rust
//! use serdes_ai_core::{
//!     messages::{ModelRequest, ModelResponse, UserContent},
//!     usage::{RequestUsage, RunUsage, UsageLimits},
//!     settings::ModelSettings,
//!     identifier::{generate_run_id, now_utc},
//! };
//!
//! // Build a request
//! let mut request = ModelRequest::new();
//! request.add_system_prompt("You are a helpful assistant.");
//! request.add_user_prompt("Hello!");
//!
//! // Configure settings
//! let settings = ModelSettings::new()
//!     .max_tokens(1000)
//!     .temperature(0.7);
//!
//! // Track usage
//! let mut usage = RunUsage::new();
//! usage.add_request(RequestUsage::with_tokens(100, 50));
//!
//! // Check limits
//! let limits = UsageLimits::new().max_total_tokens(10000);
//! limits.check(&usage).expect("Within limits");
//! ```

#![warn(missing_docs)]
#![warn(rustdoc::missing_crate_level_docs)]
#![deny(unsafe_code)]
#![cfg_attr(docsrs, feature(doc_cfg))]

pub mod errors;
pub mod format;
pub mod identifier;
pub mod messages;
pub mod settings;
pub mod usage;

// Re-exports for convenience
pub use errors::{Result, SerdesAiError};
pub use format::{format_as_xml, format_as_xml_with_options, XmlFormatError, XmlFormatOptions};
pub use identifier::{now_utc, ConversationId, RunId, ToolCallId};
pub use messages::{
    BinaryContent,
    // Builtin tools (web search, code execution, file search)
    BuiltinToolCallPart,
    BuiltinToolReturnContent,
    BuiltinToolReturnPart,
    CodeExecutionResult,
    // File and binary content
    FilePart,
    FileSearchResult,
    FileSearchResults,
    FinishReason,
    // Core request/response
    ModelRequest,
    ModelRequestPart,
    ModelResponse,
    ModelResponsePart,
    ModelResponsePartDelta,
    // Streaming events
    ModelResponseStreamEvent,
    PartDeltaEvent,
    PartEndEvent,
    PartStartEvent,
    SystemPromptPart,
    // Text and thinking
    TextPart,
    ThinkingPart,
    // Tool calls and returns
    ToolCallPart,
    ToolReturnPart,
    UserContent,
    UserContentPart,
    UserPromptPart,
    WebSearchResult,
    WebSearchResults,
};
pub use settings::ModelSettings;
pub use usage::{RequestUsage, RunUsage, UsageLimits};

/// Prelude module for common imports.
///
/// ```rust
/// use serdes_ai_core::prelude::*;
/// ```
pub mod prelude {
    pub use crate::errors::{Result, SerdesAiError};
    pub use crate::format::{format_as_xml, format_as_xml_with_options, XmlFormatOptions};
    pub use crate::identifier::{
        generate_run_id, generate_tool_call_id, now_utc, ConversationId, RunId, ToolCallId,
    };
    pub use crate::messages::{
        BinaryContent,
        // Builtin tools
        BuiltinToolCallPart,
        BuiltinToolReturnContent,
        BuiltinToolReturnPart,
        CodeExecutionResult,
        // File and binary content
        FilePart,
        FileSearchResult,
        FileSearchResults,
        // Core request/response
        FinishReason,
        ModelRequest,
        ModelRequestPart,
        ModelResponse,
        ModelResponsePart,
        ModelResponsePartDelta,
        // Streaming
        ModelResponseStreamEvent,
        SystemPromptPart,
        TextPart,
        ThinkingPart,
        ToolCallArgs,
        ToolCallPart,
        ToolReturnPart,
        UserContent,
        UserContentPart,
        UserPromptPart,
        WebSearchResult,
        WebSearchResults,
    };
    pub use crate::settings::ModelSettings;
    pub use crate::usage::{RequestUsage, RunUsage, UsageLimits};
}