Class BaseScore.Builder

java.lang.Object

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

All Implemented Interfaces:

BaseScore._FinalStage, BaseScore.CreatedAtStage, BaseScore.EnvironmentStage, BaseScore.IdStage, BaseScore.MetadataStage, BaseScore.NameStage, BaseScore.SourceStage, BaseScore.TimestampStage, BaseScore.UpdatedAtStage

Enclosing class:

BaseScore

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Details

from

public BaseScore.Builder from(BaseScore other)

Specified by:

from in interface BaseScore.IdStage

id

public BaseScore.NameStage id(@NotNull
 String id)

Specified by:

id in interface BaseScore.IdStage

name

public BaseScore.SourceStage name(@NotNull
 String name)

Specified by:

name in interface BaseScore.NameStage

source

public BaseScore.TimestampStage source(@NotNull
 ScoreSource source)

Specified by:

source in interface BaseScore.SourceStage

timestamp

public BaseScore.CreatedAtStage timestamp(@NotNull
 OffsetDateTime timestamp)

Specified by:

timestamp in interface BaseScore.TimestampStage

createdAt

public BaseScore.UpdatedAtStage createdAt(@NotNull
 OffsetDateTime createdAt)

Specified by:

createdAt in interface BaseScore.CreatedAtStage

updatedAt

public BaseScore.MetadataStage updatedAt(@NotNull
 OffsetDateTime updatedAt)

Specified by:

updatedAt in interface BaseScore.UpdatedAtStage

metadata

public BaseScore.EnvironmentStage metadata(Object metadata)

Metadata associated with the score

Metadata associated with the score

Specified by:

metadata in interface BaseScore.MetadataStage

Returns:

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

environment

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

Returns:

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

queueId

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

Returns:

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

queueId

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

Returns:

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

queueId

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

configId

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

Returns:

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

configId

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

Returns:

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

configId

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

comment

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

Comment on the score

Specified by:

comment in interface BaseScore._FinalStage

Returns:

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

comment

public BaseScore._FinalStage comment(String comment)

Comment on the score

Specified by:

comment in interface BaseScore._FinalStage

Returns:

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

comment

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

Comment on the score

Specified by:

comment in interface BaseScore._FinalStage

authorUserId

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

The user ID of the author

Specified by:

authorUserId in interface BaseScore._FinalStage

Returns:

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

authorUserId

public BaseScore._FinalStage authorUserId(String authorUserId)

The user ID of the author

Specified by:

authorUserId in interface BaseScore._FinalStage

Returns:

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

authorUserId

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

The user ID of the author

Specified by:

authorUserId in interface BaseScore._FinalStage

datasetRunId

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

The dataset run ID associated with the score

Specified by:

datasetRunId in interface BaseScore._FinalStage

Returns:

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

datasetRunId

public BaseScore._FinalStage datasetRunId(String datasetRunId)

The dataset run ID associated with the score

Specified by:

datasetRunId in interface BaseScore._FinalStage

Returns:

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

datasetRunId

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

The dataset run ID associated with the score

Specified by:

datasetRunId in interface BaseScore._FinalStage

observationId

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

The observation ID associated with the score

Specified by:

observationId in interface BaseScore._FinalStage

Returns:

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

observationId

public BaseScore._FinalStage observationId(String observationId)

The observation ID associated with the score

Specified by:

observationId in interface BaseScore._FinalStage

Returns:

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

observationId

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

The observation ID associated with the score

Specified by:

observationId in interface BaseScore._FinalStage

sessionId

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

The session ID associated with the score

Specified by:

sessionId in interface BaseScore._FinalStage

Returns:

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

sessionId

public BaseScore._FinalStage sessionId(String sessionId)

The session ID associated with the score

Specified by:

sessionId in interface BaseScore._FinalStage

Returns:

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

sessionId

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

The session ID associated with the score

Specified by:

sessionId in interface BaseScore._FinalStage

traceId

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

The trace ID associated with the score

Specified by:

traceId in interface BaseScore._FinalStage

Returns:

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

traceId

public BaseScore._FinalStage traceId(String traceId)

The trace ID associated with the score

Specified by:

traceId in interface BaseScore._FinalStage

Returns:

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

traceId

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

The trace ID associated with the score

Specified by:

traceId in interface BaseScore._FinalStage

build

public BaseScore build()

Specified by:

build in interface BaseScore._FinalStage

additionalProperty

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

Specified by:

additionalProperty in interface BaseScore._FinalStage

additionalProperties

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

Specified by:

additionalProperties in interface BaseScore._FinalStage