Class ScoreBody.Builder

java.lang.Object

com.langfuse.client.resources.ingestion.types.ScoreBody.Builder

All Implemented Interfaces:

ScoreBody._FinalStage, ScoreBody.NameStage, ScoreBody.ValueStage

Enclosing class:

ScoreBody

public static final class ScoreBody.Builder
extends Object
implements ScoreBody.NameStage, ScoreBody.ValueStage, ScoreBody._FinalStage

Method Summary

Modifier and Type	Method	Description
ScoreBody.Builder	additionalProperties(Map<String,Object> additionalProperties)
ScoreBody.Builder	additionalProperty(String key, Object value)
ScoreBody	build()
ScoreBody._FinalStage	comment(String comment)
ScoreBody._FinalStage	comment(Optional<String> comment)
ScoreBody._FinalStage	configId(String configId)	Reference a score config on a score.
ScoreBody._FinalStage	configId(Optional<String> configId)	Reference a score config on a score.
ScoreBody._FinalStage	datasetRunId(String datasetRunId)
ScoreBody._FinalStage	datasetRunId(Optional<String> datasetRunId)
ScoreBody._FinalStage	dataType(ScoreDataType dataType)	When set, must match the score value's type.
ScoreBody._FinalStage	dataType(Optional<ScoreDataType> dataType)	When set, must match the score value's type.
ScoreBody._FinalStage	environment(String environment)
ScoreBody._FinalStage	environment(Optional<String> environment)
ScoreBody.Builder	from(ScoreBody other)
ScoreBody._FinalStage	id(String id)
ScoreBody._FinalStage	id(Optional<String> id)
ScoreBody._FinalStage	metadata(Object metadata)
ScoreBody._FinalStage	metadata(Optional<Object> metadata)
ScoreBody.ValueStage	name(String name)	The name of the score.
ScoreBody._FinalStage	observationId(String observationId)
ScoreBody._FinalStage	observationId(Optional<String> observationId)
ScoreBody._FinalStage	queueId(String queueId)	The annotation queue referenced by the score.
ScoreBody._FinalStage	queueId(Optional<String> queueId)	The annotation queue referenced by the score.
ScoreBody._FinalStage	sessionId(String sessionId)
ScoreBody._FinalStage	sessionId(Optional<String> sessionId)
ScoreBody._FinalStage	traceId(String traceId)
ScoreBody._FinalStage	traceId(Optional<String> traceId)
ScoreBody._FinalStage	value(CreateScoreValue value)	The 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 ScoreBody.Builder from(ScoreBody other)

Specified by:

from in interface ScoreBody.NameStage

name

public ScoreBody.ValueStage name(@NotNull
 String name)

The name of the score. Always overrides "output" for correction scores.

The name of the score. Always overrides "output" for correction scores.

Specified by:

name in interface ScoreBody.NameStage

Returns:

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

value

public ScoreBody._FinalStage value(@NotNull
 CreateScoreValue value)

The value of the score. Must be passed as string for categorical scores, and numeric for boolean and numeric scores. Boolean score values must equal either 1 or 0 (true or false)

The value of the score. Must be passed as string for categorical scores, and numeric for boolean and numeric scores. Boolean score values must equal either 1 or 0 (true or false)

Specified by:

value in interface ScoreBody.ValueStage

Returns:

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

configId

public ScoreBody._FinalStage configId(String configId)

Reference a score config on a score. When set, the score name must equal the config name and scores must comply with the config's range and data type. For categorical scores, the value must map to a config category. Numeric scores might be constrained by the score config's max and min values

Specified by:

configId in interface ScoreBody._FinalStage

Returns:

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

configId

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

Reference a score config on a score. When set, the score name must equal the config name and scores must comply with the config's range and data type. For categorical scores, the value must map to a config category. Numeric scores might be constrained by the score config's max and min values

Specified by:

configId in interface ScoreBody._FinalStage

dataType

public ScoreBody._FinalStage dataType(ScoreDataType dataType)

When set, must match the score value's type. If not set, will be inferred from the score value or config

Specified by:

dataType in interface ScoreBody._FinalStage

Returns:

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

dataType

public ScoreBody._FinalStage dataType(Optional<ScoreDataType> dataType)

When set, must match the score value's type. If not set, will be inferred from the score value or config

Specified by:

dataType in interface ScoreBody._FinalStage

metadata

public ScoreBody._FinalStage metadata(Object metadata)

Specified by:

metadata in interface ScoreBody._FinalStage

metadata

public ScoreBody._FinalStage metadata(Optional<Object> metadata)

Specified by:

metadata in interface ScoreBody._FinalStage

comment

public ScoreBody._FinalStage comment(String comment)

Specified by:

comment in interface ScoreBody._FinalStage

comment

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

Specified by:

comment in interface ScoreBody._FinalStage

queueId

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

Returns:

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

queueId

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

environment

public ScoreBody._FinalStage environment(String environment)

Specified by:

environment in interface ScoreBody._FinalStage

environment

public ScoreBody._FinalStage environment(Optional<String> environment)

Specified by:

environment in interface ScoreBody._FinalStage

datasetRunId

public ScoreBody._FinalStage datasetRunId(String datasetRunId)

Specified by:

datasetRunId in interface ScoreBody._FinalStage

datasetRunId

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

Specified by:

datasetRunId in interface ScoreBody._FinalStage

observationId

public ScoreBody._FinalStage observationId(String observationId)

Specified by:

observationId in interface ScoreBody._FinalStage

observationId

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

Specified by:

observationId in interface ScoreBody._FinalStage

sessionId

public ScoreBody._FinalStage sessionId(String sessionId)

Specified by:

sessionId in interface ScoreBody._FinalStage

sessionId

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

Specified by:

sessionId in interface ScoreBody._FinalStage

traceId

public ScoreBody._FinalStage traceId(String traceId)

Specified by:

traceId in interface ScoreBody._FinalStage

traceId

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

Specified by:

traceId in interface ScoreBody._FinalStage

id

public ScoreBody._FinalStage id(String id)

Specified by:

id in interface ScoreBody._FinalStage

id

public ScoreBody._FinalStage id(Optional<String> id)

Specified by:

id in interface ScoreBody._FinalStage

build

public ScoreBody build()

Specified by:

build in interface ScoreBody._FinalStage

additionalProperty

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

Specified by:

additionalProperty in interface ScoreBody._FinalStage

additionalProperties

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

Specified by:

additionalProperties in interface ScoreBody._FinalStage