Package org.springframework.ai.openai.api

Record Class OpenAiApi.Usage.CompletionTokenDetails

java.lang.Object
java.lang.Record
org.springframework.ai.openai.api.OpenAiApi.Usage.CompletionTokenDetails
Record Components:
reasoningTokens - Number of tokens generated by the model for reasoning.
acceptedPredictionTokens - Number of tokens generated by the model for accepted predictions.
audioTokens - Number of tokens generated by the model for audio.
rejectedPredictionTokens - Number of tokens generated by the model for rejected predictions.
Enclosing class:
OpenAiApi.Usage
public static record OpenAiApi.Usage.CompletionTokenDetails(Integer reasoningTokens, Integer acceptedPredictionTokens, Integer audioTokens, Integer rejectedPredictionTokens) extends Record
Breakdown of tokens used in a completion.

  • Constructor Details

    • CompletionTokenDetails

      public CompletionTokenDetails(Integer reasoningTokens, Integer acceptedPredictionTokens, Integer audioTokens, Integer rejectedPredictionTokens)
      Creates an instance of a CompletionTokenDetails record class.
      Parameters:
      reasoningTokens - the value for the reasoningTokens record component
      acceptedPredictionTokens - the value for the acceptedPredictionTokens record component
      audioTokens - the value for the audioTokens record component
      rejectedPredictionTokens - the value for the rejectedPredictionTokens 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.

    • reasoningTokens

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

    • acceptedPredictionTokens

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

    • audioTokens

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

    • rejectedPredictionTokens

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