Package com.langfuse.client.resources.scorev2.requests

Class GetScoresRequest.Builder

java.lang.Object

com.langfuse.client.resources.scorev2.requests.GetScoresRequest.Builder

Enclosing class:

GetScoresRequest

public static final class GetScoresRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
GetScoresRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
GetScoresRequest.Builder	additionalProperty(String key, Object value)
GetScoresRequest	build()
GetScoresRequest.Builder	configId(String configId)
GetScoresRequest.Builder	configId(Optional<String> configId)	Retrieve only scores with a specific configId.
GetScoresRequest.Builder	datasetRunId(String datasetRunId)
GetScoresRequest.Builder	datasetRunId(Optional<String> datasetRunId)	Retrieve only scores with a specific datasetRunId.
GetScoresRequest.Builder	dataType(ScoreDataType dataType)
GetScoresRequest.Builder	dataType(Optional<ScoreDataType> dataType)	Retrieve only scores with a specific dataType.
GetScoresRequest.Builder	environment(String environment)
GetScoresRequest.Builder	environment(List<String> environment)
GetScoresRequest.Builder	environment(Optional<List<String>> environment)	Optional filter for scores where the environment is one of the provided values.
GetScoresRequest.Builder	fields(String fields)
GetScoresRequest.Builder	fields(Optional<String> fields)	Comma-separated list of field groups to include in the response.
GetScoresRequest.Builder	filter(String filter)
GetScoresRequest.Builder	filter(Optional<String> filter)	A JSON stringified array of filter objects.
GetScoresRequest.Builder	from(GetScoresRequest other)
GetScoresRequest.Builder	fromTimestamp(OffsetDateTime fromTimestamp)
GetScoresRequest.Builder	fromTimestamp(Optional<OffsetDateTime> fromTimestamp)	Optional filter to only include scores created on or after a certain datetime (ISO 8601)
GetScoresRequest.Builder	limit(Integer limit)
GetScoresRequest.Builder	limit(Optional<Integer> limit)	Limit of items per page.
GetScoresRequest.Builder	name(String name)
GetScoresRequest.Builder	name(Optional<String> name)	Retrieve only scores with this name.
GetScoresRequest.Builder	observationId(String observationId)
GetScoresRequest.Builder	observationId(Optional<String> observationId)	Comma-separated list of observation IDs to filter scores by.
GetScoresRequest.Builder	operator(String operator)
GetScoresRequest.Builder	operator(Optional<String> operator)	Retrieve only scores with <operator> value.
GetScoresRequest.Builder	page(Integer page)
GetScoresRequest.Builder	page(Optional<Integer> page)	Page number, starts at 1.
GetScoresRequest.Builder	queueId(String queueId)
GetScoresRequest.Builder	queueId(Optional<String> queueId)	Retrieve only scores with a specific annotation queueId.
GetScoresRequest.Builder	scoreIds(String scoreIds)
GetScoresRequest.Builder	scoreIds(Optional<String> scoreIds)	Comma-separated list of score IDs to limit the results to.
GetScoresRequest.Builder	sessionId(String sessionId)
GetScoresRequest.Builder	sessionId(Optional<String> sessionId)	Retrieve only scores with a specific sessionId.
GetScoresRequest.Builder	source(ScoreSource source)
GetScoresRequest.Builder	source(Optional<ScoreSource> source)	Retrieve only scores from a specific source.
GetScoresRequest.Builder	toTimestamp(OffsetDateTime toTimestamp)
GetScoresRequest.Builder	toTimestamp(Optional<OffsetDateTime> toTimestamp)	Optional filter to only include scores created before a certain datetime (ISO 8601)
GetScoresRequest.Builder	traceId(String traceId)
GetScoresRequest.Builder	traceId(Optional<String> traceId)	Retrieve only scores with a specific traceId.
GetScoresRequest.Builder	traceTags(String traceTags)
GetScoresRequest.Builder	traceTags(List<String> traceTags)
GetScoresRequest.Builder	traceTags(Optional<List<String>> traceTags)	Only scores linked to traces that include all of these tags will be returned.
GetScoresRequest.Builder	userId(String userId)
GetScoresRequest.Builder	userId(Optional<String> userId)	Retrieve only scores with this userId associated to the trace.
GetScoresRequest.Builder	value(Double value)
GetScoresRequest.Builder	value(Optional<Double> value)	Retrieve only scores with <operator> value.

Methods inherited from class java.lang.Object

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

Method Details

from

public GetScoresRequest.Builder from(GetScoresRequest other)

environment

public GetScoresRequest.Builder environment(Optional<List<String>> environment)

Optional filter for scores where the environment is one of the provided values.

environment

public GetScoresRequest.Builder environment(List<String> environment)

environment

public GetScoresRequest.Builder environment(String environment)

traceTags

public GetScoresRequest.Builder traceTags(Optional<List<String>> traceTags)

