Package ai.optfor.springopenaiapi.model

Record Class Usage

java.lang.Object
java.lang.Record
ai.optfor.springopenaiapi.model.Usage
public record Usage(int prompt_tokens, int completion_tokens, int total_tokens) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    Usage(int prompt_tokens, int completion_tokens, int total_tokens)
    Creates an instance of a Usage record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    completion_tokens()
    Returns the value of the completion_tokens record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    prompt_tokens()
    Returns the value of the prompt_tokens record component.
    final String
    toString()
    Returns a string representation of this record class.
    int
    total_tokens()
    Returns the value of the total_tokens record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Usage

      public Usage(int prompt_tokens, int completion_tokens, int total_tokens)
      Creates an instance of a Usage record class.
      Parameters:
      prompt_tokens - the value for the prompt_tokens record component
      completion_tokens - the value for the completion_tokens record component
      total_tokens - the value for the total_tokens 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 '=='.
      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.

    • prompt_tokens

      public int prompt_tokens()
      Returns the value of the prompt_tokens record component.
      Returns:
      the value of the prompt_tokens record component

    • completion_tokens

      public int completion_tokens()
      Returns the value of the completion_tokens record component.
      Returns:
      the value of the completion_tokens record component

    • total_tokens

      public int total_tokens()
      Returns the value of the total_tokens record component.
      Returns:
      the value of the total_tokens record component