Package org.springframework.ai.chat.metadata

Interface Usage

All Known Implementing Classes:
AzureOpenAiUsage, BedrockUsage, EmptyUsage, OpenAiUsage, VertexAiUsage
public interface Usage
Abstract Data Type (ADT) encapsulating metadata on the usage of an AI provider's API per AI request.
Since:
0.7.0
Author:
John Blum

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    default Long
    getTotalTokens()
    Return the total number of tokens from both the prompt of an AI request and generation of the AI's response.

  • Method Details

    • getPromptTokens

      Long getPromptTokens()
      Returns the number of tokens used in the prompt of the AI request.
      Returns:
      an Long with the number of tokens used in the prompt of the AI request.
      See Also:

    • getGenerationTokens

      Long getGenerationTokens()
      Returns the number of tokens returned in the generation (aka completion) of the AI's response.
      Returns:
      an Long with the number of tokens returned in the generation (aka completion) of the AI's response.
      See Also:

    • getTotalTokens

      default Long getTotalTokens()
      Return the total number of tokens from both the prompt of an AI request and generation of the AI's response.
      Returns:
      the total number of tokens from both the prompt of an AI request and generation of the AI's response.
      See Also: