Skip to main content

CompletionCall

Struct CompletionCall 

Source
pub struct CompletionCall {
    pub call_index: usize,
    pub usage: Usage,
    pub message_id: Option<String>,
    pub response_id: Option<String>,
    pub provider_request_id: Option<String>,
    pub finish_reason: Option<FinishReason>,
    pub raw: Value,
}
Expand description

Details for one successfully completed completion request made by an agent run.

Fields§

§call_index: usize

Zero-based index of the completion request within this agent run.

§usage: Usage

Token usage reported for this completion request.

Zero-valued usage is Usage’s documented sentinel for missing provider usage metrics; rig does not distinguish “reported all zeros” from “unreported”.

§message_id: Option<String>

Provider-assigned assistant message ID for this call, when reported.

§response_id: Option<String>

Provider-assigned response-scoped ID for this call, when reported.

§provider_request_id: Option<String>

The provider’s transport request id for this call (HTTP response header, e.g. Anthropic request-id) — the id provider support asks for. None means the provider did not report one, never an error.

§finish_reason: Option<FinishReason>

Why the model stopped generating on this call, when the provider reported it. None means the provider reported no reason.

Recorded per call rather than once per run: a multi-turn run makes N completion requests, each with its own terminal reason, and collapsing them to a single run-level value would lose exactly the information that makes a truncated turn diagnosable — which turn hit the limit. A caller that wants the run’s last reason reads it off the final entry.

This is the field whose absence hid rig#2322: the provider layer carried FinishReason::Length on the stream’s terminal record, but the agent assembler dropped it, so a turn truncated at the output-token limit was indistinguishable from a turn that simply had nothing to say.

§raw: Value

The provider’s own response for this call — see CompletionResponse::raw for the exact meaning of the payload. Every provider seam populates it; Value::Null only when the call’s response was built without a provider behind it (a hand-constructed model, a record persisted before the field, or a hand-driven AgentRun that recorded a streamed call with no terminal record — the runner itself rejects such a stream as truncated before recording anything).

Recorded per call, like Self::finish_reason: on a multi-turn run each entry carries its own attempt’s response, never a previous attempt’s, and on a retried turn the recorded call carries the retried attempt’s own.

Implementations§

Source§

impl CompletionCall

Source

pub fn new(call_index: usize, usage: Usage) -> Self

Create details for one completion request in an agent run; identity metadata starts unset and is attached with Self::with_identity.

Source

pub fn with_raw(self, raw: Value) -> Self

Attach the provider’s own response this call’s attempt produced.

Source

pub fn with_identity(self, identity: ResponseIdentity) -> Self

Attach the response identity metadata this call’s attempt reported.

Source

pub fn with_finish_reason(self, finish_reason: Option<FinishReason>) -> Self

Attach the terminal finish reason this call’s attempt reported.

Kept separate from Self::with_identity because a finish reason is not identity: ResponseIdentity answers “which response was this”, while this answers “why did it stop”.

Source

pub fn identity(&self) -> ResponseIdentity

This call’s identity metadata as one ResponseIdentity carrier.

Trait Implementations§

Source§

impl Clone for CompletionCall

Source§

fn clone(&self) -> CompletionCall

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 CompletionCall

Source§

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

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

impl<'de> Deserialize<'de> for CompletionCall

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 CompletionCall

Source§

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

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 CompletionCall

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

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> CloneableStorage for T
where T: Any + Send + Sync + Clone,

Source§

impl<T> DebuggableStorage for T
where T: Any + Send + Sync + Debug,

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> 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> IntoToolOutput for T
where T: Serialize + 'static,

Source§

fn into_tool_output(self) -> Result<ToolOutput, ToolExecutionError>

Convert this value without routing structured data through a string.
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 = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,

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
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