AxContextMetricsCollector Generated TypeScript API reference. typescript api api/reference build/apidocs/Class.AxContextMetricsCollector.md class AxContextMetricsCollector

AxContextMetricsCollector

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/agent/benchmarks/contextMetrics.ts#L58

Accumulates context telemetry for one agent run. Pass onEvent directly as the agent’s onContextEvent handler, then call summarize with agent.getUsage() once forward() resolves.

Constructors

Constructor

TypeScript
new AxContextMetricsCollector(): AxContextMetricsCollector;

Returns

AxContextMetricsCollector

Methods

onEvent()

TypeScript
readonly onEvent(event: Readonly<AxAgentContextEvent>): void;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/agent/benchmarks/contextMetrics.ts#L74

Parameters

ParameterType
eventReadonly<AxAgentContextEvent>

Returns

void


summarize()

TypeScript
summarize(usage?: 
  | readonly AxModelUsage & object[]
  | AxAgentUsage): AxContextMetricsSummary;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/agent/benchmarks/contextMetrics.ts#L110

Parameters

ParameterType
usage?| readonly AxModelUsage & object[] | AxAgentUsage

Returns

AxContextMetricsSummary

Docs