Class: TokenMeter

Defined in: evaluator/TokenMeter.ts:4

Tracks the usage of tokens.

Constructors

Constructor

new TokenMeter(): TokenMeter;

Returns

TokenMeter

Accessors

usedInputTokens

Get Signature

get usedInputTokens(): number;

Defined in: evaluator/TokenMeter.ts:11

The number of input tokens used

Returns

number

---

usedOutputTokens

Get Signature

get usedOutputTokens(): number;

Defined in: evaluator/TokenMeter.ts:18

The number of tokens generated by a model

Returns

number

Methods

useTokens()

static useTokens(
   meters: 
  | TokenMeter
  | ReadonlySet<TokenMeter>
  | readonly TokenMeter[]
  | null
  | undefined, 
   tokens: number, 
   type: "input" | "output"): void;

Defined in: evaluator/TokenMeter.ts:61

Log the usage of tokens on multiple meters

Parameters

Parameter	Type
meters	| TokenMeter | ReadonlySet<TokenMeter> | readonly TokenMeter[] | null | undefined
tokens	number
type	"input" | "output"

Returns

void

---

diff()

static diff(meter1: TokenMeter | TokenMeterState, meter2: TokenMeter | TokenMeterState): {
  usedInputTokens: number;
  usedOutputTokens: number;
};

Defined in: evaluator/TokenMeter.ts:80

Get the difference between two meters

Parameters

Parameter	Type
meter1	TokenMeter | TokenMeterState
meter2	TokenMeter | TokenMeterState

Returns

{
  usedInputTokens: number;
  usedOutputTokens: number;
}

usedInputTokens

usedInputTokens: number;

usedOutputTokens

usedOutputTokens: number;

---

getState()

getState(): TokenMeterState;

Defined in: evaluator/TokenMeter.ts:25

Get the current state of the token meter

Returns

TokenMeterState

---

useTokens()

useTokens(tokens: number, type: "input" | "output"): void;

Defined in: evaluator/TokenMeter.ts:35

Log the usage of tokens

Parameters

Parameter	Type
tokens	number
type	"input" | "output"

Returns

void

---

diff()

diff(meter: TokenMeter | TokenMeterState): {
  usedInputTokens: number;
  usedOutputTokens: number;
};

Defined in: evaluator/TokenMeter.ts:54

Get the difference between the current meter and another meter

Parameters

Parameter	Type
meter	TokenMeter | TokenMeterState

Returns

{
  usedInputTokens: number;
  usedOutputTokens: number;
}

usedInputTokens

usedInputTokens: number;

usedOutputTokens

usedOutputTokens: number;