Class Model.Builder

java.lang.Object

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

All Implemented Interfaces:

Model._FinalStage, Model.IdStage, Model.IsAntsPlatformManagedStage, Model.MatchPatternStage, Model.ModelNameStage

Enclosing class:

Model

public static final class Model.Builder
extends Object
implements Model.IdStage, Model.ModelNameStage, Model.MatchPatternStage, Model.IsAntsPlatformManagedStage, Model._FinalStage

Method Summary

Modifier and Type	Method	Description
Model	build()
Model.Builder	from(Model other)
Model.ModelNameStage	id(String id)
Model._FinalStage	inputPrice(Double inputPrice)	Deprecated.
Model._FinalStage	inputPrice(Optional<Double> inputPrice)
Model._FinalStage	isAntsPlatformManaged(boolean isAntsPlatformManaged)
Model.IsAntsPlatformManagedStage	matchPattern(String matchPattern)	Regex pattern which matches this model definition to generation.model.
Model.MatchPatternStage	modelName(String modelName)	Name of the model definition.
Model._FinalStage	outputPrice(Double outputPrice)	Deprecated.
Model._FinalStage	outputPrice(Optional<Double> outputPrice)
Model._FinalStage	prices(String key, ModelPrice value)	Price (USD) by usage type
Model._FinalStage	prices(Map<String,ModelPrice> prices)
Model._FinalStage	putAllPrices(Map<String,ModelPrice> prices)	Price (USD) by usage type
Model._FinalStage	startDate(OffsetDateTime startDate)	Apply only to generations which are newer than this ISO date.
Model._FinalStage	startDate(Optional<OffsetDateTime> startDate)
Model._FinalStage	tokenizerConfig(Object tokenizerConfig)	Optional.
Model._FinalStage	tokenizerConfig(Optional<Object> tokenizerConfig)
Model._FinalStage	tokenizerId(String tokenizerId)	Optional.
Model._FinalStage	tokenizerId(Optional<String> tokenizerId)
Model._FinalStage	totalPrice(Double totalPrice)	Deprecated.
Model._FinalStage	totalPrice(Optional<Double> totalPrice)
Model._FinalStage	unit(ModelUsageUnit unit)	Unit used by this model.
Model._FinalStage	unit(Optional<ModelUsageUnit> unit)

Methods inherited from class java.lang.Object

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

Method Details

from

public Model.Builder from(Model other)

Specified by:

from in interface Model.IdStage

id

public Model.ModelNameStage id(@NotNull
 String id)

Specified by:

id in interface Model.IdStage

modelName

public Model.MatchPatternStage modelName(@NotNull
 String modelName)

Name of the model definition. If multiple with the same name exist, they are applied in the following order: (1) custom over built-in, (2) newest according to startTime where model.startTime<observation.startTime

Specified by:

modelName in interface Model.ModelNameStage

Returns:

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

matchPattern

public Model.IsAntsPlatformManagedStage matchPattern(@NotNull
 String matchPattern)

Regex pattern which matches this model definition to generation.model. Useful in case of fine-tuned models. If you want to exact match, use (?i)^modelname$

Specified by:

matchPattern in interface Model.MatchPatternStage

Returns:

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

isAntsPlatformManaged

public Model._FinalStage isAntsPlatformManaged(boolean isAntsPlatformManaged)

Specified by:

isAntsPlatformManaged in interface Model.IsAntsPlatformManagedStage

prices

public Model._FinalStage prices(String key,
 ModelPrice value)

Price (USD) by usage type

Specified by:

prices in interface Model._FinalStage

Returns:

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

putAllPrices

public Model._FinalStage putAllPrices(Map<String,ModelPrice> prices)

Price (USD) by usage type

Specified by:

putAllPrices in interface Model._FinalStage

Returns:

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

prices

public Model._FinalStage prices(Map<String,ModelPrice> prices)

Specified by:

prices in interface Model._FinalStage

tokenizerConfig

public Model._FinalStage tokenizerConfig(Object tokenizerConfig)

Optional. Configuration for the selected tokenizer. Needs to be JSON. See docs for more details.

Specified by:

tokenizerConfig in interface Model._FinalStage

Returns:

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

tokenizerConfig

public Model._FinalStage tokenizerConfig(Optional<Object> tokenizerConfig)

Specified by:

tokenizerConfig in interface Model._FinalStage

tokenizerId

public Model._FinalStage tokenizerId(String tokenizerId)

Optional. Tokenizer to be applied to observations which match to this model. See docs for more details.

Specified by:

tokenizerId in interface Model._FinalStage

Returns:

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

tokenizerId

public Model._FinalStage tokenizerId(Optional<String> tokenizerId)

Specified by:

tokenizerId in interface Model._FinalStage

totalPrice

public Model._FinalStage totalPrice(Double totalPrice)

Deprecated. See 'prices' instead. Price (USD) per total unit. Cannot be set if input or output price is set.

Specified by:

totalPrice in interface Model._FinalStage

Returns:

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

totalPrice

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

Specified by:

totalPrice in interface Model._FinalStage

outputPrice

public Model._FinalStage outputPrice(Double outputPrice)

Deprecated. See 'prices' instead. Price (USD) per output unit

Specified by:

outputPrice in interface Model._FinalStage

Returns:

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

outputPrice

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

Specified by:

outputPrice in interface Model._FinalStage

inputPrice

public Model._FinalStage inputPrice(Double inputPrice)

Deprecated. See 'prices' instead. Price (USD) per input unit

Specified by:

inputPrice in interface Model._FinalStage

Returns:

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

inputPrice

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

Specified by:

inputPrice in interface Model._FinalStage

unit

public Model._FinalStage unit(ModelUsageUnit unit)

Unit used by this model.

Specified by:

unit in interface Model._FinalStage

Returns:

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

unit

public Model._FinalStage unit(Optional<ModelUsageUnit> unit)

Specified by:

unit in interface Model._FinalStage

startDate

public Model._FinalStage startDate(OffsetDateTime startDate)

Apply only to generations which are newer than this ISO date.

Specified by:

startDate in interface Model._FinalStage

Returns:

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

startDate

public Model._FinalStage startDate(Optional<OffsetDateTime> startDate)

Specified by:

startDate in interface Model._FinalStage

build

public Model build()

Specified by:

build in interface Model._FinalStage