Class CategoricalScoreV1.Builder

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing class:

CategoricalScoreV1

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

Method Summary

Modifier and Type	Method	Description
CategoricalScoreV1.Builder	additionalProperties(Map<String,Object> additionalProperties)
CategoricalScoreV1.Builder	additionalProperty(String key, Object value)
CategoricalScoreV1._FinalStage	authorUserId(Nullable<String> authorUserId)	The user ID of the author
CategoricalScoreV1._FinalStage	authorUserId(String authorUserId)	The user ID of the author
CategoricalScoreV1._FinalStage	authorUserId(Optional<String> authorUserId)	The user ID of the author
CategoricalScoreV1	build()
CategoricalScoreV1._FinalStage	comment(Nullable<String> comment)	Comment on the score
CategoricalScoreV1._FinalStage	comment(String comment)	Comment on the score
CategoricalScoreV1._FinalStage	comment(Optional<String> comment)	Comment on the score
CategoricalScoreV1._FinalStage	configId(Nullable<String> configId)	Reference a score config on a score.
CategoricalScoreV1._FinalStage	configId(String configId)	Reference a score config on a score.
CategoricalScoreV1._FinalStage	configId(Optional<String> configId)	Reference a score config on a score.
CategoricalScoreV1.UpdatedAtStage	createdAt(OffsetDateTime createdAt)
CategoricalScoreV1.ValueStage	environment(String environment)	The environment from which this score originated.
CategoricalScoreV1.Builder	from(CategoricalScoreV1 other)
CategoricalScoreV1.TraceIdStage	id(String id)
CategoricalScoreV1.EnvironmentStage	metadata(Object metadata)	Metadata associated with the score
CategoricalScoreV1.SourceStage	name(String name)
CategoricalScoreV1._FinalStage	observationId(Nullable<String> observationId)	The observation ID associated with the score
CategoricalScoreV1._FinalStage	observationId(String observationId)	The observation ID associated with the score
CategoricalScoreV1._FinalStage	observationId(Optional<String> observationId)	The observation ID associated with the score
CategoricalScoreV1._FinalStage	queueId(Nullable<String> queueId)	The annotation queue referenced by the score.
CategoricalScoreV1._FinalStage	queueId(String queueId)	The annotation queue referenced by the score.
CategoricalScoreV1._FinalStage	queueId(Optional<String> queueId)	The annotation queue referenced by the score.
CategoricalScoreV1.TimestampStage	source(ScoreSource source)
CategoricalScoreV1._FinalStage	stringValue(String stringValue)	The string representation of the score value.
CategoricalScoreV1.CreatedAtStage	timestamp(OffsetDateTime timestamp)
CategoricalScoreV1.NameStage	traceId(String traceId)
CategoricalScoreV1.MetadataStage	updatedAt(OffsetDateTime updatedAt)
CategoricalScoreV1.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 CategoricalScoreV1.Builder from(CategoricalScoreV1 other)

Specified by:

from in interface CategoricalScoreV1.IdStage

id

public CategoricalScoreV1.TraceIdStage id(@NotNull
 String id)

Specified by:

id in interface CategoricalScoreV1.IdStage

traceId

public CategoricalScoreV1.NameStage traceId(@NotNull
 String traceId)

Specified by:

traceId in interface CategoricalScoreV1.TraceIdStage

name

public CategoricalScoreV1.SourceStage name(@NotNull
 String name)

Specified by:

name in interface CategoricalScoreV1.NameStage

source

public CategoricalScoreV1.TimestampStage source(@NotNull
 ScoreSource source)

Specified by:

source in interface CategoricalScoreV1.SourceStage

timestamp

public CategoricalScoreV1.CreatedAtStage timestamp(@NotNull
 OffsetDateTime timestamp)

Specified by:

timestamp in interface CategoricalScoreV1.TimestampStage

createdAt

public CategoricalScoreV1.UpdatedAtStage createdAt(@NotNull
 OffsetDateTime createdAt)

Specified by:

createdAt in interface CategoricalScoreV1.CreatedAtStage

updatedAt

public CategoricalScoreV1.MetadataStage updatedAt(@NotNull
 OffsetDateTime updatedAt)

Specified by:

updatedAt in interface CategoricalScoreV1.UpdatedAtStage

metadata

public CategoricalScoreV1.EnvironmentStage metadata(Object metadata)

Metadata associated with the score

Metadata associated with the score

Specified by:

metadata in interface CategoricalScoreV1.MetadataStage

Returns:

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

environment

public CategoricalScoreV1.ValueStage 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 CategoricalScoreV1.EnvironmentStage

Returns:

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

value

public CategoricalScoreV1.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 CategoricalScoreV1.ValueStage

Returns:

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

stringValue

public CategoricalScoreV1._FinalStage 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 CategoricalScoreV1.StringValueStage

Returns:

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

queueId

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

Returns:

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

queueId

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

Returns:

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

queueId

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

configId

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

Returns:

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

configId

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

Returns:

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

configId

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

comment

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

Comment on the score

Specified by:

comment in interface CategoricalScoreV1._FinalStage

Returns:

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

comment

public CategoricalScoreV1._FinalStage comment(String comment)

Comment on the score

Specified by:

comment in interface CategoricalScoreV1._FinalStage

Returns:

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

comment

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

Comment on the score

Specified by:

comment in interface CategoricalScoreV1._FinalStage

authorUserId

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

The user ID of the author

Specified by:

authorUserId in interface CategoricalScoreV1._FinalStage

Returns:

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

authorUserId

public CategoricalScoreV1._FinalStage authorUserId(String authorUserId)

The user ID of the author

Specified by:

authorUserId in interface CategoricalScoreV1._FinalStage

Returns:

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

authorUserId

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

The user ID of the author

Specified by:

authorUserId in interface CategoricalScoreV1._FinalStage

observationId

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

The observation ID associated with the score

Specified by:

observationId in interface CategoricalScoreV1._FinalStage

Returns:

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

observationId

public CategoricalScoreV1._FinalStage observationId(String observationId)

The observation ID associated with the score

Specified by:

observationId in interface CategoricalScoreV1._FinalStage

Returns:

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

observationId

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

The observation ID associated with the score

Specified by:

observationId in interface CategoricalScoreV1._FinalStage

build

public CategoricalScoreV1 build()

Specified by:

build in interface CategoricalScoreV1._FinalStage

additionalProperty

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

Specified by:

additionalProperty in interface CategoricalScoreV1._FinalStage

additionalProperties

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

Specified by:

additionalProperties in interface CategoricalScoreV1._FinalStage