Skip to main content

StepResult

Struct StepResult 

Source
pub struct StepResult {
    pub step_number: u32,
    pub runtime_context: Option<JsonValue>,
    pub tools_context: Option<JsonValue>,
    pub model: ModelIdentity,
    pub content: Vec<StepContent>,
    pub finish_reason: FinishReason,
    pub usage: Usage,
    pub warnings: Vec<Warning>,
    pub request: StepRequest,
    pub response: StepResponse,
    pub provider_metadata: Option<ProviderMetadata>,
    pub performance: StepPerformance,
}
Expand description

The result of one step: a model call plus the tool executions it caused.

Fields§

§step_number: u32

Zero-based step index.

§runtime_context: Option<JsonValue>

Application state used for this step (never sent to the provider).

§tools_context: Option<JsonValue>

Shared tool context used for this step, before per-tool validation.

§model: ModelIdentity

Model that produced the step.

§content: Vec<StepContent>

Content parts in order.

§finish_reason: FinishReason

Why the model stopped.

§usage: Usage

Token usage of the model call.

§warnings: Vec<Warning>

Warnings produced by the adapter.

§request: StepRequest

Request metadata (body and messages when included).

§response: StepResponse

Response metadata and the messages to append to the history.

§provider_metadata: Option<ProviderMetadata>

Provider-specific metadata.

§performance: StepPerformance

Timing and throughput.

Implementations§

Source§

impl StepResult

Source

pub fn text(&self) -> String

Concatenates all text parts.

Source

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

Concatenates all reasoning parts, or None when there is none.

Source

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

Iterates over the tool calls of the step.

Source

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

Tool calls to tools of the static tool set.

Source

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

Tool calls to dynamic tools (including invalid calls).

Source

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

Iterates over the (final) tool results of the step.

Source

pub fn tool_errors(&self) -> impl Iterator<Item = &ToolExecutionError> + '_

Iterates over the tool errors of the step.

Source

pub fn tool_approval_requests( &self, ) -> impl Iterator<Item = &ToolApprovalRequestContent> + '_

Iterates over the approval requests of the step.

Source

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

Iterates over generated files.

Source

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

Iterates over citation sources.

Source

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

The messages to append to the conversation history.

Source

pub fn tool_result_as<T: DeserializeOwned>( &self, tool_name: &str, ) -> Result<Option<T>, Error>

Deserializes the output of the first final result of tool_name.

§Errors

Returns the deserialization error; Ok(None) when no such result exists.

Trait Implementations§

Source§

impl Clone for StepResult

Source§

fn clone(&self) -> StepResult

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 StepResult

Source§

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

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

impl<'de> Deserialize<'de> for StepResult

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 PartialEq for StepResult

Source§

fn eq(&self, other: &StepResult) -> 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 StepResult

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 StepResult

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more