Class CategoricalScore.Builder

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing class:

CategoricalScore

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Details

from

public CategoricalScore.Builder from(CategoricalScore other)

Specified by:

from in interface CategoricalScore.ValueStage

value

public CategoricalScore.StringValueStage value(double value)

Represents the numeric category mapping of the stringValue. If no config is linked, defaults to 0.

Represents the numeric category mapping of the stringValue. If no config is linked, defaults to 0.

Specified by:

value in interface CategoricalScore.ValueStage

Returns:

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

stringValue

public CategoricalScore.IdStage stringValue(@NotNull
 String stringValue)

The string representation of the score value. If no config is linked, can be any string. Otherwise, must map to a config category

The string representation of the score value. If no config is linked, can be any string. Otherwise, must map to a config category

Specified by:

stringValue in interface CategoricalScore.StringValueStage

Returns:

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

id

public CategoricalScore.NameStage id(@NotNull
 String id)

Specified by:

id in interface CategoricalScore.IdStage

name

public CategoricalScore.SourceStage name(@NotNull
 String name)

Specified by:

name in interface CategoricalScore.NameStage

source

public CategoricalScore.TimestampStage source(@NotNull
 ScoreSource source)

Specified by:

source in interface CategoricalScore.SourceStage

timestamp

public CategoricalScore.CreatedAtStage timestamp(@NotNull
 OffsetDateTime timestamp)

Specified by:

timestamp in interface CategoricalScore.TimestampStage

createdAt

public CategoricalScore.UpdatedAtStage createdAt(@NotNull
 OffsetDateTime createdAt)

Specified by:

createdAt in interface CategoricalScore.CreatedAtStage

updatedAt

public CategoricalScore.MetadataStage updatedAt(@NotNull
 OffsetDateTime updatedAt)

Specified by:

updatedAt in interface CategoricalScore.UpdatedAtStage

metadata

public CategoricalScore.EnvironmentStage metadata(Object metadata)

Metadata associated with the score

Metadata associated with the score

Specified by:

metadata in interface CategoricalScore.MetadataStage

Returns:

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

environment

public CategoricalScore._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 CategoricalScore.EnvironmentStage

Returns:

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

queueId

public CategoricalScore._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 CategoricalScore._FinalStage

Returns:

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

queueId

public CategoricalScore._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 CategoricalScore._FinalStage

Returns:

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

queueId

public CategoricalScore._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 CategoricalScore._FinalStage

configId

public CategoricalScore._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 CategoricalScore._FinalStage

Returns:

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

configId

public CategoricalScore._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 CategoricalScore._FinalStage

Returns:

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

configId

public CategoricalScore._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 CategoricalScore._FinalStage

comment

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

Comment on the score

Specified by:

comment in interface CategoricalScore._FinalStage

Returns:

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

comment

public CategoricalScore._FinalStage comment(String comment)

Comment on the score

Specified by:

comment in interface CategoricalScore._FinalStage

Returns:

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

comment

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

Comment on the score

Specified by:

comment in interface CategoricalScore._FinalStage

authorUserId

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

The user ID of the author

Specified by:

authorUserId in interface CategoricalScore._FinalStage

Returns:

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

authorUserId

public CategoricalScore._FinalStage authorUserId(String authorUserId)

The user ID of the author

Specified by:

authorUserId in interface CategoricalScore._FinalStage

Returns:

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

authorUserId

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

The user ID of the author

Specified by:

authorUserId in interface CategoricalScore._FinalStage

datasetRunId

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

The dataset run ID associated with the score

Specified by:

datasetRunId in interface CategoricalScore._FinalStage

Returns:

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

datasetRunId

public CategoricalScore._FinalStage datasetRunId(String datasetRunId)

The dataset run ID associated with the score

Specified by:

datasetRunId in interface CategoricalScore._FinalStage

Returns:

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

datasetRunId

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

The dataset run ID associated with the score

Specified by:

datasetRunId in interface CategoricalScore._FinalStage

observationId

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

The observation ID associated with the score

Specified by:

observationId in interface CategoricalScore._FinalStage

Returns:

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

observationId

public CategoricalScore._FinalStage observationId(String observationId)

The observation ID associated with the score

Specified by:

observationId in interface CategoricalScore._FinalStage

Returns:

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

observationId

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

The observation ID associated with the score

Specified by:

observationId in interface CategoricalScore._FinalStage

sessionId

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

The session ID associated with the score

Specified by:

sessionId in interface CategoricalScore._FinalStage

Returns:

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

sessionId

public CategoricalScore._FinalStage sessionId(String sessionId)

The session ID associated with the score

Specified by:

sessionId in interface CategoricalScore._FinalStage

Returns:

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

sessionId

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

The session ID associated with the score

Specified by:

sessionId in interface CategoricalScore._FinalStage

traceId

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

The trace ID associated with the score

Specified by:

traceId in interface CategoricalScore._FinalStage

Returns:

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

traceId

public CategoricalScore._FinalStage traceId(String traceId)

The trace ID associated with the score

Specified by:

traceId in interface CategoricalScore._FinalStage

Returns:

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

traceId

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

The trace ID associated with the score

Specified by:

traceId in interface CategoricalScore._FinalStage

build

public CategoricalScore build()

Specified by:

build in interface CategoricalScore._FinalStage

additionalProperty

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

Specified by:

additionalProperty in interface CategoricalScore._FinalStage

additionalProperties

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

Specified by:

additionalProperties in interface CategoricalScore._FinalStage