AxAgent

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/prompts/agent.ts#L178

An AI agent that can process inputs using an AI service and coordinate with child agents. Supports features like smart model routing and automatic input field passing to child agents.

Deprecated

Use the agent() factory function instead of instantiating this class directly. The factory function provides better type inference and cleaner syntax. This class will be removed in v15.0.0.

Migration timeline:

• v13.0.24+: Deprecation warnings (current)
• v14.0.0: Runtime console warnings
• v15.0.0: Complete removal

Example

// Old (deprecated):
const myAgent = new AxAgent({
  name: 'myAgent',
  description: 'An agent that does something',
  signature: 'userInput:string -> responseText:string'
});

// New (recommended):
const myAgent = agent('userInput:string -> responseText:string', {
  name: 'myAgent',
  description: 'An agent that does something'
});

Type Parameters

Implements

• AxAgentic<IN, OUT>

Constructors

Constructor

new AxAgent<IN, OUT>(__namedParameters: Readonly<{
  agents?: AxAgentic<IN, OUT>[];
  ai?: Readonly<AxAIService>;
  definition?: string;
  description: string;
  functions?: AxInputFunctionType;
  name: string;
  signature: NonNullable<ConstructorParameters<typeof AxSignature>[0]>;
}>, options?: Readonly<AxAgentOptions>): AxAgent<IN, OUT>;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/prompts/agent.ts#L193

Parameters

Returns

AxAgent<IN, OUT>

Methods

forward()

forward<T>(
   parentAi: T, 
   values: IN | AxMessage<IN>[], 
options?: Readonly<AxProgramForwardOptionsWithModels<T>>): Promise<OUT>;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/prompts/agent.ts#L434

Type Parameters

Parameters

Returns

Promise<OUT>

Implementation of

AxAgentic.forward

getFeatures()

getFeatures(): AxAgentFeatures;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/prompts/agent.ts#L382

Returns

AxAgentFeatures

Implementation of

AxAgentic.getFeatures

getFunction()

getFunction(): AxFunction;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/prompts/agent.ts#L342

Returns

AxFunction

Implementation of

AxAgentic.getFunction

getSignature()

getSignature(): AxSignature;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/prompts/agent.ts#L485

Returns

AxSignature

Implementation of

AxAgentic.getSignature

getTraces()

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

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/prompts/agent.ts#L326

Returns

AxProgramTrace<IN, OUT>[]

Implementation of

AxAgentic.getTraces

getUsage()

getUsage(): AxModelUsage & object[];

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/prompts/agent.ts#L334

Returns

AxModelUsage & object[]

Implementation of

AxAgentic.getUsage

resetUsage()

resetUsage(): void;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/prompts/agent.ts#L338

Returns

void

Implementation of

AxAgentic.resetUsage

setDefinition()

setDefinition(definition: string): void;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/prompts/agent.ts#L476

Parameters

Returns

void

setDemos()

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

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/prompts/agent.ts#L330

Parameters

Returns

void

Implementation of

AxAgentic.setDemos

setDescription()

setDescription(description: string): void;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/prompts/agent.ts#L467

Updates the agent’s description. This updates both the stored description and the function’s description.

Parameters

Returns

void

Throws

Error if description is too short

setExamples()

setExamples(examples: Readonly<AxProgramExamples<IN, OUT>>, options?: Readonly<AxSetExamplesOptions>): void;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/prompts/agent.ts#L311

Parameters

Returns

void

Implementation of

AxAgentic.setExamples

setId()

setId(id: string): void;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/prompts/agent.ts#L318

Parameters

Returns

void

Implementation of

AxAgentic.setId

setParentId()

setParentId(parentId: string): void;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/prompts/agent.ts#L322

Parameters

Returns

void

Implementation of

AxAgentic.setParentId

setSignature()

setSignature(signature: NonNullable<
  | undefined
  | Readonly<
  | string
  | AxSignature<Record<string, any>, Record<string, any>>
  | AxSignatureConfig>>): void;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/prompts/agent.ts#L489

Parameters

Returns

void

streamingForward()

streamingForward<T>(
   parentAi: T, 
   values: IN | AxMessage<IN>[], 
options?: Readonly<AxProgramStreamingForwardOptionsWithModels<T>>): AxGenStreamingOut<OUT>;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/prompts/agent.ts#L447

Type Parameters

Parameters

Returns

AxGenStreamingOut<OUT>

Implementation of

AxAgentic.streamingForward

create()

static create<T>(signature: T, config: AxAgentConfig<ParseSignature<T>["inputs"], ParseSignature<T>["outputs"]>): AxAgent<ParseSignature<T>["inputs"], ParseSignature<T>["outputs"]>;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/prompts/agent.ts#L286

Creates a new AxAgent instance with type-safe signature parsing. This is the recommended way to create agents with string-based signatures.

Example

const agent = AxAgent.create(
  'userInput:string "User question" -> responseText:string "Agent response"',
  {
    name: 'helpfulAgent',
    description: 'An agent that provides helpful responses to user questions',
    definition: 'You are a helpful assistant that provides clear, accurate responses to user questions.',
    ai: llm
  }
);

Type Parameters

Parameters

Returns

AxAgent<ParseSignature<T>["inputs"], ParseSignature<T>["outputs"]>

A new AxAgent instance with inferred types