Class NumericScore.Builder

java.lang.Object

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

All Implemented Interfaces:

NumericScore._FinalStage, NumericScore.CreatedAtStage, NumericScore.EnvironmentStage, NumericScore.IdStage, NumericScore.MetadataStage, NumericScore.NameStage, NumericScore.SourceStage, NumericScore.TimestampStage, NumericScore.UpdatedAtStage, NumericScore.ValueStage

Enclosing class:

NumericScore

public static final class NumericScore.Builder
extends Object
implements NumericScore.ValueStage, NumericScore.IdStage, NumericScore.NameStage, NumericScore.SourceStage, NumericScore.TimestampStage, NumericScore.CreatedAtStage, NumericScore.UpdatedAtStage, NumericScore.MetadataStage, NumericScore.EnvironmentStage, NumericScore._FinalStage

Method Summary

Modifier and Type	Method	Description
NumericScore.Builder	additionalProperties(Map<String,Object> additionalProperties)
NumericScore.Builder	additionalProperty(String key, Object value)
NumericScore._FinalStage	authorUserId(Nullable<String> authorUserId)	The user ID of the author
NumericScore._FinalStage	authorUserId(String authorUserId)	The user ID of the author
NumericScore._FinalStage	authorUserId(Optional<String> authorUserId)	The user ID of the author
NumericScore	build()
NumericScore._FinalStage	comment(Nullable<String> comment)	Comment on the score
NumericScore._FinalStage	comment(String comment)	Comment on the score
NumericScore._FinalStage	comment(Optional<String> comment)	Comment on the score
NumericScore._FinalStage	configId(Nullable<String> configId)	Reference a score config on a score.
NumericScore._FinalStage	configId(String configId)	Reference a score config on a score.
NumericScore._FinalStage	configId(Optional<String> configId)	Reference a score config on a score.
NumericScore.UpdatedAtStage	createdAt(OffsetDateTime createdAt)
NumericScore._FinalStage	datasetRunId(Nullable<String> datasetRunId)	The dataset run ID associated with the score
NumericScore._FinalStage	datasetRunId(String datasetRunId)	The dataset run ID associated with the score
NumericScore._FinalStage	datasetRunId(Optional<String> datasetRunId)	The dataset run ID associated with the score
NumericScore._FinalStage	environment(String environment)	The environment from which this score originated.
NumericScore.Builder	from(NumericScore other)
NumericScore.NameStage	id(String id)
NumericScore.EnvironmentStage	metadata(Object metadata)	Metadata associated with the score
NumericScore.SourceStage	name(String name)
NumericScore._FinalStage	observationId(Nullable<String> observationId)	The observation ID associated with the score
NumericScore._FinalStage	observationId(String observationId)	The observation ID associated with the score
NumericScore._FinalStage	observationId(Optional<String> observationId)	The observation ID associated with the score
NumericScore._FinalStage	queueId(Nullable<String> queueId)	The annotation queue referenced by the score.
NumericScore._FinalStage	queueId(String queueId)	The annotation queue referenced by the score.
NumericScore._FinalStage	queueId(Optional<String> queueId)	The annotation queue referenced by the score.
NumericScore._FinalStage	sessionId(Nullable<String> sessionId)	The session ID associated with the score
NumericScore._FinalStage	sessionId(String sessionId)	The session ID associated with the score
NumericScore._FinalStage	sessionId(Optional<String> sessionId)	The session ID associated with the score
NumericScore.TimestampStage	source(ScoreSource source)
NumericScore.CreatedAtStage	timestamp(OffsetDateTime timestamp)
NumericScore._FinalStage	traceId(Nullable<String> traceId)	The trace ID associated with the score
NumericScore._FinalStage	traceId(String traceId)	The trace ID associated with the score
NumericScore._FinalStage	traceId(Optional<String> traceId)	The trace ID associated with the score
NumericScore.MetadataStage	updatedAt(OffsetDateTime updatedAt)
NumericScore.IdStage	value(double value)	The numeric value of the score

Methods inherited from class java.lang.Object

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

Method Details

from

public NumericScore.Builder from(NumericScore other)

Specified by:

from in interface NumericScore.ValueStage

value

public NumericScore.IdStage value(double value)

The numeric value of the score

The numeric value of the score

Specified by:

value in interface NumericScore.ValueStage

Returns:

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

id

public NumericScore.NameStage id(@NotNull
 String id)

Specified by:

id in interface NumericScore.IdStage

name

public NumericScore.SourceStage name(@NotNull
 String name)

Specified by:

name in interface NumericScore.NameStage

source

public NumericScore.TimestampStage source(@NotNull
 ScoreSource source)

Specified by:

source in interface NumericScore.SourceStage

timestamp

public NumericScore.CreatedAtStage timestamp(@NotNull
 OffsetDateTime timestamp)

Specified by:

timestamp in interface NumericScore.TimestampStage

createdAt

public NumericScore.UpdatedAtStage createdAt(@NotNull
 OffsetDateTime createdAt)

Specified by:

createdAt in interface NumericScore.CreatedAtStage

updatedAt

public NumericScore.MetadataStage updatedAt(@NotNull
 OffsetDateTime updatedAt)

Specified by:

