AxAgentPlaybookEvolveOptions Generated TypeScript API reference. typescript api api/reference build/apidocs/TypeAlias.AxAgentPlaybookEvolveOptions.md type AxAgentPlaybookEvolveOptions

AxAgentPlaybookEvolveOptions

TypeScript
type AxAgentPlaybookEvolveOptions = object;

Defined in: https://github.com/ax-llm/ax/blob/3ac75e381dcefb739712993c304c34295567283a/src/ax/agent/agentInternal/playbookEvolve/playbookEvolveTypes.ts#L78

Properties

abortSignal?

TypeScript
optional abortSignal: AbortSignal;

Defined in: https://github.com/ax-llm/ax/blob/3ac75e381dcefb739712993c304c34295567283a/src/ax/agent/agentInternal/playbookEvolve/playbookEvolveTypes.ts#L124


apply?

TypeScript
optional apply: boolean;

Defined in: https://github.com/ax-llm/ax/blob/3ac75e381dcefb739712993c304c34295567283a/src/ax/agent/agentInternal/playbookEvolve/playbookEvolveTypes.ts#L121

Keep accepted bullets on the live playbook (default). With false, the playbook is rolled back at the end and the result’s playbookSnapshot carries the accepted state for a later getPlaybook()?.load(...).


epsilon?

TypeScript
optional epsilon: number;

Defined in: https://github.com/ax-llm/ax/blob/3ac75e381dcefb739712993c304c34295567283a/src/ax/agent/agentInternal/playbookEvolve/playbookEvolveTypes.ts#L111

Tolerated held-out drop when accepting a proposal (verify). Default 0.01.


judgeAI?

TypeScript
optional judgeAI: Readonly<AxAIService>;

Defined in: https://github.com/ax-llm/ax/blob/3ac75e381dcefb739712993c304c34295567283a/src/ax/agent/agentInternal/playbookEvolve/playbookEvolveTypes.ts#L91

Scores runs via the built-in judge. Resolution mirrors optimize().


judgeOptions?

TypeScript
optional judgeOptions: AxAgentJudgeOptions;

Defined in: https://github.com/ax-llm/ax/blob/3ac75e381dcefb739712993c304c34295567283a/src/ax/agent/agentInternal/playbookEvolve/playbookEvolveTypes.ts#L92


maxMetricCalls?

TypeScript
optional maxMetricCalls: number;

Defined in: https://github.com/ax-llm/ax/blob/3ac75e381dcefb739712993c304c34295567283a/src/ax/agent/agentInternal/playbookEvolve/playbookEvolveTypes.ts#L102

Budget counting (agent run + judge) pairs across baseline and re-evaluations. Default `max(100, (maxProposals + 1) * (train + validation)

  • runsPerTask)`.

maxProposals?

TypeScript
optional maxProposals: number;

Defined in: https://github.com/ax-llm/ax/blob/3ac75e381dcefb739712993c304c34295567283a/src/ax/agent/agentInternal/playbookEvolve/playbookEvolveTypes.ts#L96

Maximum weaknesses mined / proposals evaluated. Default 4.


metric?

TypeScript
optional metric: AxMetricFn;

Defined in: https://github.com/ax-llm/ax/blob/3ac75e381dcefb739712993c304c34295567283a/src/ax/agent/agentInternal/playbookEvolve/playbookEvolveTypes.ts#L94

Optional deterministic scorer replacing the LLM judge.


minHeldInGain?

TypeScript
optional minHeldInGain: number;

Defined in: https://github.com/ax-llm/ax/blob/3ac75e381dcefb739712993c304c34295567283a/src/ax/agent/agentInternal/playbookEvolve/playbookEvolveTypes.ts#L113

Required held-in improvement to accept a proposal (verify). Default 0.05.


onProgress()?

TypeScript
optional onProgress: (event: Readonly<AxAgentPlaybookEvolveProgressEvent>) => void;

Defined in: https://github.com/ax-llm/ax/blob/3ac75e381dcefb739712993c304c34295567283a/src/ax/agent/agentInternal/playbookEvolve/playbookEvolveTypes.ts#L123

Parameters

ParameterType
eventReadonly<AxAgentPlaybookEvolveProgressEvent>

Returns

void


runsPerTask?

TypeScript
optional runsPerTask: number;

Defined in: https://github.com/ax-llm/ax/blob/3ac75e381dcefb739712993c304c34295567283a/src/ax/agent/agentInternal/playbookEvolve/playbookEvolveTypes.ts#L109

Times each task runs per evaluation, with scores averaged. Default 1. Use 2-3 when the dataset is small: accept/reject compares mean scores, and on a handful of tasks a single lucky or unlucky run can otherwise decide the gate. Each repeat spends budget.


scoreThreshold?

TypeScript
optional scoreThreshold: number;

Defined in: https://github.com/ax-llm/ax/blob/3ac75e381dcefb739712993c304c34295567283a/src/ax/agent/agentInternal/playbookEvolve/playbookEvolveTypes.ts#L115

Records scoring below this count as failures for mining. Default 0.7.


studentAI?

TypeScript
optional studentAI: Readonly<AxAIService>;

Defined in: https://github.com/ax-llm/ax/blob/3ac75e381dcefb739712993c304c34295567283a/src/ax/agent/agentInternal/playbookEvolve/playbookEvolveTypes.ts#L87

Runs the agent during evaluation. Defaults to the agent’s ai.


teacherAI?

TypeScript
optional teacherAI: Readonly<AxAIService>;

Defined in: https://github.com/ax-llm/ax/blob/3ac75e381dcefb739712993c304c34295567283a/src/ax/agent/agentInternal/playbookEvolve/playbookEvolveTypes.ts#L89

Mines weaknesses. Defaults to judgeAI, then the student.


verbose?

TypeScript
optional verbose: boolean;

Defined in: https://github.com/ax-llm/ax/blob/3ac75e381dcefb739712993c304c34295567283a/src/ax/agent/agentInternal/playbookEvolve/playbookEvolveTypes.ts#L122


verify?

TypeScript
optional verify: boolean;

Defined in: https://github.com/ax-llm/ax/blob/3ac75e381dcefb739712993c304c34295567283a/src/ax/agent/agentInternal/playbookEvolve/playbookEvolveTypes.ts#L85

Keep only proposals that provably help — re-score train + held-out after each candidate bullet and accept only on a held-in gain without a held-out regression, else roll it back. Default true. With false, mined lessons are applied without the gate (fast trust-batch).

Docs