AxAgentic

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/prompts/agent.ts#L32

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`

Properties

Property	Type	Inherited from
`applyOptimization`	(`optimizedProgram`: `AxOptimizedProgram`<`OUT`>) => `void`	`AxProgrammable`.`applyOptimization`
`getSignature`	() => `AxSignature`	`AxProgrammable`.`getSignature`
`getTraces`	() => `AxProgramTrace`<`IN`, `OUT`>[]	`AxProgrammable`.`getTraces`
`getUsage`	() => `AxModelUsage` & `object`[]	`AxProgrammable`.`getUsage`
`resetUsage`	() => `void`	`AxProgrammable`.`resetUsage`
`setDemos`	(`demos`: readonly `AxProgramDemos`<`IN`, `OUT`>[]) => `void`	`AxProgrammable`.`setDemos`
`setExamples`	(`examples`: `Readonly`<`AxProgramExamples`<`IN`, `OUT`>>, `options?`: `Readonly`<`AxSetExamplesOptions`>) => `void`	`AxProgrammable`.`setExamples`
`setId`	(`id`: `string`) => `void`	`AxProgrammable`.`setId`
`setParentId`	(`parentId`: `string`) => `void`	`AxProgrammable`.`setParentId`

Methods

forward()

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

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/dsp/types.ts#L184

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`>
`values`	`IN` \| `AxMessage`<`IN`>[]
`options?`	`Readonly`<`AxProgramForwardOptions`<`string`>>

Returns

Promise<OUT>

Inherited from

AxProgrammable.forward

getFeatures()

getFeatures(): AxAgentFeatures;

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/prompts/agent.ts#L35

Returns

AxAgentFeatures

getFunction()

getFunction(): AxFunction;

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/prompts/agent.ts#L34

Returns

AxFunction

streamingForward()

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

Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/dsp/types.ts#L190

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`>
`values`	`IN` \| `AxMessage`<`IN`>[]
`options?`	`Readonly`<`AxProgramStreamingForwardOptions`<`string`>>

Returns

AxGenStreamingOut<OUT>

Inherited from

AxProgrammable.streamingForward