Package com.langfuse.client.resources.trace.requests

Class GetTracesRequest.Builder

java.lang.Object

com.langfuse.client.resources.trace.requests.GetTracesRequest.Builder

Enclosing class:

GetTracesRequest

public static final class GetTracesRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
GetTracesRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
GetTracesRequest.Builder	additionalProperty(String key, Object value)
GetTracesRequest	build()
GetTracesRequest.Builder	environment(String environment)
GetTracesRequest.Builder	environment(List<String> environment)
GetTracesRequest.Builder	environment(Optional<List<String>> environment)	Optional filter for traces where the environment is one of the provided values.
GetTracesRequest.Builder	fields(String fields)
GetTracesRequest.Builder	fields(Optional<String> fields)	Comma-separated list of fields to include in the response.
GetTracesRequest.Builder	filter(String filter)
GetTracesRequest.Builder	filter(Optional<String> filter)	JSON string containing an array of filter conditions.
GetTracesRequest.Builder	from(GetTracesRequest other)
GetTracesRequest.Builder	fromTimestamp(OffsetDateTime fromTimestamp)
GetTracesRequest.Builder	fromTimestamp(Optional<OffsetDateTime> fromTimestamp)	Optional filter to only include traces with a trace.timestamp on or after a certain datetime (ISO 8601)
GetTracesRequest.Builder	limit(Integer limit)
GetTracesRequest.Builder	limit(Optional<Integer> limit)	Limit of items per page.
GetTracesRequest.Builder	name(String name)
GetTracesRequest.Builder	name(Optional<String> name)
GetTracesRequest.Builder	orderBy(String orderBy)
GetTracesRequest.Builder	orderBy(Optional<String> orderBy)	Format of the string [field].[asc/desc].
GetTracesRequest.Builder	page(Integer page)
GetTracesRequest.Builder	page(Optional<Integer> page)	Page number, starts at 1
GetTracesRequest.Builder	release(String release)
GetTracesRequest.Builder	release(Optional<String> release)	Optional filter to only include traces with a certain release.
GetTracesRequest.Builder	sessionId(String sessionId)
GetTracesRequest.Builder	sessionId(Optional<String> sessionId)
GetTracesRequest.Builder	tags(String tags)
GetTracesRequest.Builder	tags(List<String> tags)
GetTracesRequest.Builder	tags(Optional<List<String>> tags)	Only traces that include all of these tags will be returned.
GetTracesRequest.Builder	toTimestamp(OffsetDateTime toTimestamp)
GetTracesRequest.Builder	toTimestamp(Optional<OffsetDateTime> toTimestamp)	Optional filter to only include traces with a trace.timestamp before a certain datetime (ISO 8601)
GetTracesRequest.Builder	userId(String userId)
GetTracesRequest.Builder	userId(Optional<String> userId)
GetTracesRequest.Builder	version(String version)
GetTracesRequest.Builder	version(Optional<String> version)	Optional filter to only include traces with a certain version.

Methods inherited from class java.lang.Object

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

Method Details

from

public GetTracesRequest.Builder from(GetTracesRequest other)

tags

public GetTracesRequest.Builder tags(Optional<List<String>> tags)

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

tags

public GetTracesRequest.Builder tags(List<String> tags)

tags

public GetTracesRequest.Builder tags(String tags)

environment

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

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

environment

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

environment

public GetTracesRequest.Builder environment(String environment)

page

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

Page number, starts at 1

page

public GetTracesRequest.Builder page(Integer page)

limit

public GetTracesRequest.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 GetTracesRequest.Builder limit(Integer limit)

userId

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

userId

public GetTracesRequest.Builder userId(String userId)

name

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

name

public GetTracesRequest.Builder name(String name)

sessionId

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

sessionId

public GetTracesRequest.Builder sessionId(String sessionId)

fromTimestamp

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

Optional filter to only include traces with a trace.timestamp on or after a certain datetime (ISO 8601)

fromTimestamp

public GetTracesRequest.Builder fromTimestamp(OffsetDateTime fromTimestamp)

toTimestamp

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

Optional filter to only include traces with a trace.timestamp before a certain datetime (ISO 8601)

toTimestamp

public GetTracesRequest.Builder toTimestamp(OffsetDateTime toTimestamp)

orderBy

public GetTracesRequest.Builder orderBy(Optional<String> orderBy)

Format of the string [field].[asc/desc]. Fields: id, timestamp, name, userId, release, version, public, bookmarked, sessionId. Example: timestamp.asc

orderBy

public GetTracesRequest.Builder orderBy(String orderBy)

version

public GetTracesRequest.Builder version(Optional<String> version)

Optional filter to only include traces with a certain version.

version

public GetTracesRequest.Builder version(String version)

release

public GetTracesRequest.Builder release(Optional<String> release)

Optional filter to only include traces with a certain release.

release

public GetTracesRequest.Builder release(String release)

fields

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

Comma-separated list of fields to include in the response. Available field groups: 'core' (always included), 'io' (input, output, metadata), 'scores', 'observations', 'metrics'. If not specified, all fields are returned. Example: 'core,scores,metrics'. Note: Excluded 'observations' or 'scores' fields return empty arrays; excluded 'metrics' returns -1 for 'totalCost' and 'latency'.

fields

public GetTracesRequest.Builder fields(String fields)

filter

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

JSON string containing an array of filter conditions. When provided, this takes precedence over query parameter filters (userId, name, sessionId, tags, version, release, environment, fromTimestamp, toTimestamp).

filter

public GetTracesRequest.Builder filter(String filter)

build

public GetTracesRequest build()

additionalProperty

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

additionalProperties

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