Class Observation.Builder

java.lang.Object

com.langfuse.client.resources.commons.types.Observation.Builder

All Implemented Interfaces:

Observation._FinalStage, Observation.EnvironmentStage, Observation.IdStage, Observation.InputStage, Observation.LevelStage, Observation.MetadataStage, Observation.ModelParametersStage, Observation.OutputStage, Observation.StartTimeStage, Observation.TypeStage, Observation.UsageStage

Enclosing class:

Observation

public static final class Observation.Builder
extends Object
implements Observation.IdStage, Observation.TypeStage, Observation.StartTimeStage, Observation.ModelParametersStage, Observation.InputStage, Observation.MetadataStage, Observation.OutputStage, Observation.UsageStage, Observation.LevelStage, Observation.EnvironmentStage, Observation._FinalStage

Method Summary

Modifier and Type	Method	Description
Observation.Builder	additionalProperties(Map<String,Object> additionalProperties)
Observation.Builder	additionalProperty(String key, Object value)
Observation	build()
Observation._FinalStage	completionStartTime(Nullable<OffsetDateTime> completionStartTime)	The completion start time of the observation
Observation._FinalStage	completionStartTime(OffsetDateTime completionStartTime)	The completion start time of the observation
Observation._FinalStage	completionStartTime(Optional<OffsetDateTime> completionStartTime)	The completion start time of the observation
Observation._FinalStage	costDetails(String key, Double value)	The cost details of the observation.
Observation._FinalStage	costDetails(Map<String,Double> costDetails)	The cost details of the observation.
Observation._FinalStage	endTime(Nullable<OffsetDateTime> endTime)	The end time of the observation.
Observation._FinalStage	endTime(OffsetDateTime endTime)	The end time of the observation.
Observation._FinalStage	endTime(Optional<OffsetDateTime> endTime)	The end time of the observation.
Observation._FinalStage	environment(String environment)	The environment from which this observation originated.
Observation.Builder	from(Observation other)
Observation.TypeStage	id(String id)	The unique identifier of the observation
Observation.MetadataStage	input(Object input)	The input data of the observation
Observation.EnvironmentStage	level(ObservationLevel level)	The level of the observation
Observation.OutputStage	metadata(Object metadata)	Additional metadata of the observation
Observation._FinalStage	model(Nullable<String> model)	The model used for the observation
Observation._FinalStage	model(String model)	The model used for the observation
Observation._FinalStage	model(Optional<String> model)	The model used for the observation
Observation.InputStage	modelParameters(Object modelParameters)	The parameters of the model used for the observation
Observation._FinalStage	name(Nullable<String> name)	The name of the observation
Observation._FinalStage	name(String name)	The name of the observation
Observation._FinalStage	name(Optional<String> name)	The name of the observation
Observation.UsageStage	output(Object output)	The output data of the observation
Observation._FinalStage	parentObservationId(Nullable<String> parentObservationId)	The parent observation ID
Observation._FinalStage	parentObservationId(String parentObservationId)	The parent observation ID
Observation._FinalStage	parentObservationId(Optional<String> parentObservationId)	The parent observation ID
Observation._FinalStage	promptId(Nullable<String> promptId)	The prompt ID associated with the observation
Observation._FinalStage	promptId(String promptId)	The prompt ID associated with the observation
Observation._FinalStage	promptId(Optional<String> promptId)	The prompt ID associated with the observation
Observation._FinalStage	putAllCostDetails(Map<String,Double> costDetails)	The cost details of the observation.
Observation._FinalStage	putAllUsageDetails(Map<String,Integer> usageDetails)	The usage details of the observation.
Observation.ModelParametersStage	startTime(OffsetDateTime startTime)	The start time of the observation
Observation._FinalStage	statusMessage(Nullable<String> statusMessage)	The status message of the observation
Observation._FinalStage	statusMessage(String statusMessage)	The status message of the observation
Observation._FinalStage	statusMessage(Optional<String> statusMessage)	The status message of the observation
Observation._FinalStage	traceId(Nullable<String> traceId)	The trace ID associated with the observation
Observation._FinalStage	traceId(String traceId)	The trace ID associated with the observation
Observation._FinalStage	traceId(Optional<String> traceId)	The trace ID associated with the observation
Observation.StartTimeStage	type(String type)	The type of the observation
Observation.LevelStage	usage(Usage usage)	(Deprecated.
Observation._FinalStage	usageDetails(String key, Integer value)	The usage details of the observation.
Observation._FinalStage	usageDetails(Map<String,Integer> usageDetails)	The usage details of the observation.
Observation._FinalStage	version(Nullable<String> version)	The version of the observation
Observation._FinalStage	version(String version)	The version of the observation
Observation._FinalStage	version(Optional<String> version)	The version of the observation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public Observation.Builder from(Observation other)

Specified by:

from in interface Observation.IdStage

id

public Observation.TypeStage id(@NotNull
 String id)

The unique identifier of the observation

The unique identifier of the observation

Specified by:

id in interface Observation.IdStage

Returns:

Reference to this so that method calls can be chained together.

type

public Observation.StartTimeStage type(@NotNull
 String type)

The type of the observation

The type of the observation

Specified by:

type in interface Observation.TypeStage

Returns:

Reference to this so that method calls can be chained together.

startTime

public Observation.ModelParametersStage startTime(@NotNull
 OffsetDateTime startTime)

The start time of the observation

The start time of the observation

Specified by:

startTime in interface Observation.StartTimeStage

Returns:

Reference to this so that method calls can be chained together.

modelParameters

public Observation.InputStage modelParameters(Object modelParameters)

The parameters of the model used for the observation

The parameters of the model used for the observation

Specified by:

modelParameters in interface Observation.ModelParametersStage

Returns:

Reference to this so that method calls can be chained together.

input

public Observation.MetadataStage input(Object input)

The input data of the observation

The input data of the observation

Specified by:

input in interface Observation.InputStage

Returns:

Reference to this so that method calls can be chained together.

metadata

public Observation.OutputStage metadata(Object metadata)

Additional metadata of the observation

Additional metadata of the observation

Specified by:

metadata in interface Observation.MetadataStage

Returns:

Reference to this so that method calls can be chained together.

output

public Observation.UsageStage output(Object output)

The output data of the observation

The output data of the observation

Specified by:

output in interface Observation.OutputStage

Returns:

Reference to this so that method calls can be chained together.

usage

public Observation.LevelStage usage(@NotNull
 Usage usage)

(Deprecated. Use usageDetails and costDetails instead.) The usage data of the observation

(Deprecated. Use usageDetails and costDetails instead.) The usage data of the observation

Specified by:

usage in interface Observation.UsageStage

Returns:

Reference to this so that method calls can be chained together.

level

public Observation.EnvironmentStage level(@NotNull
 ObservationLevel level)

The level of the observation

The level of the observation

Specified by:

level in interface Observation.LevelStage

Returns:

Reference to this so that method calls can be chained together.

environment

public Observation._FinalStage environment(@NotNull
 String environment)

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

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

Specified by:

environment in interface Observation.EnvironmentStage

Returns:

Reference to this so that method calls can be chained together.

costDetails

public Observation._FinalStage costDetails(String key,
 Double value)

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.

Specified by:

costDetails in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

putAllCostDetails

public Observation._FinalStage putAllCostDetails(Map<String,Double> costDetails)

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.

Specified by:

putAllCostDetails in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

costDetails

public Observation._FinalStage costDetails(Map<String,Double> costDetails)

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.

Specified by:

costDetails in interface Observation._FinalStage

usageDetails

public Observation._FinalStage usageDetails(String key,
 Integer value)

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.

Specified by:

usageDetails in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

putAllUsageDetails

public Observation._FinalStage putAllUsageDetails(Map<String,Integer> usageDetails)

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.

Specified by:

putAllUsageDetails in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

usageDetails

public Observation._FinalStage usageDetails(Map<String,Integer> usageDetails)

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.

Specified by:

usageDetails in interface Observation._FinalStage

promptId

public Observation._FinalStage promptId(Nullable<String> promptId)

The prompt ID associated with the observation

Specified by:

promptId in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

promptId

public Observation._FinalStage promptId(String promptId)

The prompt ID associated with the observation

Specified by:

promptId in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

promptId

public Observation._FinalStage promptId(Optional<String> promptId)

The prompt ID associated with the observation

Specified by:

promptId in interface Observation._FinalStage

parentObservationId

public Observation._FinalStage parentObservationId(Nullable<String> parentObservationId)

The parent observation ID

Specified by:

parentObservationId in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

parentObservationId

public Observation._FinalStage parentObservationId(String parentObservationId)

The parent observation ID

Specified by:

parentObservationId in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

parentObservationId

public Observation._FinalStage parentObservationId(Optional<String> parentObservationId)

The parent observation ID

Specified by:

parentObservationId in interface Observation._FinalStage

statusMessage

public Observation._FinalStage statusMessage(Nullable<String> statusMessage)

The status message of the observation

Specified by:

statusMessage in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

statusMessage

public Observation._FinalStage statusMessage(String statusMessage)

The status message of the observation

Specified by:

statusMessage in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

statusMessage

public Observation._FinalStage statusMessage(Optional<String> statusMessage)

The status message of the observation

Specified by:

statusMessage in interface Observation._FinalStage

version

public Observation._FinalStage version(Nullable<String> version)

The version of the observation

Specified by:

version in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

version

public Observation._FinalStage version(String version)

The version of the observation

Specified by:

version in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

version

public Observation._FinalStage version(Optional<String> version)

The version of the observation

Specified by:

version in interface Observation._FinalStage

model

public Observation._FinalStage model(Nullable<String> model)

The model used for the observation

Specified by:

model in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

model

public Observation._FinalStage model(String model)

The model used for the observation

Specified by:

model in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

model

public Observation._FinalStage model(Optional<String> model)

The model used for the observation

Specified by:

model in interface Observation._FinalStage

completionStartTime

public Observation._FinalStage completionStartTime(Nullable<OffsetDateTime> completionStartTime)

The completion start time of the observation

Specified by:

completionStartTime in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

completionStartTime

public Observation._FinalStage completionStartTime(OffsetDateTime completionStartTime)

The completion start time of the observation

Specified by:

completionStartTime in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

completionStartTime

public Observation._FinalStage completionStartTime(Optional<OffsetDateTime> completionStartTime)

The completion start time of the observation

Specified by:

completionStartTime in interface Observation._FinalStage

endTime

public Observation._FinalStage endTime(Nullable<OffsetDateTime> endTime)

The end time of the observation.

Specified by:

endTime in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

endTime

public Observation._FinalStage endTime(OffsetDateTime endTime)

The end time of the observation.

Specified by:

endTime in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

endTime

public Observation._FinalStage endTime(Optional<OffsetDateTime> endTime)

The end time of the observation.

Specified by:

endTime in interface Observation._FinalStage

name

public Observation._FinalStage name(Nullable<String> name)

The name of the observation

Specified by:

name in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

name

public Observation._FinalStage name(String name)

The name of the observation

Specified by:

name in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

name

public Observation._FinalStage name(Optional<String> name)

The name of the observation

Specified by:

name in interface Observation._FinalStage

traceId

public Observation._FinalStage traceId(Nullable<String> traceId)

The trace ID associated with the observation

Specified by:

traceId in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

traceId

public Observation._FinalStage traceId(String traceId)

The trace ID associated with the observation

Specified by:

traceId in interface Observation._FinalStage

Returns:

Reference to this so that method calls can be chained together.

traceId

public Observation._FinalStage traceId(Optional<String> traceId)

The trace ID associated with the observation

Specified by:

traceId in interface Observation._FinalStage

build

public Observation build()

Specified by:

build in interface Observation._FinalStage

additionalProperty

public Observation.Builder additionalProperty(String key,
 Object value)

Specified by:

additionalProperty in interface Observation._FinalStage

additionalProperties

public Observation.Builder additionalProperties(Map<String,Object> additionalProperties)

Specified by:

additionalProperties in interface Observation._FinalStage