Package org.springframework.ai.mistralai.metadata

Class MistralAiUsage

java.lang.Object

org.springframework.ai.mistralai.metadata.MistralAiUsage

All Implemented Interfaces:

Usage

public class MistralAiUsage
extends Object
implements Usage

Usage implementation for Mistral AI.

Since:

1.0.0

Author:

Thomas Vitale

See Also:

• Chat Completion API

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MistralAiUsage(MistralAiApi.Usage usage)

Method Summary

Modifier and Type	Method	Description
static MistralAiUsage	from(MistralAiApi.Usage usage)
Long	getGenerationTokens()	Returns the number of tokens returned in the generation (aka completion) of the AI's response.
Long	getPromptTokens()	Returns the number of tokens used in the prompt of the AI request.
Long	getTotalTokens()	Return the total number of tokens from both the prompt of an AI request and generation of the AI's response.
protected MistralAiApi.Usage	getUsage()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

MistralAiUsage

protected MistralAiUsage(MistralAiApi.Usage usage)

Method Details

from

public static MistralAiUsage from(MistralAiApi.Usage usage)

getUsage

protected MistralAiApi.Usage getUsage()

getPromptTokens

public Long 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 Long with the number of tokens used in the prompt of the AI request.

See Also:

• Usage.getGenerationTokens()

getGenerationTokens

public Long getGenerationTokens()

Description copied from interface: Usage

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

Specified by:

getGenerationTokens in interface Usage

Returns:

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

See Also:

• Usage.getPromptTokens()

getTotalTokens

public Long getTotalTokens()

Description copied from interface: Usage

Return the total number of tokens from both the prompt of an AI request and generation of the AI's response.

Specified by:

getTotalTokens in interface Usage

Returns:

the total number of tokens from both the prompt of an AI request and generation of the AI's response.

See Also:

• Usage.getPromptTokens()
• Usage.getGenerationTokens()

toString

public String toString()

Overrides:

toString in class Object