Record Class ProviderUsage

java.lang.Object

java.lang.Record

ai.doctruth.ProviderUsage

Record Components:

inputTokens - prompt tokens billed by the provider.

outputTokens - completion tokens billed by the provider.

modelVersion - provider-reported model version (e.g. a date stamp or build id).

public record ProviderUsage(int inputTokens, int outputTokens, String modelVersion)
extends Record

Token-usage and model-version data returned by an LLM provider on every successful call. Carried into Provenance so audit logs can reconstruct cost and reproducibility.

Invariants (compact constructor):

• inputTokens >= 0, outputTokens >= 0.
• modelVersion non-null and non-blank.

Since:

0.1.0

Constructor Summary

Constructors

Constructor	Description
ProviderUsage(int inputTokens, int outputTokens, String modelVersion)	Creates an instance of a ProviderUsage record class.

Method Summary

Modifier and Type	Method	Description
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	inputTokens()	Returns the value of the inputTokens record component.
String	modelVersion()	Returns the value of the modelVersion record component.
int	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

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

Constructor Details

ProviderUsage

public ProviderUsage(int inputTokens,
 int outputTokens,
 String modelVersion)

Creates an instance of a ProviderUsage record class.

Parameters:

inputTokens - the value for the inputTokens record component

outputTokens - the value for the outputTokens record component

modelVersion - the value for the modelVersion 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. 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 int inputTokens()

Returns the value of the inputTokens record component.

Returns:

the value of the inputTokens record component

outputTokens

public int outputTokens()

Returns the value of the outputTokens record component.

Returns:

the value of the outputTokens record component

modelVersion

public String modelVersion()

Returns the value of the modelVersion record component.

Returns:

the value of the modelVersion record component