Package ai.vectros.types

Class DoneEvent.Builder

java.lang.Object

ai.vectros.types.DoneEvent.Builder

All Implemented Interfaces:

DoneEvent._FinalStage, DoneEvent.EventStage, DoneEvent.InferenceBalanceCentsChargedStage, DoneEvent.InputTokensStage, DoneEvent.ModelStage, DoneEvent.OutputTokensStage, DoneEvent.PlatformCreditsChargedStage

Enclosing class:

DoneEvent

public static final class DoneEvent.Builder
extends Object
implements DoneEvent.EventStage, DoneEvent.InputTokensStage, DoneEvent.OutputTokensStage, DoneEvent.ModelStage, DoneEvent.PlatformCreditsChargedStage, DoneEvent.InferenceBalanceCentsChargedStage, DoneEvent._FinalStage

Method Summary

Modifier and Type	Method	Description
DoneEvent.Builder	additionalProperties(Map<String,Object> additionalProperties)
DoneEvent.Builder	additionalProperty(String key, Object value)
DoneEvent	build()
DoneEvent._FinalStage	cacheCreateTokens(Integer cacheCreateTokens)	Number of tokens written to the prompt cache.
DoneEvent._FinalStage	cacheCreateTokens(Optional<Integer> cacheCreateTokens)	Number of tokens written to the prompt cache.
DoneEvent._FinalStage	cacheReadTokens(Integer cacheReadTokens)	Number of input tokens served from the prompt cache.
DoneEvent._FinalStage	cacheReadTokens(Optional<Integer> cacheReadTokens)	Number of input tokens served from the prompt cache.
DoneEvent.InputTokensStage	event(@NotNull DoneEventEvent event)	Backward-compatible alias of type.
DoneEvent.Builder	from(DoneEvent other)
DoneEvent._FinalStage	inferenceBalanceCentsCharged(long inferenceBalanceCentsCharged)	Cents debited from your pre-paid inference balance for the model's token cost.
DoneEvent.OutputTokensStage	inputTokens(int inputTokens)	Total input tokens consumed by the model, including the system prompt and all messages.
DoneEvent.PlatformCreditsChargedStage	model(@NotNull String model)	The model alias used for this call.
DoneEvent.ModelStage	outputTokens(int outputTokens)	Total output tokens generated by the model.
DoneEvent.InferenceBalanceCentsChargedStage	platformCreditsCharged(double platformCreditsCharged)	Credits debited from your monthly plan allowance for this call's per-call platform overhead.

Methods inherited from class java.lang.Object

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

Method Details

from

public DoneEvent.Builder from(DoneEvent other)

Specified by:

from in interface DoneEvent.EventStage

event

public DoneEvent.InputTokensStage event(@NotNull
 @NotNull DoneEventEvent event)

Backward-compatible alias of type. Always done.

Backward-compatible alias of type. Always done.

Specified by:

event in interface DoneEvent.EventStage

Returns:

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

inputTokens

public DoneEvent.OutputTokensStage inputTokens(int inputTokens)

Total input tokens consumed by the model, including the system prompt and all messages.

Total input tokens consumed by the model, including the system prompt and all messages.

Specified by:

inputTokens in interface DoneEvent.InputTokensStage

Returns:

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

outputTokens

public DoneEvent.ModelStage outputTokens(int outputTokens)

Total output tokens generated by the model.

Total output tokens generated by the model.

Specified by:

outputTokens in interface DoneEvent.OutputTokensStage

Returns:

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

model

public DoneEvent.PlatformCreditsChargedStage model(@NotNull
 @NotNull String model)

The model alias used for this call.

The model alias used for this call.

Specified by:

model in interface DoneEvent.ModelStage

Returns:

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

platformCreditsCharged

public DoneEvent.InferenceBalanceCentsChargedStage platformCreditsCharged(double platformCreditsCharged)

Credits debited from your monthly plan allowance for this call's per-call platform overhead. One credit equals one cent.

Credits debited from your monthly plan allowance for this call's per-call platform overhead. One credit equals one cent.

Specified by:

platformCreditsCharged in interface DoneEvent.PlatformCreditsChargedStage

Returns:

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

inferenceBalanceCentsCharged

public DoneEvent._FinalStage inferenceBalanceCentsCharged(long inferenceBalanceCentsCharged)

Cents debited from your pre-paid inference balance for the model's token cost.

Cents debited from your pre-paid inference balance for the model's token cost.

Specified by:

inferenceBalanceCentsCharged in interface DoneEvent.InferenceBalanceCentsChargedStage

Returns:

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

cacheCreateTokens

public DoneEvent._FinalStage cacheCreateTokens(Integer cacheCreateTokens)

Number of tokens written to the prompt cache. Present only when prompt caching applied to this call. Prompt caching is not yet used; this field is reserved for forward compatibility.

Specified by:

cacheCreateTokens in interface DoneEvent._FinalStage

Returns:

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

cacheCreateTokens

public DoneEvent._FinalStage cacheCreateTokens(Optional<Integer> cacheCreateTokens)

Number of tokens written to the prompt cache. Present only when prompt caching applied to this call. Prompt caching is not yet used; this field is reserved for forward compatibility.

Specified by:

cacheCreateTokens in interface DoneEvent._FinalStage

cacheReadTokens

public DoneEvent._FinalStage cacheReadTokens(Integer cacheReadTokens)

Number of input tokens served from the prompt cache. Present only when prompt caching applied to this call. Prompt caching is not yet used; this field is reserved for forward compatibility.

Specified by:

cacheReadTokens in interface DoneEvent._FinalStage

Returns:

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

cacheReadTokens

public DoneEvent._FinalStage cacheReadTokens(Optional<Integer> cacheReadTokens)

Number of input tokens served from the prompt cache. Present only when prompt caching applied to this call. Prompt caching is not yet used; this field is reserved for forward compatibility.

Specified by:

cacheReadTokens in interface DoneEvent._FinalStage

build

public DoneEvent build()

Specified by:

build in interface DoneEvent._FinalStage

additionalProperty

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

Specified by:

additionalProperty in interface DoneEvent._FinalStage

additionalProperties

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

Specified by:

additionalProperties in interface DoneEvent._FinalStage