Skip to main content

LanguageModelStreamPart

bitrouter_core::models::language::stream_part

Enum LanguageModelStreamPart

pub enum LanguageModelStreamPart {
Show 20 variants    TextStart {
        id: String,
        provider_metadata: Option<ProviderMetadata>,
    },
    TextDelta {
        id: String,
        delta: String,
        provider_metadata: Option<ProviderMetadata>,
    },
    TextEnd {
        id: String,
        provider_metadata: Option<ProviderMetadata>,
    },
    ReasoningStart {
        id: String,
        provider_metadata: Option<ProviderMetadata>,
    },
    ReasoningDelta {
        id: String,
        delta: String,
        provider_metadata: Option<ProviderMetadata>,
    },
    ReasoningEnd {
        id: String,
        provider_metadata: Option<ProviderMetadata>,
    },
    ToolInputStart {
        id: String,
        tool_name: String,
        provider_executed: Option<bool>,
        dynamic: Option<bool>,
        title: Option<String>,
        provider_metadata: Option<ProviderMetadata>,
    },
    ToolInputDelta {
        id: String,
        delta: String,
        provider_metadata: Option<ProviderMetadata>,
    },
    ToolInputEnd {
        id: String,
        provider_metadata: Option<ProviderMetadata>,
    },
    File {
        data: Vec<u8>,
        media_type: String,
        provider_metadata: Option<ProviderMetadata>,
    },
    ToolApprovalRequest {
        approval_id: String,
        tool_call_id: String,
        provider_metadata: Option<ProviderMetadata>,
    },
    UrlSource {
        id: String,
        url: String,
        title: Option<String>,
        provider_metadata: Option<ProviderMetadata>,
    },
    DocumentSource {
        id: String,
        media_type: String,
        title: String,
        filename: Option<String>,
        provider_metadata: Option<ProviderMetadata>,
    },
    ToolCall {
        tool_call_id: String,
        tool_name: String,
        tool_input: String,
        provider_executed: Option<bool>,
        dynamic: Option<bool>,
        provider_metadata: Option<ProviderMetadata>,
    },
    ToolResult {
        tool_call_id: String,
        tool_name: String,
        result: JsonValue,
        is_error: Option<bool>,
        preliminary: Option<bool>,
        dynamic: Option<bool>,
        provider_metadata: Option<ProviderMetadata>,
    },
    StreamStart {
        warnings: Vec<Warning>,
    },
    ResponseMetadata {
        id: Option<String>,
        timestamp: Option<TimestampMillis>,
        model_id: Option<String>,
    },
    Finish {
        usage: LanguageModelUsage,
        finish_reason: LanguageModelFinishReason,
        provider_metadata: Option<ProviderMetadata>,
    },
    Raw {
        raw_value: JsonValue,
    },
    Error {
        error: JsonValue,
    },
}

Expand description

Represents a part of a streaming response from a language model provider.

Variants§

TextStart

Fields

§id: String

§provider_metadata: Option<ProviderMetadata>

TextDelta

Fields

§id: String

§delta: String

§provider_metadata: Option<ProviderMetadata>

TextEnd

Fields

§id: String

§provider_metadata: Option<ProviderMetadata>

ReasoningStart

Fields

§id: String

§provider_metadata: Option<ProviderMetadata>

ReasoningDelta

Fields

§id: String

§delta: String

§provider_metadata: Option<ProviderMetadata>

ReasoningEnd

Fields

§id: String

§provider_metadata: Option<ProviderMetadata>

ToolInputStart

Fields

§id: String

§tool_name: String

§provider_executed: Option<bool>

§dynamic: Option<bool>

§title: Option<String>

§provider_metadata: Option<ProviderMetadata>

ToolInputDelta

Fields

§id: String

§delta: String

§provider_metadata: Option<ProviderMetadata>

ToolInputEnd

Fields

§id: String

§provider_metadata: Option<ProviderMetadata>

File

type: “file”

Fields

§data: Vec<u8>

The file data as bytes

§media_type: String

The IANA media type

§provider_metadata: Option<ProviderMetadata>

Provider-specific metadata

ToolApprovalRequest

type: “tool-approval-request”

Fields

§approval_id: String

The approval ID

§tool_call_id: String

The tool call ID

§provider_metadata: Option<ProviderMetadata>

Provider-specific metadata

UrlSource

type: “url-source”

Fields

§id: String

The URL source ID

§url: String

The URL

§title: Option<String>

The title of the URL content, if available

§provider_metadata: Option<ProviderMetadata>

Provider-specific metadata

DocumentSource

type: “document-source”

Fields

§id: String

The document source ID

§media_type: String

The IANA media type

§title: String

The title of the document

§filename: Option<String>

The filename of the document, if available

§provider_metadata: Option<ProviderMetadata>

Provider-specific metadata

ToolCall

type: “tool-call”

Fields

§tool_call_id: String

The tool call ID

§tool_name: String

The tool name

§tool_input: String

The stringified tool input

§provider_executed: Option<bool>

Whether the tool call was executed by the provider

§dynamic: Option<bool>

Whether the tool call is defined at runtime

§provider_metadata: Option<ProviderMetadata>

Provider-specific metadata

ToolResult

type: “tool-result”

Fields

§tool_call_id: String

The tool call ID

§tool_name: String

The tool name

§result: JsonValue

The tool result content

§is_error: Option<bool>

Optional flag if the result is an error

§preliminary: Option<bool>

Preliminary tool results replace each other, e.g. image previews. There always has to be a final, non-preliminary tool result.

§dynamic: Option<bool>

Whether the tool call is defined at runtime

§provider_metadata: Option<ProviderMetadata>

Provider-specific metadata

StreamStart

Fields

§warnings: Vec<Warning>

ResponseMetadata

Fields

§id: Option<String>

§timestamp: Option<TimestampMillis>

§model_id: Option<String>

Finish

Fields

§usage: LanguageModelUsage

§finish_reason: LanguageModelFinishReason

§provider_metadata: Option<ProviderMetadata>

Raw

Fields

§raw_value: JsonValue

Error

Fields

§error: JsonValue

Trait Implementations§

impl Clone for LanguageModelStreamPart

fn clone(&self) -> LanguageModelStreamPart

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for LanguageModelStreamPart

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for LanguageModelStreamPart

impl RefUnwindSafe for LanguageModelStreamPart

impl Send for LanguageModelStreamPart

impl Sync for LanguageModelStreamPart

impl Unpin for LanguageModelStreamPart

impl UnsafeUnpin for LanguageModelStreamPart

impl UnwindSafe for LanguageModelStreamPart

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V