Record Class AnthropicApi.Usage

java.lang.Object

java.lang.Record

org.springframework.ai.anthropic.api.AnthropicApi.Usage

Record Components:

inputTokens - The number of input tokens which were used.

outputTokens - The number of output tokens which were used. completion).

Enclosing class:

AnthropicApi

public static record AnthropicApi.Usage(Integer inputTokens, Integer outputTokens, Integer cacheCreationInputTokens, Integer cacheReadInputTokens)
extends Record

Usage statistics.

Since:

1.0.0

Author:

Christian Tzolov, Mariusz Bernacki, Thomas Vitale, Jihoon Kim, Alexandros Pappas, Jonghoon Park, Claudio Silva Junior, Filip Hrisafov, Soby Chacko, Austin Dase

Constructor Summary

Constructors

Constructor	Description
Usage(Integer inputTokens, Integer outputTokens, Integer cacheCreationInputTokens, Integer cacheReadInputTokens)	Creates an instance of a Usage record class.

Method Summary

Modifier and Type	Method	Description
Integer	cacheCreationInputTokens()	Returns the value of the cacheCreationInputTokens record component.
Integer	cacheReadInputTokens()	Returns the value of the cacheReadInputTokens 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.
Integer	inputTokens()	Returns the value of the inputTokens record component.
Integer	outputTokens()	Returns the value of the outputTokens record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

Usage

public Usage(Integer inputTokens,
 Integer outputTokens,
 Integer cacheCreationInputTokens,
 Integer cacheReadInputTokens)

Creates an instance of a Usage record class.

Parameters:

inputTokens - the value for the inputTokens record component

outputTokens - the value for the outputTokens record component

cacheCreationInputTokens - the value for the cacheCreationInputTokens record component

cacheReadInputTokens - the value for the cacheReadInputTokens 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.

inputTokens

public Integer inputTokens()

Returns the value of the inputTokens record component.

Returns:

the value of the inputTokens record component

outputTokens

public Integer outputTokens()

Returns the value of the outputTokens record component.

Returns:

the value of the outputTokens record component

cacheCreationInputTokens

public Integer cacheCreationInputTokens()

Returns the value of the cacheCreationInputTokens record component.

Returns:

the value of the cacheCreationInputTokens record component

cacheReadInputTokens

public Integer cacheReadInputTokens()

Returns the value of the cacheReadInputTokens record component.

Returns:

the value of the cacheReadInputTokens record component