Skip to main content

ModelOutputStart

Enum ModelOutputStart 

Source
pub enum ModelOutputStart {
    Text {
        language: Option<LanguageTag>,
        metadata: ContentMetadata,
    },
    Json {
        schema: Option<SchemaReference>,
        metadata: ContentMetadata,
    },
    Artifact(Box<ArtifactRef>),
    ReasoningSummary {
        language: Option<LanguageTag>,
        metadata: ContentMetadata,
    },
    ToolCall {
        tool: CapabilityIdentity,
        provider_call_id: Option<ModelProviderToolCallId>,
        extensions: Extensions,
    },
}
Expand description

Header that fixes the type and immutable metadata of one streamed output.

Text, JSON, reasoning, and tool arguments arrive through subsequent deltas. Artifact bytes never cross this boundary: an artifact start carries only a complete immutable ArtifactRef.

Variants§

§

Text

User-visible text header.

Fields

§language: Option<LanguageTag>

Optional stable language tag for the completed text.

§metadata: ContentMetadata

Mandatory model-source, untrusted security metadata.

§

Json

Structured JSON header.

Fields

§schema: Option<SchemaReference>

Optional digest-pinned schema identity asserted for the completed value.

§metadata: ContentMetadata

Mandatory model-source, untrusted security metadata.

§

Artifact(Box<ArtifactRef>)

Complete immutable artifact reference; no inline deltas are accepted.

§

ReasoningSummary

Human-readable reasoning-summary header, never hidden chain of thought.

Fields

§language: Option<LanguageTag>

Optional stable language tag for the completed summary.

§metadata: ContentMetadata

Mandatory model-source, untrusted security metadata.

§

ToolCall

Complete identity header for an unapproved model tool-call proposal.

Fields

§tool: CapabilityIdentity

Exact requested, owner-qualified tool identity.

§provider_call_id: Option<ModelProviderToolCallId>

Optional opaque provider correlation identifier.

§extensions: Extensions

Registered bounded proposal extensions.

Implementations§

Source§

impl ModelOutputStart

Source

pub fn text( language: Option<LanguageTag>, metadata: ContentMetadata, ) -> Result<Self, ModelOutputItemError>

Constructs a validated user-visible text header.

Source

pub fn json( schema: Option<SchemaReference>, metadata: ContentMetadata, ) -> Result<Self, ModelOutputItemError>

Constructs a validated structured JSON header.

Source

pub fn artifact(artifact: ArtifactRef) -> Result<Self, ModelOutputItemError>

Constructs a validated immutable artifact header.

Source

pub fn reasoning_summary( language: Option<LanguageTag>, metadata: ContentMetadata, ) -> Result<Self, ModelOutputItemError>

Constructs a validated readable reasoning-summary header.

Source

pub fn tool_call( tool: CapabilityIdentity, provider_call_id: Option<ModelProviderToolCallId>, extensions: Extensions, ) -> Self

Constructs a tool-call header whose arguments will arrive as JSON deltas.

Source

pub const fn kind(&self) -> ModelOutputItemKind

Returns the final response-item classification.

Source

pub const fn delta_kind(&self) -> Option<ModelOutputDeltaKind>

Returns the only accepted delta classification, or None for artifacts.

Trait Implementations§

Source§

impl Clone for ModelOutputStart

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 ModelOutputStart

Source§

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

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

impl<'de> Deserialize<'de> for ModelOutputStart

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 ModelOutputStart

Source§

impl JsonSchema for ModelOutputStart

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 ModelOutputStart

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 ModelOutputStart

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 ModelOutputStart

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.