Class: TokenMeter

Tracks the usage of tokens.

Constructors

new TokenMeter()

new TokenMeter(): TokenMeter

Returns

TokenMeter

Accessors

usedInputTokens

get usedInputTokens(): number

The number of input tokens used

Returns

number

Defined in

evaluator/TokenMeter.ts:11

---

usedOutputTokens

get usedOutputTokens(): number

The number of tokens generated by a model

Returns

number

Defined in

evaluator/TokenMeter.ts:18

Methods

useTokens()

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

Log the usage of tokens on multiple meters

Parameters

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

Returns

void

Defined in

evaluator/TokenMeter.ts:61

---

diff()

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

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;

Defined in

evaluator/TokenMeter.ts:80

---

getState()

getState(): TokenMeterState

Get the current state of the token meter

Returns

TokenMeterState

Defined in

evaluator/TokenMeter.ts:25

---

useTokens()

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

Log the usage of tokens

Parameters

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

Returns

void

Defined in

evaluator/TokenMeter.ts:35

---

diff()

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

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;

Defined in

evaluator/TokenMeter.ts:54