Package org.springframework.ai.chat.model

Record Class MessageAggregator.DefaultUsage

java.lang.Object
java.lang.Record
org.springframework.ai.chat.model.MessageAggregator.DefaultUsage
All Implemented Interfaces:
Usage
Enclosing class:
MessageAggregator
public static record MessageAggregator.DefaultUsage(long promptTokens, long generationTokens, long totalTokens) extends Record implements Usage

  • Constructor Summary

    Constructors
    Constructor
    Description
    DefaultUsage(long promptTokens, long generationTokens, long totalTokens)
    Creates an instance of a DefaultUsage record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    long
    generationTokens()
    Returns the value of the generationTokens record component.
    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.
    final int
    hashCode()
    Returns a hash code value for this object.
    long
    promptTokens()
    Returns the value of the promptTokens record component.
    final String
    toString()
    Returns a string representation of this record class.
    long
    totalTokens()
    Returns the value of the totalTokens record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DefaultUsage

      public DefaultUsage(long promptTokens, long generationTokens, long totalTokens)
      Creates an instance of a DefaultUsage record class.
      Parameters:
      promptTokens - the value for the promptTokens record component
      generationTokens - the value for the generationTokens record component
      totalTokens - the value for the totalTokens record component

  • Method Details

    • 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 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 '=='.
      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.

    • promptTokens

      public long promptTokens()
      Returns the value of the promptTokens record component.
      Returns:
      the value of the promptTokens record component

    • generationTokens

      public long generationTokens()
      Returns the value of the generationTokens record component.
      Returns:
      the value of the generationTokens record component

    • totalTokens

      public long totalTokens()
      Returns the value of the totalTokens record component.
      Returns:
      the value of the totalTokens record component