Skip to main content

ProviderCall

Struct ProviderCall 

Source
#[non_exhaustive]
pub struct ProviderCall { pub system: Option<String>, pub operation: Option<String>, pub request_model: Option<String>, pub temperature: Option<f64>, pub response_id: Option<String>, pub response_model: Option<String>, pub finish_reasons: Vec<String>, pub input_tokens: Option<u64>, pub output_tokens: Option<u64>, pub input_cached_tokens: Option<u64>, }
Expand description

One provider call, described with the OpenTelemetry GenAI semantic conventions (gen_ai.*).

These are the attributes every LLM observability backend already reads — Langfuse, Datadog LLM Observability, Phoenix, Braintrust — so a Turnframe application shows up in them as a model call without any vendor adapter. The keys live in crate::attrs so a provider crate and an application spell them identically.

Token accounting is the part that is easy to get wrong, so it is explicit here: ProviderCall::input_tokens is always recorded net of cached tokens. A consumer that reads only that field sees the uncached prompt cost; one that adds ProviderCall::input_cached_tokens sees the whole prompt. Neither double counts. Use ProviderCall::with_cached_usage when the provider reports a total and a cached figure, and ProviderCall::with_usage when it already reports the net one.

No member holds prompt or completion text: content is user data and travels only through ContentRecorder, which is off by default.

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.
§system: Option<String>

Provider key, recorded as gen_ai.system.

§operation: Option<String>

Normalized request purpose, recorded as gen_ai.operation.name.

§request_model: Option<String>

Model asked for, recorded as gen_ai.request.model.

§temperature: Option<f64>

Sampling temperature, recorded as gen_ai.request.temperature.

§response_id: Option<String>

The provider’s identifier for the response.

§response_model: Option<String>

Model that actually answered, which is not always the one asked for.

§finish_reasons: Vec<String>

Why generation stopped.

§input_tokens: Option<u64>

Input tokens billed, net of input_cached_tokens.

§output_tokens: Option<u64>

Output tokens generated.

§input_cached_tokens: Option<u64>

Input tokens served from the provider’s prompt cache.

Implementations§

Source§

impl ProviderCall

Source

pub fn new( system: impl Into<String>, operation: impl Into<String>, request_model: impl Into<String>, ) -> ProviderCall

A call to system for operation with model.

Source

pub fn from_attempt(attempt: &ProviderAttemptRecord) -> ProviderCall

Everything a persisted provider attempt already knows (spec §20.7).

Source

pub fn with_temperature(self, temperature: f64) -> ProviderCall

Sets the requested sampling temperature.

Source

pub fn with_response( self, response_id: impl Into<String>, response_model: impl Into<String>, ) -> ProviderCall

Sets the response identifier and the model that answered.

Source

pub fn with_finish_reason(self, reason: impl Into<String>) -> ProviderCall

Adds a finish reason.

Source

pub fn with_usage(self, input_tokens: u64, output_tokens: u64) -> ProviderCall

Records usage the provider already reports net of its prompt cache.

Source

pub fn with_cached_usage( self, total_input_tokens: u64, cached_tokens: u64, output_tokens: u64, ) -> ProviderCall

Records usage a provider reports as a total prompt size plus a cached figure, and stores the input tokens net of the cache.

use turnframe_telemetry::tracing::ProviderCall;

let call = ProviderCall::new("openai", "extract", "gpt-x")
    .with_cached_usage(1_000, 800, 120);

// 200 uncached + 800 cached = the 1_000 the provider reported.
assert_eq!(call.input_tokens, Some(200));
assert_eq!(call.input_cached_tokens, Some(800));
assert_eq!(call.output_tokens, Some(120));
Source

pub fn total_input_tokens(&self) -> Option<u64>

The total prompt size the provider saw: net input plus cached.

Source

pub fn attributes(&self) -> Vec<(&'static str, String)>

The call as (attribute key, value) pairs in a stable order, omitting what is unknown.

This is the exact set the span carries; it is a plain function so a test can assert on it without standing up a subscriber, and an adopter can rename the keys for a backend that wants its own spelling.

Trait Implementations§

Source§

impl Clone for ProviderCall

Source§

fn clone(&self) -> ProviderCall

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 ProviderCall

Source§

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

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

impl Default for ProviderCall

Source§

fn default() -> ProviderCall

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

impl PartialEq for ProviderCall

Source§

fn eq(&self, other: &ProviderCall) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ProviderCall

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

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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