updatedAt in interface NumericScore.UpdatedAtStage

metadata

public NumericScore.EnvironmentStage metadata(Object metadata)

Metadata associated with the score

Metadata associated with the score

Specified by:

metadata in interface NumericScore.MetadataStage

Returns:

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

environment

public NumericScore._FinalStage environment(@NotNull
 String environment)

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

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

Specified by:

environment in interface NumericScore.EnvironmentStage

Returns:

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

queueId

public NumericScore._FinalStage queueId(Nullable<String> queueId)

The annotation queue referenced by the score. Indicates if score was initially created while processing annotation queue.

Specified by:

queueId in interface NumericScore._FinalStage

Returns:

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

queueId

public NumericScore._FinalStage queueId(String queueId)

The annotation queue referenced by the score. Indicates if score was initially created while processing annotation queue.

Specified by:

queueId in interface NumericScore._FinalStage

Returns:

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

queueId

public NumericScore._FinalStage queueId(Optional<String> queueId)

The annotation queue referenced by the score. Indicates if score was initially created while processing annotation queue.

Specified by:

queueId in interface NumericScore._FinalStage

configId

public NumericScore._FinalStage configId(Nullable<String> configId)

Reference a score config on a score. When set, config and score name must be equal and value must comply to optionally defined numerical range

Specified by:

configId in interface NumericScore._FinalStage

Returns:

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

configId

public NumericScore._FinalStage configId(String configId)

Reference a score config on a score. When set, config and score name must be equal and value must comply to optionally defined numerical range

Specified by:

configId in interface NumericScore._FinalStage

Returns:

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

configId

public NumericScore._FinalStage configId(Optional<String> configId)

Reference a score config on a score. When set, config and score name must be equal and value must comply to optionally defined numerical range

Specified by:

configId in interface NumericScore._FinalStage

comment

public NumericScore._FinalStage comment(Nullable<String> comment)

Comment on the score

Specified by:

comment in interface NumericScore._FinalStage

Returns:

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

comment

public NumericScore._FinalStage comment(String comment)

Comment on the score

Specified by:

comment in interface NumericScore._FinalStage

Returns:

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

comment

public NumericScore._FinalStage comment(Optional<String> comment)

Comment on the score

Specified by:

comment in interface NumericScore._FinalStage

authorUserId

public NumericScore._FinalStage authorUserId(Nullable<String> authorUserId)

The user ID of the author

Specified by:

authorUserId in interface NumericScore._FinalStage

Returns:

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

authorUserId

public NumericScore._FinalStage authorUserId(String authorUserId)

The user ID of the author

Specified by:

authorUserId in interface NumericScore._FinalStage

Returns:

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

authorUserId

public NumericScore._FinalStage authorUserId(Optional<String> authorUserId)

The user ID of the author

Specified by:

authorUserId in interface NumericScore._FinalStage

datasetRunId

public NumericScore._FinalStage datasetRunId(Nullable<String> datasetRunId)

The dataset run ID associated with the score

Specified by:

datasetRunId in interface NumericScore._FinalStage

Returns:

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

datasetRunId

public NumericScore._FinalStage datasetRunId(String datasetRunId)

The dataset run ID associated with the score

Specified by:

datasetRunId in interface NumericScore._FinalStage

Returns:

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

datasetRunId

public NumericScore._FinalStage datasetRunId(Optional<String> datasetRunId)

The dataset run ID associated with the score

Specified by:

datasetRunId in interface NumericScore._FinalStage

observationId

public NumericScore._FinalStage observationId(Nullable<String> observationId)

The observation ID associated with the score

Specified by:

observationId in interface NumericScore._FinalStage

Returns:

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

observationId

public NumericScore._FinalStage observationId(String observationId)

The observation ID associated with the score

Specified by:

observationId in interface NumericScore._FinalStage

Returns:

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

observationId

public NumericScore._FinalStage observationId(Optional<String> observationId)

The observation ID associated with the score

Specified by:

observationId in interface NumericScore._FinalStage

sessionId

public NumericScore._FinalStage sessionId(Nullable<String> sessionId)

The session ID associated with the score

Specified by:

sessionId in interface NumericScore._FinalStage

Returns:

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

sessionId

public NumericScore._FinalStage sessionId(String sessionId)

The session ID associated with the score

Specified by:

sessionId in interface NumericScore._FinalStage

Returns:

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

sessionId

public NumericScore._FinalStage sessionId(Optional<String> sessionId)

The session ID associated with the score

Specified by:

sessionId in interface NumericScore._FinalStage

traceId

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

The trace ID associated with the score

Specified by:

traceId in interface NumericScore._FinalStage

Returns:

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

traceId

public NumericScore._FinalStage traceId(String traceId)

The trace ID associated with the score

Specified by:

traceId in interface NumericScore._FinalStage

Returns:

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

traceId

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

The trace ID associated with the score

Specified by:

traceId in interface NumericScore._FinalStage

build

public NumericScore build()

Specified by:

build in interface NumericScore._FinalStage

additionalProperty

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

Specified by:

additionalProperty in interface NumericScore._FinalStage

additionalProperties

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

Specified by:

additionalProperties in interface NumericScore._FinalStage