llmkit-core 0.1.0

Core traits, types, and errors for llmkit-rs — no I/O, runtime-agnostic
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

//! Streaming response types.

use std::pin::Pin;

use futures_core::Stream;

use crate::error::LlmResult;
use crate::usage::TokenUsage;

/// A boxed async stream of [`StreamDelta`] items, the unified streaming output
/// across every provider.
pub type ChatStream = Pin<Box<dyn Stream<Item = LlmResult<StreamDelta>> + Send>>;

/// One incremental event in a streaming chat response.
#[derive(Debug, Clone, PartialEq)]
pub enum StreamDelta {
    /// A chunk of generated text.
    Text(String),
    /// A streamed tool call (arguments may arrive incrementally).
    ToolCall {
        /// Provider-assigned tool call id, if known yet.
        id: Option<String>,
        /// Tool name, if known yet.
        name: Option<String>,
        /// Partial JSON arguments for this delta.
        input_delta: String,
    },
    /// Terminal event carrying final usage.
    Done {
        /// Final token usage.
        usage: TokenUsage,
    },
}