Skip to main content

ModelEventKind

Enum ModelEventKind 

Source
pub enum ModelEventKind {
    Started {
        provenance: ModelResponseProvenance,
    },
    OutputStarted {
        output_index: ExecutionCount,
        start: Box<ModelOutputStart>,
    },
    OutputDelta {
        output_index: ExecutionCount,
        delta: ModelOutputDelta,
    },
    OutputCompleted {
        output_index: ExecutionCount,
    },
    UsageUpdated {
        usage: ModelUsage,
    },
    Completed {
        finish_reason: ModelFinishReason,
        usage: ModelUsage,
        extensions: Extensions,
    },
}
Expand description

Closed semantic body of a provider-neutral model event.

Variants§

§

Started

Opens one attempt stream and fixes response provenance.

Fields

§provenance: ModelResponseProvenance

Attempt and exact model identity plus optional provider correlation IDs.

§

OutputStarted

Registers the next ordered output item and its immutable header.

Fields

§output_index: ExecutionCount

Zero-based final-response output position.

§start: Box<ModelOutputStart>

Typed output header.

§

OutputDelta

Appends an exact fragment to an active output item.

Fields

§output_index: ExecutionCount

Previously registered output position.

§delta: ModelOutputDelta

Typed non-empty fragment.

§

OutputCompleted

Closes and validates one active output item.

Fields

§output_index: ExecutionCount

Previously registered output position.

§

UsageUpdated

Reports a complete cumulative usage snapshot observed so far.

Fields

§usage: ModelUsage

Inclusive, normalized, monotonic per-attempt token accounting.

§

Completed

Terminates the stream and supplies authoritative final accounting.

Fields

§finish_reason: ModelFinishReason

Portable successful or incomplete terminal reason.

§usage: ModelUsage

Authoritative inclusive token accounting for the whole attempt.

§extensions: Extensions

Bounded registered provider/adapter terminal metadata.

Trait Implementations§

Source§

impl Clone for ModelEventKind

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ModelEventKind

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ModelEventKind

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for ModelEventKind

Source§

impl JsonSchema for ModelEventKind

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for ModelEventKind

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for ModelEventKind

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ModelEventKind

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.