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

Usage

public final class Usage

Statistics on the interaction request's token usage.

Types

Builder

public final class Builder

A builder for Usage.

CachedTokensByModality

public final class CachedTokensByModality

The token count for a single response modality.

GroundingToolCount

public final class GroundingToolCount

The number of grounding tool counts.

InputTokensByModality

public final class InputTokensByModality

The token count for a single response modality.

OutputTokensByModality

public final class OutputTokensByModality

The token count for a single response modality.

ToolUseTokensByModality

public final class ToolUseTokensByModality

The token count for a single response modality.

Functions

_additionalProperties

public final Map<String, JsonValue> _additionalProperties()

_cachedTokensByModality

public final JsonField<List<Usage.CachedTokensByModality>> _cachedTokensByModality()

Returns the raw JSON value of cachedTokensByModality.

_groundingToolCount

public final JsonField<List<Usage.GroundingToolCount>> _groundingToolCount()

Returns the raw JSON value of groundingToolCount.

_inputTokensByModality

public final JsonField<List<Usage.InputTokensByModality>> _inputTokensByModality()

Returns the raw JSON value of inputTokensByModality.

_outputTokensByModality

public final JsonField<List<Usage.OutputTokensByModality>> _outputTokensByModality()

Returns the raw JSON value of outputTokensByModality.

_toolUseTokensByModality

public final JsonField<List<Usage.ToolUseTokensByModality>> _toolUseTokensByModality()

Returns the raw JSON value of toolUseTokensByModality.

_totalCachedTokens

public final JsonField<Integer> _totalCachedTokens()

Returns the raw JSON value of totalCachedTokens.

_totalInputTokens

public final JsonField<Integer> _totalInputTokens()

Returns the raw JSON value of totalInputTokens.

_totalOutputTokens

public final JsonField<Integer> _totalOutputTokens()

Returns the raw JSON value of totalOutputTokens.

_totalThoughtTokens

public final JsonField<Integer> _totalThoughtTokens()

Returns the raw JSON value of totalThoughtTokens.

_totalTokens

public final JsonField<Integer> _totalTokens()

Returns the raw JSON value of totalTokens.

_totalToolUseTokens

public final JsonField<Integer> _totalToolUseTokens()

Returns the raw JSON value of totalToolUseTokens.

builder

public final static Usage.Builder builder()

Returns a mutable builder for constructing an instance of Usage.

cachedTokensByModality

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

A breakdown of cached token usage by modality.

equals

public Boolean equals(Object other)

groundingToolCount

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

Grounding tool count.

hashCode

public Integer hashCode()

inputTokensByModality

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

A breakdown of input token usage by modality.

isValid

public final Boolean isValid()

outputTokensByModality

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

A breakdown of output token usage by modality.

toBuilder

public final Usage.Builder toBuilder()

toolUseTokensByModality

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

A breakdown of tool-use token usage by modality.

toString

public String toString()

totalCachedTokens

public final Optional<Integer> totalCachedTokens()

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

totalInputTokens

public final Optional<Integer> totalInputTokens()

Number of tokens in the prompt (context).

totalOutputTokens

public final Optional<Integer> totalOutputTokens()

Total number of tokens across all the generated responses.

totalThoughtTokens

public final Optional<Integer> totalThoughtTokens()

Number of tokens of thoughts for thinking models.

totalTokens

public final Optional<Integer> totalTokens()

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

totalToolUseTokens

public final Optional<Integer> totalToolUseTokens()

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

validate

public final Usage validate()