Package org.springframework.ai.chat.metadata

Class EmptyUsage

java.lang.Object

org.springframework.ai.chat.metadata.EmptyUsage

All Implemented Interfaces:

Usage

public class EmptyUsage
extends Object
implements Usage

A EmptyUsage implementation that returns zero for all property getters. All instances of this class are equal to each other.

Since:

0.7.0

Author:

John Blum, Ilayaperumal Gopinathan, Christian Tzolov

Constructor Summary

Constructors

Constructor	Description
EmptyUsage()

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object o)
Integer	getCompletionTokens()	Returns the number of tokens returned in the generation (aka completion) of the AI's response.
Object	getNativeUsage()	Return the usage data from the underlying model API response.
Integer	getPromptTokens()	Returns the number of tokens used in the prompt of the AI request.
int	hashCode()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.chat.metadata.Usage

getCacheReadInputTokens, getCacheWriteInputTokens, getTotalTokens

Constructor Details

EmptyUsage

public EmptyUsage()

Method Details

getPromptTokens

public Integer getPromptTokens()

Description copied from interface: Usage

Returns the number of tokens used in the prompt of the AI request.

Specified by:

getPromptTokens in interface Usage

Returns:

an Integer with the number of tokens used in the prompt of the AI request.

See Also:

• Usage.getCompletionTokens()

getCompletionTokens

public Integer getCompletionTokens()

Description copied from interface: Usage

Returns the number of tokens returned in the generation (aka completion) of the AI's response.

Specified by:

getCompletionTokens in interface Usage

Returns:

an Integer with the number of tokens returned in the generation (aka completion) of the AI's response.

See Also:

• Usage.getPromptTokens()

getNativeUsage

public Object getNativeUsage()

Description copied from interface: Usage

Return the usage data from the underlying model API response.

Specified by:

getNativeUsage in interface Usage

Returns:

the object of type inferred by the API response.

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object