Package io.github.glaforge.gemini.interactions.model

Record Class Interaction.Usage

java.lang.Object

java.lang.Record

io.github.glaforge.gemini.interactions.model.Interaction.Usage

Record Components:

totalInputTokens - Total input tokens.

inputTokensByModality - Input tokens broken down by modality.

totalCachedTokens - Total cached tokens.

cachedTokensByModality - Cached tokens broken down by modality.

totalOutputTokens - Total output tokens.

outputTokensByModality - Output tokens broken down by modality.

totalToolUseTokens - Total tool use tokens.

toolUseTokensByModality - Tool use tokens broken down by modality.

totalThoughtTokens - Total thought (reasoning) tokens.

totalTokens - Total tokens.

Enclosing class:

Interaction

public static record Interaction.Usage(Integer totalInputTokens, List<Interaction.ModalityTokens> inputTokensByModality, Integer totalCachedTokens, List<Interaction.ModalityTokens> cachedTokensByModality, Integer totalOutputTokens, List<Interaction.ModalityTokens> outputTokensByModality, Integer totalToolUseTokens, List<Interaction.ModalityTokens> toolUseTokensByModality, Integer totalThoughtTokens, Integer totalTokens)
extends Record

Token usage details.

Constructor Summary

Constructors

Constructor	Description
Usage(Integer totalInputTokens, List<Interaction.ModalityTokens> inputTokensByModality, Integer totalCachedTokens, List<Interaction.ModalityTokens> cachedTokensByModality, Integer totalOutputTokens, List<Interaction.ModalityTokens> outputTokensByModality, Integer totalToolUseTokens, List<Interaction.ModalityTokens> toolUseTokensByModality, Integer totalThoughtTokens, Integer totalTokens)	Creates an instance of a Usage record class.

Method Summary

Modifier and Type	Method	Description
List<Interaction.ModalityTokens>	cachedTokensByModality()	Returns the value of the cachedTokensByModality record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
List<Interaction.ModalityTokens>	inputTokensByModality()	Returns the value of the inputTokensByModality record component.
List<Interaction.ModalityTokens>	outputTokensByModality()	Returns the value of the outputTokensByModality record component.
List<Interaction.ModalityTokens>	toolUseTokensByModality()	Returns the value of the toolUseTokensByModality record component.
final String	toString()	Returns a string representation of this record class.
Integer	totalCachedTokens()	Returns the value of the totalCachedTokens record component.
Integer	totalInputTokens()	Returns the value of the totalInputTokens record component.
Integer	totalOutputTokens()	Returns the value of the totalOutputTokens record component.
Integer	totalThoughtTokens()	Returns the value of the totalThoughtTokens record component.
Integer	totalTokens()	Returns the value of the totalTokens record component.
Integer	totalToolUseTokens()	Returns the value of the totalToolUseTokens record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Usage

public Usage(Integer totalInputTokens,
 List<Interaction.ModalityTokens> inputTokensByModality,
 Integer totalCachedTokens,
 List<Interaction.ModalityTokens> cachedTokensByModality,
 Integer totalOutputTokens,
 List<Interaction.ModalityTokens> outputTokensByModality,
 Integer totalToolUseTokens,
 List<Interaction.ModalityTokens> toolUseTokensByModality,
 Integer totalThoughtTokens,
 Integer totalTokens)

Creates an instance of a Usage record class.

Parameters:

totalInputTokens - the value for the totalInputTokens record component

inputTokensByModality - the value for the inputTokensByModality record component

totalCachedTokens - the value for the totalCachedTokens record component

cachedTokensByModality - the value for the cachedTokensByModality record component

totalOutputTokens - the value for the totalOutputTokens record component

outputTokensByModality - the value for the outputTokensByModality record component

totalToolUseTokens - the value for the totalToolUseTokens record component

toolUseTokensByModality - the value for the toolUseTokensByModality record component

totalThoughtTokens - the value for the totalThoughtTokens record component

totalTokens - the value for the totalTokens record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

totalInputTokens

public Integer totalInputTokens()

Returns the value of the totalInputTokens record component.

Returns:

the value of the totalInputTokens record component

inputTokensByModality

public List<Interaction.ModalityTokens> inputTokensByModality()

Returns the value of the inputTokensByModality record component.

Returns:

the value of the inputTokensByModality record component

totalCachedTokens

public Integer totalCachedTokens()

Returns the value of the totalCachedTokens record component.

Returns:

the value of the totalCachedTokens record component

cachedTokensByModality

public List<Interaction.ModalityTokens> cachedTokensByModality()

Returns the value of the cachedTokensByModality record component.

Returns:

the value of the cachedTokensByModality record component

totalOutputTokens

public Integer totalOutputTokens()

Returns the value of the totalOutputTokens record component.

Returns:

the value of the totalOutputTokens record component

outputTokensByModality

public List<Interaction.ModalityTokens> outputTokensByModality()

Returns the value of the outputTokensByModality record component.

Returns:

the value of the outputTokensByModality record component

totalToolUseTokens

public Integer totalToolUseTokens()

Returns the value of the totalToolUseTokens record component.

Returns:

the value of the totalToolUseTokens record component

toolUseTokensByModality

public List<Interaction.ModalityTokens> toolUseTokensByModality()

Returns the value of the toolUseTokensByModality record component.

Returns:

the value of the toolUseTokensByModality record component

totalThoughtTokens

public Integer totalThoughtTokens()

Returns the value of the totalThoughtTokens record component.

Returns:

the value of the totalThoughtTokens record component

totalTokens

public Integer totalTokens()

Returns the value of the totalTokens record component.

Returns:

the value of the totalTokens record component