Class Observation

java.lang.Object

com.ants.platform.client.resources.commons.types.Observation

All Implemented Interfaces:

IObservation

public final class Observation
extends Object
implements IObservation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Observation._FinalStage
static final class	Observation.Builder
static interface	Observation.IdStage
static interface	Observation.LevelStage
static interface	Observation.StartTimeStage
static interface	Observation.TypeStage

Method Summary

Modifier and Type	Method	Description
static Observation.IdStage	builder()
boolean	equals(Object other)
Map<String,Object>	getAdditionalProperties()
Optional<OffsetDateTime>	getCompletionStartTime()
Optional<Map<String,Double>>	getCostDetails()
Optional<OffsetDateTime>	getEndTime()
Optional<String>	getEnvironment()
String	getId()
Optional<Object>	getInput()
ObservationLevel	getLevel()
Optional<Object>	getMetadata()
Optional<String>	getModel()
Optional<Map<String,MapValue>>	getModelParameters()
Optional<String>	getName()
Optional<Object>	getOutput()
Optional<String>	getParentObservationId()
Optional<String>	getPromptId()
OffsetDateTime	getStartTime()
Optional<String>	getStatusMessage()
Optional<String>	getTraceId()
String	getType()
Optional<Usage>	getUsage()
Optional<Map<String,Integer>>	getUsageDetails()
Optional<String>	getVersion()
int	hashCode()
String	toString()

Methods inherited from class Object

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

Method Details

getId

public String getId()

Specified by:

getId in interface IObservation

Returns:

The unique identifier of the observation

getTraceId

public Optional<String> getTraceId()

Specified by:

getTraceId in interface IObservation

Returns:

The trace ID associated with the observation

getType

public String getType()

Specified by:

getType in interface IObservation

Returns:

The type of the observation

getName

public Optional<String> getName()

Specified by:

getName in interface IObservation

Returns:

The name of the observation

getStartTime

public OffsetDateTime getStartTime()

Specified by:

getStartTime in interface IObservation

Returns:

The start time of the observation

getEndTime

public Optional<OffsetDateTime> getEndTime()

Specified by:

getEndTime in interface IObservation

Returns:

The end time of the observation.

getCompletionStartTime

public Optional<OffsetDateTime> getCompletionStartTime()

Specified by:

getCompletionStartTime in interface IObservation

Returns:

The completion start time of the observation

getModel

public Optional<String> getModel()

Specified by:

getModel in interface IObservation

Returns:

The model used for the observation

getModelParameters

public Optional<Map<String,MapValue>> getModelParameters()

Specified by:

getModelParameters in interface IObservation

Returns:

The parameters of the model used for the observation

getInput

public Optional<Object> getInput()

Specified by:

getInput in interface IObservation

Returns:

The input data of the observation

getVersion

public Optional<String> getVersion()

Specified by:

getVersion in interface IObservation

Returns:

The version of the observation

getMetadata

public Optional<Object> getMetadata()

Specified by:

getMetadata in interface IObservation

Returns:

Additional metadata of the observation

getOutput

public Optional<Object> getOutput()

Specified by:

getOutput in interface IObservation

Returns:

The output data of the observation

getUsage

public Optional<Usage> getUsage()

Specified by:

getUsage in interface IObservation

Returns:

(Deprecated. Use usageDetails and costDetails instead.) The usage data of the observation

getLevel

public ObservationLevel getLevel()

Specified by:

getLevel in interface IObservation

Returns:

The level of the observation

getStatusMessage

public Optional<String> getStatusMessage()

Specified by:

getStatusMessage in interface IObservation

Returns:

The status message of the observation

getParentObservationId

public Optional<String> getParentObservationId()

Specified by:

getParentObservationId in interface IObservation

Returns:

The parent observation ID

getPromptId

public Optional<String> getPromptId()

Specified by:

getPromptId in interface IObservation

Returns:

The prompt ID associated with the observation

getUsageDetails

public Optional<Map<String,Integer>> getUsageDetails()

Specified by:

getUsageDetails in interface IObservation

Returns:

The usage details of the observation. Key is the name of the usage metric, value is the number of units consumed. The total key is the sum of all (non-total) usage metrics or the total value ingested.

getCostDetails

public Optional<Map<String,Double>> getCostDetails()

Specified by:

getCostDetails in interface IObservation

Returns:

The cost details of the observation. Key is the name of the cost metric, value is the cost in USD. The total key is the sum of all (non-total) cost metrics or the total value ingested.

getEnvironment

public Optional<String> getEnvironment()

Specified by:

getEnvironment in interface IObservation

Returns:

The environment from which this observation originated. Can be any lowercase alphanumeric string with hyphens and underscores that does not start with 'ants-platform'.

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 Observation.IdStage builder()