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

Class ObservationsView.Builder

java.lang.Object

com.ants.platform.client.resources.commons.types.ObservationsView.Builder

All Implemented Interfaces:

ObservationsView._FinalStage, ObservationsView.IdStage, ObservationsView.LevelStage, ObservationsView.StartTimeStage, ObservationsView.TypeStage

Enclosing class:

ObservationsView

public static final class ObservationsView.Builder
extends Object
implements ObservationsView.IdStage, ObservationsView.TypeStage, ObservationsView.StartTimeStage, ObservationsView.LevelStage, ObservationsView._FinalStage

Method Summary

Modifier and Type	Method	Description
ObservationsView	build()
ObservationsView._FinalStage	calculatedInputCost(Double calculatedInputCost)	(Deprecated.
ObservationsView._FinalStage	calculatedInputCost(Optional<Double> calculatedInputCost)
ObservationsView._FinalStage	calculatedOutputCost(Double calculatedOutputCost)	(Deprecated.
ObservationsView._FinalStage	calculatedOutputCost(Optional<Double> calculatedOutputCost)
ObservationsView._FinalStage	calculatedTotalCost(Double calculatedTotalCost)	(Deprecated.
ObservationsView._FinalStage	calculatedTotalCost(Optional<Double> calculatedTotalCost)
ObservationsView._FinalStage	completionStartTime(OffsetDateTime completionStartTime)	The completion start time of the observation
ObservationsView._FinalStage	completionStartTime(Optional<OffsetDateTime> completionStartTime)
ObservationsView._FinalStage	costDetails(Map<String,Double> costDetails)	The cost details of the observation.
ObservationsView._FinalStage	costDetails(Optional<Map<String,Double>> costDetails)
ObservationsView._FinalStage	endTime(OffsetDateTime endTime)	The end time of the observation.
ObservationsView._FinalStage	endTime(Optional<OffsetDateTime> endTime)
ObservationsView._FinalStage	environment(String environment)	The environment from which this observation originated.
ObservationsView._FinalStage	environment(Optional<String> environment)
ObservationsView.Builder	from(ObservationsView other)
ObservationsView.TypeStage	id(String id)	The unique identifier of the observation
ObservationsView._FinalStage	input(Object input)	The input data of the observation
ObservationsView._FinalStage	input(Optional<Object> input)
ObservationsView._FinalStage	inputPrice(Double inputPrice)	The price of the input in USD
ObservationsView._FinalStage	inputPrice(Optional<Double> inputPrice)
ObservationsView._FinalStage	latency(Double latency)	The latency in seconds.
ObservationsView._FinalStage	latency(Optional<Double> latency)
ObservationsView._FinalStage	level(ObservationLevel level)	The level of the observation
ObservationsView._FinalStage	metadata(Object metadata)	Additional metadata of the observation
ObservationsView._FinalStage	metadata(Optional<Object> metadata)
ObservationsView._FinalStage	model(String model)	The model used for the observation
ObservationsView._FinalStage	model(Optional<String> model)
ObservationsView._FinalStage	modelId(String modelId)	The unique identifier of the model
ObservationsView._FinalStage	modelId(Optional<String> modelId)
ObservationsView._FinalStage	modelParameters(Map<String,MapValue> modelParameters)	The parameters of the model used for the observation
ObservationsView._FinalStage	modelParameters(Optional<Map<String,MapValue>> modelParameters)
ObservationsView._FinalStage	name(String name)	The name of the observation
ObservationsView._FinalStage	name(Optional<String> name)
ObservationsView._FinalStage	output(Object output)	The output data of the observation
ObservationsView._FinalStage	output(Optional<Object> output)
ObservationsView._FinalStage	outputPrice(Double outputPrice)	The price of the output in USD.
ObservationsView._FinalStage	outputPrice(Optional<Double> outputPrice)
ObservationsView._FinalStage	parentObservationId(String parentObservationId)	The parent observation ID
ObservationsView._FinalStage	parentObservationId(Optional<String> parentObservationId)
ObservationsView._FinalStage	promptId(String promptId)	The prompt ID associated with the observation
ObservationsView._FinalStage	promptId(Optional<String> promptId)
ObservationsView._FinalStage	promptName(String promptName)	The name of the prompt associated with the observation
ObservationsView._FinalStage	promptName(Optional<String> promptName)
ObservationsView._FinalStage	promptVersion(Integer promptVersion)	The version of the prompt associated with the observation
ObservationsView._FinalStage	promptVersion(Optional<Integer> promptVersion)
ObservationsView.LevelStage	startTime(OffsetDateTime startTime)	The start time of the observation
ObservationsView._FinalStage	statusMessage(String statusMessage)	The status message of the observation
ObservationsView._FinalStage	statusMessage(Optional<String> statusMessage)
ObservationsView._FinalStage	timeToFirstToken(Double timeToFirstToken)	The time to the first token in seconds
ObservationsView._FinalStage	timeToFirstToken(Optional<Double> timeToFirstToken)
ObservationsView._FinalStage	totalPrice(Double totalPrice)	The total price in USD.
ObservationsView._FinalStage	totalPrice(Optional<Double> totalPrice)
ObservationsView._FinalStage	traceId(String traceId)	The trace ID associated with the observation
ObservationsView._FinalStage	traceId(Optional<String> traceId)
ObservationsView.StartTimeStage	type(String type)	The type of the observation
ObservationsView._FinalStage	usage(Usage usage)	(Deprecated.
ObservationsView._FinalStage	usage(Optional<Usage> usage)
ObservationsView._FinalStage	usageDetails(Map<String,Integer> usageDetails)	The usage details of the observation.
ObservationsView._FinalStage	usageDetails(Optional<Map<String,Integer>> usageDetails)
ObservationsView._FinalStage	version(String version)	The version of the observation
ObservationsView._FinalStage	version(Optional<String> version)

Methods inherited from class java.lang.Object

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

Method Details

from

public ObservationsView.Builder from(ObservationsView other)

Specified by:

from in interface ObservationsView.IdStage

id

public ObservationsView.TypeStage id(@NotNull
 String id)

The unique identifier of the observation

Specified by:

id in interface ObservationsView.IdStage

Returns:

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

type

public ObservationsView.StartTimeStage type(@NotNull
 String type)

The type of the observation

Specified by:

type in interface ObservationsView.TypeStage

Returns:

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

startTime

public ObservationsView.LevelStage startTime(@NotNull
 OffsetDateTime startTime)

The start time of the observation

Specified by:

startTime in interface ObservationsView.StartTimeStage

Returns:

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

level

public ObservationsView._FinalStage level(@NotNull
 ObservationLevel level)

The level of the observation

Specified by:

level in interface ObservationsView.LevelStage

Returns:

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

timeToFirstToken

public ObservationsView._FinalStage timeToFirstToken(Double timeToFirstToken)

The time to the first token in seconds

Specified by:

timeToFirstToken in interface ObservationsView._FinalStage

Returns:

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

timeToFirstToken

public ObservationsView._FinalStage timeToFirstToken(Optional<Double> timeToFirstToken)

Specified by:

timeToFirstToken in interface ObservationsView._FinalStage

latency

public ObservationsView._FinalStage latency(Double latency)

The latency in seconds.

Specified by:

latency in interface ObservationsView._FinalStage

Returns:

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

latency

public ObservationsView._FinalStage latency(Optional<Double> latency)

Specified by:

latency in interface ObservationsView._FinalStage

calculatedTotalCost

public ObservationsView._FinalStage calculatedTotalCost(Double calculatedTotalCost)

(Deprecated. Use usageDetails and costDetails instead.) The calculated total cost in USD

Specified by:

calculatedTotalCost in interface ObservationsView._FinalStage

Returns:

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

calculatedTotalCost

public ObservationsView._FinalStage calculatedTotalCost(Optional<Double> calculatedTotalCost)

Specified by:

calculatedTotalCost in interface ObservationsView._FinalStage

calculatedOutputCost

public ObservationsView._FinalStage calculatedOutputCost(Double calculatedOutputCost)

(Deprecated. Use usageDetails and costDetails instead.) The calculated cost of the output in USD

Specified by:

calculatedOutputCost in interface ObservationsView._FinalStage

Returns:

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

calculatedOutputCost

public ObservationsView._FinalStage calculatedOutputCost(Optional<Double> calculatedOutputCost)

Specified by:

calculatedOutputCost in interface ObservationsView._FinalStage

calculatedInputCost

public ObservationsView._FinalStage calculatedInputCost(Double calculatedInputCost)

(Deprecated. Use usageDetails and costDetails instead.) The calculated cost of the input in USD

Specified by:

calculatedInputCost in interface ObservationsView._FinalStage

Returns:

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

calculatedInputCost

public ObservationsView._FinalStage calculatedInputCost(Optional<Double> calculatedInputCost)

Specified by:

calculatedInputCost in interface ObservationsView._FinalStage

totalPrice

public ObservationsView._FinalStage totalPrice(Double totalPrice)

The total price in USD.

Specified by:

totalPrice in interface ObservationsView._FinalStage

Returns:

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

totalPrice

public ObservationsView._FinalStage totalPrice(Optional<Double> totalPrice)

Specified by:

totalPrice in interface ObservationsView._FinalStage

outputPrice

public ObservationsView._FinalStage outputPrice(Double outputPrice)

The price of the output in USD.

Specified by:

outputPrice in interface ObservationsView._FinalStage

Returns:

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

outputPrice

public ObservationsView._FinalStage outputPrice(Optional<Double> outputPrice)

Specified by:

outputPrice in interface ObservationsView._FinalStage

inputPrice

public ObservationsView._FinalStage inputPrice(Double inputPrice)

The price of the input in USD

Specified by:

inputPrice in interface ObservationsView._FinalStage

Returns:

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

inputPrice

public ObservationsView._FinalStage inputPrice(Optional<Double> inputPrice)

Specified by:

inputPrice in interface ObservationsView._FinalStage

modelId

public ObservationsView._FinalStage modelId(String modelId)

The unique identifier of the model

Specified by:

modelId in interface ObservationsView._FinalStage

Returns:

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

modelId

public ObservationsView._FinalStage modelId(Optional<String> modelId)

Specified by:

modelId in interface ObservationsView._FinalStage

promptVersion

public ObservationsView._FinalStage promptVersion(Integer promptVersion)

The version of the prompt associated with the observation

Specified by:

promptVersion in interface ObservationsView._FinalStage

Returns:

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

promptVersion

public ObservationsView._FinalStage promptVersion(Optional<Integer> promptVersion)

Specified by:

promptVersion in interface ObservationsView._FinalStage

promptName

public ObservationsView._FinalStage promptName(String promptName)

The name of the prompt associated with the observation

Specified by:

promptName in interface ObservationsView._FinalStage

Returns:

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

promptName

public ObservationsView._FinalStage promptName(Optional<String> promptName)

Specified by:

promptName in interface ObservationsView._FinalStage

environment

public ObservationsView._FinalStage environment(String environment)

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

Specified by:

environment in interface ObservationsView._FinalStage

Returns:

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

environment

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

Specified by:

environment in interface ObservationsView._FinalStage

costDetails

public ObservationsView._FinalStage costDetails(Map<String,Double> costDetails)

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.

Specified by:

costDetails in interface ObservationsView._FinalStage

Returns:

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

costDetails

public ObservationsView._FinalStage costDetails(Optional<Map<String,Double>> costDetails)

Specified by:

costDetails in interface ObservationsView._FinalStage

usageDetails

public ObservationsView._FinalStage usageDetails(Map<String,Integer> usageDetails)

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.

Specified by:

usageDetails in interface ObservationsView._FinalStage

Returns:

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

usageDetails

public ObservationsView._FinalStage usageDetails(Optional<Map<String,Integer>> usageDetails)

Specified by:

usageDetails in interface ObservationsView._FinalStage

promptId

public ObservationsView._FinalStage promptId(String promptId)

The prompt ID associated with the observation

Specified by:

promptId in interface ObservationsView._FinalStage

Returns:

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

promptId

public ObservationsView._FinalStage promptId(Optional<String> promptId)

Specified by:

promptId in interface ObservationsView._FinalStage

parentObservationId

public ObservationsView._FinalStage parentObservationId(String parentObservationId)

The parent observation ID

Specified by:

parentObservationId in interface ObservationsView._FinalStage

Returns:

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

parentObservationId

public ObservationsView._FinalStage parentObservationId(Optional<String> parentObservationId)

Specified by:

parentObservationId in interface ObservationsView._FinalStage

statusMessage

public ObservationsView._FinalStage statusMessage(String statusMessage)

The status message of the observation

Specified by:

statusMessage in interface ObservationsView._FinalStage

Returns:

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

statusMessage

public ObservationsView._FinalStage statusMessage(Optional<String> statusMessage)

Specified by:

statusMessage in interface ObservationsView._FinalStage

usage

public ObservationsView._FinalStage usage(Usage usage)

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

Specified by:

usage in interface ObservationsView._FinalStage

Returns:

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

usage

public ObservationsView._FinalStage usage(Optional<Usage> usage)

Specified by:

usage in interface ObservationsView._FinalStage

output

public ObservationsView._FinalStage output(Object output)

The output data of the observation

Specified by:

output in interface ObservationsView._FinalStage

Returns:

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

output

public ObservationsView._FinalStage output(Optional<Object> output)

Specified by:

output in interface ObservationsView._FinalStage

metadata

public ObservationsView._FinalStage metadata(Object metadata)

Additional metadata of the observation

Specified by:

metadata in interface ObservationsView._FinalStage

Returns:

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

metadata

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

Specified by:

metadata in interface ObservationsView._FinalStage

version

public ObservationsView._FinalStage version(String version)

The version of the observation

Specified by:

version in interface ObservationsView._FinalStage

Returns:

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

version

public ObservationsView._FinalStage version(Optional<String> version)

Specified by:

version in interface ObservationsView._FinalStage

input

public ObservationsView._FinalStage input(Object input)

The input data of the observation

Specified by:

input in interface ObservationsView._FinalStage

Returns:

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

input

public ObservationsView._FinalStage input(Optional<Object> input)

Specified by:

input in interface ObservationsView._FinalStage

modelParameters

public ObservationsView._FinalStage modelParameters(Map<String,MapValue> modelParameters)

The parameters of the model used for the observation

Specified by:

modelParameters in interface ObservationsView._FinalStage

Returns:

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

modelParameters

public ObservationsView._FinalStage modelParameters(Optional<Map<String,MapValue>> modelParameters)

Specified by:

modelParameters in interface ObservationsView._FinalStage

model

public ObservationsView._FinalStage model(String model)

The model used for the observation

Specified by:

model in interface ObservationsView._FinalStage

Returns:

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

model

public ObservationsView._FinalStage model(Optional<String> model)

Specified by:

model in interface ObservationsView._FinalStage

completionStartTime

public ObservationsView._FinalStage completionStartTime(OffsetDateTime completionStartTime)

The completion start time of the observation

Specified by:

completionStartTime in interface ObservationsView._FinalStage

Returns:

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

completionStartTime

public ObservationsView._FinalStage completionStartTime(Optional<OffsetDateTime> completionStartTime)

Specified by:

completionStartTime in interface ObservationsView._FinalStage

endTime

public ObservationsView._FinalStage endTime(OffsetDateTime endTime)

The end time of the observation.

Specified by:

endTime in interface ObservationsView._FinalStage

Returns:

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

endTime

public ObservationsView._FinalStage endTime(Optional<OffsetDateTime> endTime)

Specified by:

endTime in interface ObservationsView._FinalStage

name

public ObservationsView._FinalStage name(String name)

The name of the observation

Specified by:

name in interface ObservationsView._FinalStage

Returns:

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

name

public ObservationsView._FinalStage name(Optional<String> name)

Specified by:

name in interface ObservationsView._FinalStage

traceId

public ObservationsView._FinalStage traceId(String traceId)

The trace ID associated with the observation

Specified by:

traceId in interface ObservationsView._FinalStage

Returns:

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

traceId

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

Specified by:

traceId in interface ObservationsView._FinalStage

build

public ObservationsView build()

Specified by:

build in interface ObservationsView._FinalStage