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

AxResolvedAgentPlaybookConfig

TypeScript

type AxResolvedAgentPlaybookConfig = object;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/playbookConfig.ts#L104

Properties

apply

TypeScript

apply: boolean;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/playbookConfig.ts#L107

learn

TypeScript

learn: AxResolvedAgentPlaybookLearn;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/playbookConfig.ts#L108

onUpdate()?

TypeScript

optional onUpdate: (result: AxAgentPlaybookUpdateResult) => void | Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/playbookConfig.ts#L109

Parameters

Parameter	Type
`result`	`AxAgentPlaybookUpdateResult`

Returns

void | Promise<void>

playbookOptions

TypeScript

playbookOptions: Pick<AxPlaybookOptions, 
  | "maxReflectorRounds"
  | "maxSectionSize"
  | "allowDynamicSections"
  | "seed"
| "verbose">;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/playbookConfig.ts#L113

seedPlaybook?

TypeScript

optional seedPlaybook: 
  | AxPlaybookSnapshot
  | AxACEPlaybook;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/playbookConfig.ts#L105

studentAI?

TypeScript

optional studentAI: Readonly<AxAIService>;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/playbookConfig.ts#L110

target

TypeScript

target: "actor" | "responder";

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/playbookConfig.ts#L106

teacherAI?

TypeScript

optional teacherAI: Readonly<AxAIService>;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/playbookConfig.ts#L111

teacherOptions?

TypeScript

optional teacherOptions: AxAIServiceOptions;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/agent/playbookConfig.ts#L112

Docs