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
impl ModelOutputItem
Sourcepub fn content(content: ContentPart) -> Result<Self, ModelOutputItemError>
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.
Sourcepub fn reasoning_summary(
summary: TextContent,
) -> Result<Self, ModelOutputItemError>
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.
Sourcepub fn tool_call(proposal: ModelToolCallProposal) -> Self
pub fn tool_call(proposal: ModelToolCallProposal) -> Self
Constructs an ordered tool-call proposal item.
Sourcepub const fn kind(&self) -> ModelOutputItemKind
pub const fn kind(&self) -> ModelOutputItemKind
Returns the closed item classification.
Sourcepub const fn as_content(&self) -> Option<&ContentPart>
pub const fn as_content(&self) -> Option<&ContentPart>
Returns user-visible content when this is a content item.
Sourcepub const fn as_reasoning_summary(&self) -> Option<&TextContent>
pub const fn as_reasoning_summary(&self) -> Option<&TextContent>
Returns readable reasoning text when this is a summary item.
Sourcepub const fn as_tool_call(&self) -> Option<&ModelToolCallProposal>
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
impl Clone for ModelOutputItem
Source§impl Debug for ModelOutputItem
impl Debug for ModelOutputItem
Source§impl<'de> Deserialize<'de> for ModelOutputItem
impl<'de> Deserialize<'de> for ModelOutputItem
Source§fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
impl Eq for ModelOutputItem
Source§impl JsonSchema for ModelOutputItem
impl JsonSchema for ModelOutputItem
Source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Source§fn inline_schema() -> bool
fn inline_schema() -> bool
$ref keyword. Read more