google-genai/com.google.genai.interactions.models.interactions/Usage/Builder

Builder

public final class Builder

A builder for Usage.

Functions

addCachedTokensByModality

public final Usage.Builder addCachedTokensByModality(Usage.CachedTokensByModality cachedTokensByModality)

Adds a single CachedTokensByModality to Builder.cachedTokensByModality.

addGroundingToolCount

public final Usage.Builder addGroundingToolCount(Usage.GroundingToolCount groundingToolCount)

Adds a single GroundingToolCount to Builder.groundingToolCount.

addInputTokensByModality

public final Usage.Builder addInputTokensByModality(Usage.InputTokensByModality inputTokensByModality)

Adds a single InputTokensByModality to Builder.inputTokensByModality.

additionalProperties

public final Usage.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

addOutputTokensByModality

public final Usage.Builder addOutputTokensByModality(Usage.OutputTokensByModality outputTokensByModality)

Adds a single OutputTokensByModality to Builder.outputTokensByModality.

addToolUseTokensByModality

public final Usage.Builder addToolUseTokensByModality(Usage.ToolUseTokensByModality toolUseTokensByModality)

Adds a single ToolUseTokensByModality to Builder.toolUseTokensByModality.

build

public final Usage build()

Returns an immutable instance of Usage.

cachedTokensByModality

public final Usage.Builder cachedTokensByModality(JsonField<List<Usage.CachedTokensByModality>> cachedTokensByModality)

Sets Builder.cachedTokensByModality to an arbitrary JSON value.

public final Usage.Builder cachedTokensByModality(List<Usage.CachedTokensByModality> cachedTokensByModality)

A breakdown of cached token usage by modality.

groundingToolCount

public final Usage.Builder groundingToolCount(JsonField<List<Usage.GroundingToolCount>> groundingToolCount)

Sets Builder.groundingToolCount to an arbitrary JSON value.

public final Usage.Builder groundingToolCount(List<Usage.GroundingToolCount> groundingToolCount)

Grounding tool count.

inputTokensByModality

public final Usage.Builder inputTokensByModality(JsonField<List<Usage.InputTokensByModality>> inputTokensByModality)

Sets Builder.inputTokensByModality to an arbitrary JSON value.

public final Usage.Builder inputTokensByModality(List<Usage.InputTokensByModality> inputTokensByModality)

A breakdown of input token usage by modality.

outputTokensByModality

public final Usage.Builder outputTokensByModality(JsonField<List<Usage.OutputTokensByModality>> outputTokensByModality)

Sets Builder.outputTokensByModality to an arbitrary JSON value.

public final Usage.Builder outputTokensByModality(List<Usage.OutputTokensByModality> outputTokensByModality)

A breakdown of output token usage by modality.

putAdditionalProperty

public final Usage.Builder putAdditionalProperty(String key, JsonValue value)

putAllAdditionalProperties

public final Usage.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

removeAdditionalProperty

public final Usage.Builder removeAdditionalProperty(String key)

removeAllAdditionalProperties

public final Usage.Builder removeAllAdditionalProperties(Set<String> keys)

toolUseTokensByModality

public final Usage.Builder toolUseTokensByModality(JsonField<List<Usage.ToolUseTokensByModality>> toolUseTokensByModality)

Sets Builder.toolUseTokensByModality to an arbitrary JSON value.

public final Usage.Builder toolUseTokensByModality(List<Usage.ToolUseTokensByModality> toolUseTokensByModality)

A breakdown of tool-use token usage by modality.

totalCachedTokens

public final Usage.Builder totalCachedTokens(JsonField<Integer> totalCachedTokens)

Sets Builder.totalCachedTokens to an arbitrary JSON value.

public final Usage.Builder totalCachedTokens(Integer totalCachedTokens)

Number of tokens in the cached part of the prompt (the cached content).

totalInputTokens

public final Usage.Builder totalInputTokens(JsonField<Integer> totalInputTokens)

Sets Builder.totalInputTokens to an arbitrary JSON value.

public final Usage.Builder totalInputTokens(Integer totalInputTokens)

Number of tokens in the prompt (context).

totalOutputTokens

public final Usage.Builder totalOutputTokens(JsonField<Integer> totalOutputTokens)

Sets Builder.totalOutputTokens to an arbitrary JSON value.

public final Usage.Builder totalOutputTokens(Integer totalOutputTokens)

Total number of tokens across all the generated responses.

totalThoughtTokens

public final Usage.Builder totalThoughtTokens(JsonField<Integer> totalThoughtTokens)

Sets Builder.totalThoughtTokens to an arbitrary JSON value.

public final Usage.Builder totalThoughtTokens(Integer totalThoughtTokens)

Number of tokens of thoughts for thinking models.

totalTokens

public final Usage.Builder totalTokens(JsonField<Integer> totalTokens)

Sets Builder.totalTokens to an arbitrary JSON value.

public final Usage.Builder totalTokens(Integer totalTokens)

Total token count for the interaction request (prompt + responses + other internal tokens).

totalToolUseTokens

public final Usage.Builder totalToolUseTokens(JsonField<Integer> totalToolUseTokens)

Sets Builder.totalToolUseTokens to an arbitrary JSON value.

public final Usage.Builder totalToolUseTokens(Integer totalToolUseTokens)

Number of tokens present in tool-use prompt(s).