Only scores linked to traces that include all of these tags will be returned.

traceTags

public GetScoresRequest.Builder traceTags(List<String> traceTags)

traceTags

public GetScoresRequest.Builder traceTags(String traceTags)

page

public GetScoresRequest.Builder page(Optional<Integer> page)

Page number, starts at 1.

page

public GetScoresRequest.Builder page(Integer page)

limit

public GetScoresRequest.Builder limit(Optional<Integer> limit)

Limit of items per page. If you encounter api issues due to too large page sizes, try to reduce the limit.

limit

public GetScoresRequest.Builder limit(Integer limit)

userId

public GetScoresRequest.Builder userId(Optional<String> userId)

Retrieve only scores with this userId associated to the trace.

userId

public GetScoresRequest.Builder userId(String userId)

name

public GetScoresRequest.Builder name(Optional<String> name)

Retrieve only scores with this name.

name

public GetScoresRequest.Builder name(String name)

fromTimestamp

public GetScoresRequest.Builder fromTimestamp(Optional<OffsetDateTime> fromTimestamp)

Optional filter to only include scores created on or after a certain datetime (ISO 8601)

fromTimestamp

public GetScoresRequest.Builder fromTimestamp(OffsetDateTime fromTimestamp)

toTimestamp

public GetScoresRequest.Builder toTimestamp(Optional<OffsetDateTime> toTimestamp)

Optional filter to only include scores created before a certain datetime (ISO 8601)

toTimestamp

public GetScoresRequest.Builder toTimestamp(OffsetDateTime toTimestamp)

source

public GetScoresRequest.Builder source(Optional<ScoreSource> source)

Retrieve only scores from a specific source.

source

public GetScoresRequest.Builder source(ScoreSource source)

operator

public GetScoresRequest.Builder operator(Optional<String> operator)

Retrieve only scores with <operator> value.

operator

public GetScoresRequest.Builder operator(String operator)

value

public GetScoresRequest.Builder value(Optional<Double> value)

Retrieve only scores with <operator> value.

value

public GetScoresRequest.Builder value(Double value)

scoreIds

public GetScoresRequest.Builder scoreIds(Optional<String> scoreIds)

Comma-separated list of score IDs to limit the results to.

scoreIds

public GetScoresRequest.Builder scoreIds(String scoreIds)

configId

public GetScoresRequest.Builder configId(Optional<String> configId)

Retrieve only scores with a specific configId.

configId

public GetScoresRequest.Builder configId(String configId)

sessionId

public GetScoresRequest.Builder sessionId(Optional<String> sessionId)

Retrieve only scores with a specific sessionId.

sessionId

public GetScoresRequest.Builder sessionId(String sessionId)

datasetRunId

public GetScoresRequest.Builder datasetRunId(Optional<String> datasetRunId)

Retrieve only scores with a specific datasetRunId.

datasetRunId

public GetScoresRequest.Builder datasetRunId(String datasetRunId)

traceId

public GetScoresRequest.Builder traceId(Optional<String> traceId)

Retrieve only scores with a specific traceId.

traceId

public GetScoresRequest.Builder traceId(String traceId)

observationId

public GetScoresRequest.Builder observationId(Optional<String> observationId)

Comma-separated list of observation IDs to filter scores by.

observationId

public GetScoresRequest.Builder observationId(String observationId)

queueId

public GetScoresRequest.Builder queueId(Optional<String> queueId)

Retrieve only scores with a specific annotation queueId.

queueId

public GetScoresRequest.Builder queueId(String queueId)

dataType

public GetScoresRequest.Builder dataType(Optional<ScoreDataType> dataType)

Retrieve only scores with a specific dataType.

dataType

public GetScoresRequest.Builder dataType(ScoreDataType dataType)

fields

public GetScoresRequest.Builder fields(Optional<String> fields)

Comma-separated list of field groups to include in the response. Available field groups: 'score' (core score fields), 'trace' (trace properties: userId, tags, environment). If not specified, both 'score' and 'trace' are returned by default. Example: 'score' to exclude trace data, 'score,trace' to include both. Note: When filtering by trace properties (using userId or traceTags parameters), the 'trace' field group must be included, otherwise a 400 error will be returned.

fields

public GetScoresRequest.Builder fields(String fields)

filter

public GetScoresRequest.Builder filter(Optional<String> filter)

A JSON stringified array of filter objects. Each object requires type, column, operator, and value. Supports filtering by score metadata using the stringObject type. Example: [{"type":"stringObject","column":"metadata","key":"user_id","operator":"=","value":"abc123"}]. Supported types: stringObject (metadata key-value filtering), string, number, datetime, stringOptions, arrayOptions. Supported operators for stringObject: =, contains, does not contain, starts with, ends with.

filter

public GetScoresRequest.Builder filter(String filter)

build

public GetScoresRequest build()

additionalProperty

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

additionalProperties

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