Skip to main content

ObservableChatClient

Struct ObservableChatClient 

Source
pub struct ObservableChatClient<C: ChatClient> { /* private fields */ }
Expand description

A ChatClient decorator that emits a chat span per request following the OpenTelemetry GenAI semantic conventions.

Message-content capture (gen_ai.input.messages / gen_ai.output.messages, plus gen_ai.system_instructions / gen_ai.tool.definitions) is off by default; enable it with ObservableChatClient::with_content_capture, mirroring Python’s enable_sensitive_data flag — or construct via ObservableChatClient::from_env to read that flag from ENABLE_SENSITIVE_DATA.

Implementations§

Source§

impl<C: ChatClient> ObservableChatClient<C>

Source

pub fn new(inner: C, system: impl Into<String>) -> Self

Wrap inner, tagging spans with the given provider/system name (the gen_ai.system / gen_ai.provider.name attributes), e.g. "openai" or "anthropic".

Source

pub fn from_env(inner: C, system: impl Into<String>) -> Self

Wrap inner using ObservabilityConfig::from_env to decide whether content capture is enabled (ENABLE_SENSITIVE_DATA). Equivalent to:

ObservableChatClient::new(inner, system)
    .with_content_capture(ObservabilityConfig::from_env().enable_sensitive_data)
Source

pub fn with_content_capture(self, capture: bool) -> Self

Enable or disable capturing message content on spans (default: off).

Source

pub fn with_observability_config(self, config: ObservabilityConfig) -> Self

Replace the whole ObservabilityConfig — content capture and the GenAI semantic-convention version this client emits for.

Source

pub fn inner(&self) -> &C

A reference to the wrapped client.

Trait Implementations§

Source§

impl<C: ChatClient> ChatClient for ObservableChatClient<C>

Source§

fn get_response<'life0, 'async_trait>( &'life0 self, messages: Vec<Message>, options: ChatOptions, ) -> Pin<Box<dyn Future<Output = Result<ChatResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Get a complete (non-streaming) response.
Source§

fn get_streaming_response<'life0, 'async_trait>( &'life0 self, messages: Vec<Message>, options: ChatOptions, ) -> Pin<Box<dyn Future<Output = Result<ChatStream>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Get a streaming response as a sequence of updates.
Source§

fn model(&self) -> Option<&str>

The default model id for this client, if any.

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