LanguageModelUsage

Namespace: Vercel.AI.Provider

public sealed class LanguageModelUsage

Token counts for a model call.

Inheritance: object

View source

Constructors

LanguageModelUsage(int?, int?, int?, int?, int?, int?, JsonElement?, int?, int?)

public LanguageModelUsage(int? inputTokens, int? outputTokens, int? totalTokens, int? cacheReadTokens = null, int? cacheWriteTokens = null, int? reasoningTokens = null, JsonElement? raw = null, int? noCacheInputTokens = null, int? textTokens = null)

Creates usage counts.

Parameters

Name	Type	Description
inputTokens	int?
outputTokens	int?
totalTokens	int?
cacheReadTokens	int?
cacheWriteTokens	int?
reasoningTokens	int?
raw	JsonElement?
noCacheInputTokens	int?
textTokens	int?

View source

Properties

CacheReadTokens

public int? CacheReadTokens { get; }

Input tokens read from cache, when the provider reports them.

Value: int?

View source

CacheWriteTokens

public int? CacheWriteTokens { get; }

Input tokens written to cache, when the provider reports them.

Value: int?

View source

Empty

public static LanguageModelUsage Empty { get; }

Zero usage.

Value: LanguageModelUsage

View source

InputTokens

public int? InputTokens { get; }

Prompt tokens.

Value: int?

View source

NoCacheInputTokens

public int? NoCacheInputTokens { get; }

Input tokens that were not served from cache, when the provider reports them.

Value: int?

View source

Null

public static LanguageModelUsage Null { get; }

Usage with every count and Raw unset. It is the start value for adding steps.

Value: LanguageModelUsage

View source

OutputTokens

public int? OutputTokens { get; }

Generated tokens.

Value: int?

View source

Raw

public JsonElement? Raw { get; }

Provider usage object, unchanged.

Value: JsonElement?

View source

ReasoningTokens

public int? ReasoningTokens { get; }

Output tokens spent on reasoning, when the provider reports them.

Value: int?

View source

TextTokens

public int? TextTokens { get; }

Output tokens that were not reasoning tokens, when the provider reports them.

Value: int?

View source

TotalTokens

public int? TotalTokens { get; }

Input plus output tokens.

Value: int?

View source

Methods

Add(LanguageModelUsage, LanguageModelUsage)

public static LanguageModelUsage Add(LanguageModelUsage left, LanguageModelUsage right)

Adds two usage values. Raw survives only when one side is Null.

Parameters

Name	Type	Description
left	LanguageModelUsage
right	LanguageModelUsage

Returns: LanguageModelUsage

View source