Record Class AiUsage

java.lang.Object
java.lang.Record
com.shaft.pilot.ai.AiUsage
Record Components:
inputTokens - input tokens, or zero when unavailable
outputTokens - output tokens, or zero when unavailable
costUsd - cost in USD, or null when unavailable
public record AiUsage(long inputTokens, long outputTokens, BigDecimal costUsd) extends Record
Provider-reported usage metadata.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AiUsage(long inputTokens, long outputTokens, BigDecimal costUsd)
    Creates an instance of a AiUsage record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    BigDecimal
    costUsd()
    Returns the value of the costUsd record component.
    static AiUsage
    empty()
    Returns empty usage metadata.
    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.
    long
    inputTokens()
    Returns the value of the inputTokens record component.
    long
    outputTokens()
    Returns the value of the outputTokens record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • AiUsage

      public AiUsage(long inputTokens, long outputTokens, BigDecimal costUsd)
      Creates an instance of a AiUsage record class.
      Parameters:
      inputTokens - the value for the inputTokens record component
      outputTokens - the value for the outputTokens record component
      costUsd - the value for the costUsd record component

  • Method Details

    • empty

      public static AiUsage empty()
      Returns empty usage metadata.
      Returns:
      empty usage

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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 long inputTokens()
      Returns the value of the inputTokens record component.
      Returns:
      the value of the inputTokens record component

    • outputTokens

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

    • costUsd

      public BigDecimal costUsd()
      Returns the value of the costUsd record component.
      Returns:
      the value of the costUsd record component