Struct GenerateTextResult 

pub struct GenerateTextResult<O> {
    pub steps: Vec<StepResult>,
    pub total_usage: Usage,
    pub output: O,
}

Result of a completed generation loop.

Fields

steps: Vec<StepResult>

All steps in order (at least one).

total_usage: Usage

Usage summed over all steps.

output: O

The structured output (() when none was requested).

Implementations

impl<O> GenerateTextResult<O>

pub fn last_step(&self) -> &StepResult

The final step.

Panics

Panics if callers manually construct or mutate a result with no steps. Generation loops always record at least one step before returning a result.

pub fn text(&self) -> String

Text of the final step.

pub fn reasoning_text(&self) -> Option<String>

Reasoning text of the final step.

pub fn finish_reason(&self) -> &FinishReason

Finish reason of the final step.

pub fn usage(&self) -> &Usage

Token usage summed over every step.

Use last_step().usage for the final model call alone.

pub fn provider_metadata(&self) -> Option<&ProviderMetadata>

Provider metadata of the final step.

pub fn warnings(&self) -> Vec<&Warning>

Warnings from every step in generation order.

pub fn content(&self) -> impl Iterator<Item = &StepContent>

Iterates over content from every step in generation order.

pub fn files(&self) -> impl Iterator<Item = &GeneratedFile>

Iterates over files generated in every step.

pub fn sources(&self) -> impl Iterator<Item = &Source>

Iterates over citation sources from every step.

pub fn tool_calls(&self) -> impl Iterator<Item = &ParsedToolCall>

Iterates over parsed tool calls from every step.

pub fn static_tool_calls(&self) -> impl Iterator<Item = &ParsedToolCall>

Iterates over static tool calls from every step.

pub fn dynamic_tool_calls(&self) -> impl Iterator<Item = &ParsedToolCall>

Iterates over dynamic tool calls from every step.

pub fn tool_results(&self) -> impl Iterator<Item = &ToolResult>

Iterates over final tool results from every step.

pub fn static_tool_results(&self) -> impl Iterator<Item = &ToolResult>

Iterates over static tool results from every step.

pub fn dynamic_tool_results(&self) -> impl Iterator<Item = &ToolResult>

Iterates over dynamic tool results from every step.

pub fn final_step(&self) -> &StepResult

The final step, using the reference SDK’s naming.

pub fn raw_finish_reason(&self) -> Option<&str>

The provider’s unnormalized finish reason from the final step.

pub fn request(&self) -> &StepRequest

Request metadata from the final step.

pub fn response(&self) -> &StepResponse

Response metadata and messages from the final step.

pub fn response_messages(&self) -> Vec<Message>

Messages of all steps, ready to append to the conversation history.

pub fn map_output<P>(self, f: impl FnOnce(O) -> P) -> GenerateTextResult<P>

Maps the output.

Trait Implementations

impl<O: Clone> Clone for GenerateTextResult<O>

fn clone(&self) -> GenerateTextResult<O>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<O: Debug> Debug for GenerateTextResult<O>

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

Formats the value using the given formatter.

impl<O: PartialEq> PartialEq for GenerateTextResult<O>

fn eq(&self, other: &GenerateTextResult<O>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<O: PartialEq> StructuralPartialEq for GenerateTextResult<O>