Package org.springframework.ai.openai.api

Record Class OpenAiApi.Usage.PromptTokensDetails

java.lang.Object
java.lang.Record
org.springframework.ai.openai.api.OpenAiApi.Usage.PromptTokensDetails
Record Components:
audioTokens - Audio input tokens present in the prompt.
cachedTokens - Cached tokens present in the prompt.
Enclosing class:
OpenAiApi.Usage
public static record OpenAiApi.Usage.PromptTokensDetails(Integer audioTokens, Integer cachedTokens) extends Record
Breakdown of tokens used in the prompt

  • Constructor Details

    • PromptTokensDetails

      public PromptTokensDetails(Integer audioTokens, Integer cachedTokens)
      Creates an instance of a PromptTokensDetails record class.
      Parameters:
      audioTokens - the value for the audioTokens record component
      cachedTokens - the value for the cachedTokens record component

  • Method Details

    • 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 Objects::equals(Object,Object).
      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.

    • audioTokens

      public Integer audioTokens()
      Returns the value of the audioTokens record component.
      Returns:
      the value of the audioTokens record component

    • cachedTokens

      public Integer cachedTokens()
      Returns the value of the cachedTokens record component.
      Returns:
      the value of the cachedTokens record component