Package com.vaadin.flow.component.ai.provider

Record Class ResponseMetadata.TokenUsage

java.lang.Object
java.lang.Record
com.vaadin.flow.component.ai.provider.ResponseMetadata.TokenUsage
Record Components:
inputTokens - tokens in the input, or null when unknown
outputTokens - tokens in the generated output, or null when unknown
totalTokens - total tokens, or null when unknown
All Implemented Interfaces:
Serializable
Enclosing class:
ResponseMetadata
public static record ResponseMetadata.TokenUsage(Integer inputTokens, Integer outputTokens, Integer totalTokens) extends Record implements Serializable
Token usage of a turn. Counts cover every round trip of the turn, as far as the underlying framework reports them.
See Also:

  • Constructor Details

    • TokenUsage

      public TokenUsage(Integer inputTokens, Integer outputTokens, Integer totalTokens)
      Creates an instance of a TokenUsage record class.
      Parameters:
      inputTokens - the value for the inputTokens record component
      outputTokens - the value for the outputTokens record component
      totalTokens - the value for the totalTokens 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.

    • inputTokens

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

    • outputTokens

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

    • totalTokens

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