Skip to main content

ModelOutputItem

Enum ModelOutputItem 

Source
pub enum ModelOutputItem {
    Content(ContentPart),
    ReasoningSummary(TextContent),
    ToolCall(Box<ModelToolCallProposal>),
}
Expand description

One item in provider order from a model response.

Content and summaries must be marked untrusted. Inline text and JSON use a model source; artifact references retain their artifact source. These invariants are rechecked by ModelResponse even for directly constructed enum variants.

Variants§

§

Content(ContentPart)

User-visible model output content.

§

ReasoningSummary(TextContent)

Provider-supplied readable reasoning summary.

§

ToolCall(Box<ModelToolCallProposal>)

Complete, unapproved tool-call proposal.

Implementations§

Source§

impl ModelOutputItem

Source

pub fn content(content: ContentPart) -> Result<Self, ModelOutputItemError>

Constructs model output content with strict source and trust metadata.

§Errors

Returns ModelOutputItemError for invalid source or trust metadata.

Source

pub fn reasoning_summary( summary: TextContent, ) -> Result<Self, ModelOutputItemError>

Constructs a readable reasoning summary with strict model metadata.

§Errors

Returns ModelOutputItemError for invalid source or trust metadata.

Source

pub fn tool_call(proposal: ModelToolCallProposal) -> Self

Constructs an ordered tool-call proposal item.

Source

pub const fn kind(&self) -> ModelOutputItemKind

Returns the closed item classification.

Source

pub const fn as_content(&self) -> Option<&ContentPart>

Returns user-visible content when this is a content item.

Source

pub const fn as_reasoning_summary(&self) -> Option<&TextContent>

Returns readable reasoning text when this is a summary item.

Source

pub const fn as_tool_call(&self) -> Option<&ModelToolCallProposal>

Returns the unapproved proposal when this is a tool-call item.

Trait Implementations§

Source§

impl Clone for ModelOutputItem

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 ModelOutputItem

Source§

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

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

impl<'de> Deserialize<'de> for ModelOutputItem

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 ModelOutputItem

Source§

impl JsonSchema for ModelOutputItem

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 ModelOutputItem

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 ModelOutputItem

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 ModelOutputItem

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.