Class BaseScore

java.lang.Object

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

All Implemented Interfaces:

IBaseScore

public final class BaseScore
extends Object
implements IBaseScore

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BaseScore._FinalStage
static final class	BaseScore.Builder
static interface	BaseScore.CreatedAtStage
static interface	BaseScore.EnvironmentStage
static interface	BaseScore.IdStage
static interface	BaseScore.MetadataStage
static interface	BaseScore.NameStage
static interface	BaseScore.SourceStage
static interface	BaseScore.TimestampStage
static interface	BaseScore.UpdatedAtStage

Method Summary

Modifier and Type	Method	Description
static BaseScore.IdStage	builder()
boolean	equals(Object other)
Map<String,Object>	getAdditionalProperties()
Optional<String>	getAuthorUserId()
Optional<String>	getComment()
Optional<String>	getConfigId()
OffsetDateTime	getCreatedAt()
Optional<String>	getDatasetRunId()
String	getEnvironment()
String	getId()
Object	getMetadata()
String	getName()
Optional<String>	getObservationId()
Optional<String>	getQueueId()
Optional<String>	getSessionId()
ScoreSource	getSource()
OffsetDateTime	getTimestamp()
Optional<String>	getTraceId()
OffsetDateTime	getUpdatedAt()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getId

public String getId()

Specified by:

getId in interface IBaseScore

getTraceId

public Optional<String> getTraceId()

Specified by:

getTraceId in interface IBaseScore

Returns:

The trace ID associated with the score

getSessionId

public Optional<String> getSessionId()

Specified by:

getSessionId in interface IBaseScore

Returns:

The session ID associated with the score

getObservationId

public Optional<String> getObservationId()

Specified by:

getObservationId in interface IBaseScore

Returns:

The observation ID associated with the score

getDatasetRunId

public Optional<String> getDatasetRunId()

Specified by:

getDatasetRunId in interface IBaseScore

Returns:

The dataset run ID associated with the score

getName

public String getName()

Specified by:

getName in interface IBaseScore

getSource

public ScoreSource getSource()

Specified by:

getSource in interface IBaseScore

getTimestamp

public OffsetDateTime getTimestamp()

Specified by:

getTimestamp in interface IBaseScore

getCreatedAt

public OffsetDateTime getCreatedAt()

Specified by:

getCreatedAt in interface IBaseScore

getUpdatedAt

public OffsetDateTime getUpdatedAt()

Specified by:

getUpdatedAt in interface IBaseScore

getAuthorUserId

public Optional<String> getAuthorUserId()

Specified by:

getAuthorUserId in interface IBaseScore

Returns:

The user ID of the author

getComment

public Optional<String> getComment()

Specified by:

getComment in interface IBaseScore

Returns:

Comment on the score

getMetadata

public Object getMetadata()

Specified by:

getMetadata in interface IBaseScore

Returns:

Metadata associated with the score

getConfigId

public Optional<String> getConfigId()

Specified by:

getConfigId in interface IBaseScore

Returns:

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

getQueueId

public Optional<String> getQueueId()

Specified by:

getQueueId in interface IBaseScore

Returns:

The annotation queue referenced by the score. Indicates if score was initially created while processing annotation queue.

getEnvironment

public String getEnvironment()

Specified by:

getEnvironment in interface IBaseScore

Returns:

The environment from which this score originated. Can be any lowercase alphanumeric string with hyphens and underscores that does not start with 'langfuse'.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static BaseScore.IdStage builder()