Skip to main content

ObservationBuilder

langfuse_client_base::models::observation

Struct ObservationBuilder 

Source 
pub struct ObservationBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> ObservationBuilder<S>

Source

pub fn build(self) -> Observation
where S: IsComplete,

Finish building and return the requested object

Source

pub fn id(self, value: String) -> ObservationBuilder<SetId<S>>
where S::Id: IsUnset,

Required.

The unique identifier of the observation

Source

pub fn trace_id( self, value: Option<String>, ) -> ObservationBuilder<SetTraceId<S>>
where S::TraceId: IsUnset,

Optional (Some / Option setters). The trace ID associated with the observation

Source

pub fn maybe_trace_id( self, value: Option<Option<String>>, ) -> ObservationBuilder<SetTraceId<S>>
where S::TraceId: IsUnset,

Optional (Some / Option setters). The trace ID associated with the observation

Source

pub fn type(self, value: String) -> ObservationBuilder<SetType<S>>
where S::Type: IsUnset,

Required.

The type of the observation

Source

pub fn name(self, value: Option<String>) -> ObservationBuilder<SetName<S>>
where S::Name: IsUnset,

Optional (Some / Option setters). The name of the observation

Source

pub fn maybe_name( self, value: Option<Option<String>>, ) -> ObservationBuilder<SetName<S>>
where S::Name: IsUnset,

Optional (Some / Option setters). The name of the observation

Source

pub fn start_time(self, value: String) -> ObservationBuilder<SetStartTime<S>>
where S::StartTime: IsUnset,

Required.

The start time of the observation

Source

pub fn end_time( self, value: Option<String>, ) -> ObservationBuilder<SetEndTime<S>>
where S::EndTime: IsUnset,

Optional (Some / Option setters). The end time of the observation.

Source

pub fn maybe_end_time( self, value: Option<Option<String>>, ) -> ObservationBuilder<SetEndTime<S>>
where S::EndTime: IsUnset,

Optional (Some / Option setters). The end time of the observation.

Source

pub fn completion_start_time( self, value: Option<String>, ) -> ObservationBuilder<SetCompletionStartTime<S>>
where S::CompletionStartTime: IsUnset,

Optional (Some / Option setters). The completion start time of the observation

Source

pub fn maybe_completion_start_time( self, value: Option<Option<String>>, ) -> ObservationBuilder<SetCompletionStartTime<S>>
where S::CompletionStartTime: IsUnset,

Optional (Some / Option setters). The completion start time of the observation

Source

pub fn model(self, value: Option<String>) -> ObservationBuilder<SetModel<S>>
where S::Model: IsUnset,

Optional (Some / Option setters). The model used for the observation

Source

pub fn maybe_model( self, value: Option<Option<String>>, ) -> ObservationBuilder<SetModel<S>>
where S::Model: IsUnset,

Optional (Some / Option setters). The model used for the observation

Source

pub fn model_parameters( self, value: Value, ) -> ObservationBuilder<SetModelParameters<S>>
where S::ModelParameters: IsUnset,

Optional (Some / Option setters). The parameters of the model used for the observation

Source

pub fn maybe_model_parameters( self, value: Option<Value>, ) -> ObservationBuilder<SetModelParameters<S>>
where S::ModelParameters: IsUnset,

Optional (Some / Option setters). The parameters of the model used for the observation

Source

pub fn input(self, value: Value) -> ObservationBuilder<SetInput<S>>
where S::Input: IsUnset,

Optional (Some / Option setters). The input data of the observation

Source

pub fn maybe_input( self, value: Option<Value>, ) -> ObservationBuilder<SetInput<S>>
where S::Input: IsUnset,

Optional (Some / Option setters). The input data of the observation

Source

pub fn version(self, value: Option<String>) -> ObservationBuilder<SetVersion<S>>
where S::Version: IsUnset,

Optional (Some / Option setters). The version of the observation

Source

pub fn maybe_version( self, value: Option<Option<String>>, ) -> ObservationBuilder<SetVersion<S>>
where S::Version: IsUnset,

Optional (Some / Option setters). The version of the observation

Source

pub fn metadata(self, value: Value) -> ObservationBuilder<SetMetadata<S>>
where S::Metadata: IsUnset,

Optional (Some / Option setters). Additional metadata of the observation

Source

pub fn maybe_metadata( self, value: Option<Value>, ) -> ObservationBuilder<SetMetadata<S>>
where S::Metadata: IsUnset,

Optional (Some / Option setters). Additional metadata of the observation

Source

pub fn output(self, value: Value) -> ObservationBuilder<SetOutput<S>>
where S::Output: IsUnset,

Optional (Some / Option setters). The output data of the observation

Source

pub fn maybe_output( self, value: Option<Value>, ) -> ObservationBuilder<SetOutput<S>>
where S::Output: IsUnset,

Optional (Some / Option setters). The output data of the observation

Source

pub fn usage(self, value: Box<Usage>) -> ObservationBuilder<SetUsage<S>>
where S::Usage: IsUnset,

Required.

Source

pub fn level(self, value: ObservationLevel) -> ObservationBuilder<SetLevel<S>>
where S::Level: IsUnset,

Required.

Source

pub fn status_message( self, value: Option<String>, ) -> ObservationBuilder<SetStatusMessage<S>>
where S::StatusMessage: IsUnset,

Optional (Some / Option setters). The status message of the observation

Source

pub fn maybe_status_message( self, value: Option<Option<String>>, ) -> ObservationBuilder<SetStatusMessage<S>>
where S::StatusMessage: IsUnset,

Optional (Some / Option setters). The status message of the observation

Source

pub fn parent_observation_id( self, value: Option<String>, ) -> ObservationBuilder<SetParentObservationId<S>>
where S::ParentObservationId: IsUnset,

Optional (Some / Option setters). The parent observation ID

Source

pub fn maybe_parent_observation_id( self, value: Option<Option<String>>, ) -> ObservationBuilder<SetParentObservationId<S>>
where S::ParentObservationId: IsUnset,

Optional (Some / Option setters). The parent observation ID

Source

pub fn prompt_id( self, value: Option<String>, ) -> ObservationBuilder<SetPromptId<S>>
where S::PromptId: IsUnset,

Optional (Some / Option setters). The prompt ID associated with the observation

Source

pub fn maybe_prompt_id( self, value: Option<Option<String>>, ) -> ObservationBuilder<SetPromptId<S>>
where S::PromptId: IsUnset,

Optional (Some / Option setters). The prompt ID associated with the observation

Source

pub fn usage_details( self, value: HashMap<String, i32>, ) -> ObservationBuilder<SetUsageDetails<S>>
where S::UsageDetails: IsUnset,

Required.

The usage details of the observation. Key is the name of the usage metric, value is the number of units consumed. The total key is the sum of all (non-total) usage metrics or the total value ingested.

Source

pub fn cost_details( self, value: HashMap<String, f64>, ) -> ObservationBuilder<SetCostDetails<S>>
where S::CostDetails: IsUnset,

Required.

The cost details of the observation. Key is the name of the cost metric, value is the cost in USD. The total key is the sum of all (non-total) cost metrics or the total value ingested.

Source

pub fn environment(self, value: String) -> ObservationBuilder<SetEnvironment<S>>
where S::Environment: IsUnset,

Required.

The environment from which this observation originated. Can be any lowercase alphanumeric string with hyphens and underscores that does not start with ‘langfuse’.

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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, 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<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