Package org.springframework.ai.openai.metadata

Class OpenAiUsage

java.lang.Object
org.springframework.ai.openai.metadata.OpenAiUsage
All Implemented Interfaces:
Usage
public class OpenAiUsage extends Object implements Usage
Usage implementation for OpenAI.
Since:
0.7.0
Author:
John Blum
See Also:

  • Constructor Details

  • Method Details

    • from

      public static OpenAiUsage from(OpenAiApi.Usage usage)

    • getUsage

      protected OpenAiApi.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:

    • 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:

    • 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:

    • toString

      public String toString()
      Overrides:
      toString in class Object