JTokenUsage

org.llm4s.javaapi.JTokenUsage
See theJTokenUsage companion object
final class JTokenUsage

The tokens one model call used, as JCompletion.usage reports them. An agent turn's JUsageSummary adds these up across its calls: its inputTokens are the sum of promptTokens, its outputTokens of completionTokens.

A value: two are equal when every field is.

Value parameters

cacheCreationTokens

input tokens written into the provider's prompt cache, billed at the cache-creation rate, which is typically higher than the normal input rate; zero where the provider reports none

cachedTokens

input tokens served from the provider's prompt cache (a cache read), billed at the cheaper cache-read rate; zero where the provider reports none

completionTokens

tokens received in the reply

promptTokens

tokens sent: the conversation, the tools and the instructions

thinkingTokens

extended-thinking tokens, billed as output but counted apart from completionTokens; zero where the provider reports none, as in JUsageSummary.thinkingTokens

totalTokens

the total the provider reported, normally promptTokens + completionTokens

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

override def equals(other: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
override def hashCode: Int

Calculates a hash code value for the object.

Calculates a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any

Concrete fields

val cachedTokens: Int
val completionTokens: Int
val promptTokens: Int
val thinkingTokens: Int
val totalTokens: Int