AxAgentic

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/agentInternal/agentStateTypes.ts#L29

Interface for agents that can be used as child agents. Provides methods to get the agent’s function definition and features.

Extends

AxProgrammable<IN, OUT>

Type Parameters

Type Parameter
`IN` extends `AxGenIn`
`OUT` extends `AxGenOut`

Methods

applyOptimization()

TypeScript

applyOptimization(optimizedProgram: AxOptimizedProgram<OUT>): void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L329

Parameters

Parameter	Type
`optimizedProgram`	`AxOptimizedProgram`<`OUT`>

Returns

void

Inherited from

AxProgrammable.applyOptimization

applyOptimizedComponents()

TypeScript

applyOptimizedComponents(updates: Readonly<Record<string, string>>): void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L347

Apply a map of componentKey → newValue updates produced by an optimizer. Each program filters keys belonging to itself and dispatches internally. Unknown keys are silently ignored, which lets parents broadcast a single map across the whole subtree.

Parameters

Parameter	Type
`updates`	`Readonly`<`Record`<`string`, `string`>>

Returns

void

Inherited from

AxProgrammable.applyOptimizedComponents

forward()

TypeScript

forward(
   ai: Readonly<AxAIService>, 
   values: IN, 
options?: Readonly<AxProgramForwardOptions<string>>): Promise<OUT>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L307

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`>
`values`	`IN`
`options?`	`Readonly`<`AxProgramForwardOptions`<`string`>>

Returns

Promise<OUT>

Inherited from

AxProgrammable.forward

getChatLog()

TypeScript

getChatLog(): readonly AxChatLogEntry[];

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L363

Returns

readonly AxChatLogEntry[]

Inherited from

AxProgrammable.getChatLog

getFunction()

TypeScript

getFunction(): AxFunction;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/agentInternal/agentStateTypes.ts#L31

Returns

AxFunction

getId()

TypeScript

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L321

Returns

string

Inherited from

AxProgrammable.getId

getOptimizableComponents()

TypeScript

getOptimizableComponents(): readonly AxOptimizableComponent[];

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L339

Enumerate all string-valued artifacts this program tree exposes for reflective optimization (instructions, signature descriptions, function names/descriptions, agent system prompts, etc.). Composite programs flat-map their children’s components and append their own.

The optimizer never walks the tree — traversal is encapsulated here.

Returns

readonly AxOptimizableComponent[]

Inherited from

AxProgrammable.getOptimizableComponents

getSignature()

TypeScript

getSignature(): AxSignature;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L371

Returns

AxSignature

Inherited from

AxProgrammable.getSignature

getTraces()

TypeScript

getTraces(): AxProgramTrace<IN, OUT>[];

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L323

Returns

AxProgramTrace<IN, OUT>[]

Inherited from

AxProgrammable.getTraces

getUsage()

TypeScript

getUsage(): 
  | AxModelUsage & object[]
  | AxAgentUsage;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L362

Returns

| AxModelUsage & object[] | AxAgentUsage

Inherited from

AxProgrammable.getUsage

namedProgramInstances()?

TypeScript

optional namedProgramInstances(): AxNamedProgramInstance<any, any>[];

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L324

Returns

AxNamedProgramInstance<any, any>[]

Inherited from

AxProgrammable.namedProgramInstances

resetUsage()

TypeScript

resetUsage(): void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L364

Returns

void

Inherited from

AxProgrammable.resetUsage

setDemos()

TypeScript

setDemos(demos: readonly AxProgramDemos<IN, OUT, string>[], options?: object): void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L325

Parameters

Parameter	Type
`demos`	readonly `AxProgramDemos`<`IN`, `OUT`, `string`>[]
`options?`	{ `modelConfig?`: `Record`<`string`, `unknown`>; }
`options.modelConfig?`	`Record`<`string`, `unknown`>

Returns

void

Inherited from

AxProgrammable.setDemos

setId()

TypeScript

setId(id: string): void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L322

Parameters

Parameter	Type
`id`	`string`

Returns

void

Inherited from

AxProgrammable.setId

streamingForward()

TypeScript

streamingForward(
   ai: Readonly<AxAIService>, 
   values: IN, 
options?: Readonly<AxProgramStreamingForwardOptions<string>>): AxGenStreamingOut<OUT>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/types.ts#L313

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`>
`values`	`IN`
`options?`	`Readonly`<`AxProgramStreamingForwardOptions`<`string`>>

Returns

AxGenStreamingOut<OUT>

Inherited from

AxProgrammable.streamingForward