Package org.springframework.ai.openai.api

Record Class OpenAiApi.LogProbs.Content.TopLogProbs

java.lang.Object
java.lang.Record
org.springframework.ai.openai.api.OpenAiApi.LogProbs.Content.TopLogProbs
Record Components:
token - The token.
logprob - The log probability of the token.
probBytes - A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token.
Enclosing class:
OpenAiApi.LogProbs.Content
public static record OpenAiApi.LogProbs.Content.TopLogProbs(String token, Float logprob, List<Integer> probBytes) extends Record
The most likely tokens and their log probability, at this token position.

  • Constructor Details

    • TopLogProbs

      public TopLogProbs(String token, Float logprob, List<Integer> probBytes)
      Creates an instance of a TopLogProbs record class.
      Parameters:
      token - the value for the token record component
      logprob - the value for the logprob record component
      probBytes - the value for the probBytes 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.

    • token

      public String token()
      Returns the value of the token record component.
      Returns:
      the value of the token record component

    • logprob

      public Float logprob()
      Returns the value of the logprob record component.
      Returns:
      the value of the logprob record component

    • probBytes

      public List<Integer> probBytes()
      Returns the value of the probBytes record component.
      Returns:
      the value of the probBytes record component