Skip to main content

LlmCompletionMetadata

Struct LlmCompletionMetadata 

Source
#[non_exhaustive]
pub struct LlmCompletionMetadata { pub total_tokens: Option<u32>, pub prompt_tokens: Option<u32>, pub completion_tokens: Option<u32>, pub cache_read_tokens: Option<u32>, pub cache_creation_tokens: Option<u32>, pub provider_cost_usd: Option<f64>, pub model: Option<String>, pub finish_reason: Option<String>, pub retry_metadata: Option<RetryMetadata>, pub response_id: Option<String>, pub phase: Option<String>, pub cache_diagnostics: Option<Value>, }
Expand description

Metadata about LLM completion

Contains token usage and completion information from the LLM response.

Token buckets are disjoint by convention (see the TokenUsage event): drivers normalize provider wire formats at the boundary so prompt_tokens carries only non-cached input, with cache_read_tokens / cache_creation_tokens additive on top. Inclusive providers (OpenAI Responses / Chat Completions, Gemini) subtract their cached count from the reported prompt total via disjoint_prompt_tokens; Anthropic / Bedrock already report disjoint buckets and pass values through unchanged.

#[non_exhaustive]: usage and cost dimensions keep being added, so construct with LlmCompletionMetadata::default and assign fields.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§total_tokens: Option<u32>

Total tokens used (non-cached prompt + cache read/creation + completion)

§prompt_tokens: Option<u32>

Non-cached prompt tokens (cached reads are excluded; see struct docs)

§completion_tokens: Option<u32>

Completion tokens

§cache_read_tokens: Option<u32>

Tokens read from cache (reduces cost), disjoint from prompt_tokens

§cache_creation_tokens: Option<u32>

Tokens written to cache (Anthropic-specific), disjoint from prompt_tokens

§provider_cost_usd: Option<f64>

Authoritative cost of this generation in USD, when the provider reports it inline (e.g. OpenRouter’s usage.cost). None for providers that do not return a cost.

§model: Option<String>

Model used

§finish_reason: Option<String>

Finish reason

§retry_metadata: Option<RetryMetadata>

Retry metadata (present if rate limit retries occurred)

§response_id: Option<String>

Provider’s response ID (e.g., OpenAI response ID from response.completed). Used for previous_response_id chaining and OTel tracing.

§phase: Option<String>

Execution phase from the provider’s response (e.g., “commentary”, “final_answer”). When present, this value should be preserved on the assistant message and sent back as-is in subsequent requests. Only set by providers with native phase support.

§cache_diagnostics: Option<Value>

Provider-reported prompt-cache diagnostics, verbatim.

Present only when the request opted in via LlmCallConfig::cache_diagnostics and the provider answered with a diagnostics payload (today: Anthropic’s cache-diagnosis beta). The shape is provider-owned, so the runtime carries it without interpreting it.

Trait Implementations§

Source§

impl Clone for LlmCompletionMetadata

Source§

fn clone(&self) -> LlmCompletionMetadata

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 LlmCompletionMetadata

Source§

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

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

impl Default for LlmCompletionMetadata

Source§

fn default() -> LlmCompletionMetadata

Returns the “default value” for a type. Read more

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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