agent
Call Signature
function agent<T, CF>(signature: T, config: Omit<AxAgentConfig<ParseSignature<T>["inputs"], ParseSignature<T>["outputs"]>, "contextFields"> & object): AxAgent<ParseSignature<T>["inputs"], ParseSignature<T>["outputs"]>;Defined in: https://github.com/ax-llm/ax/blob/71ea5064d766efdc031d375243a8e525911833e7/src/ax/prompts/agent.ts#L1326
Creates a strongly-typed AI agent from a signature. This is the recommended way to create agents, providing better type inference and cleaner syntax.
Example
const myAgent = agent('context:string, query:string -> answer:string', {
contextFields: ['context'],
runtime: new AxJSRuntime(),
});Type Parameters
| Type Parameter |
|---|
T extends string |
CF extends readonly string[] |
Parameters
| Parameter | Type | Description |
|---|---|---|
signature | T | The input/output signature as a string or AxSignature object |
config | Omit<AxAgentConfig<ParseSignature<T>["inputs"], ParseSignature<T>["outputs"]>, "contextFields"> & object | Configuration options for the agent (contextFields is required) |
Returns
AxAgent<ParseSignature<T>["inputs"], ParseSignature<T>["outputs"]>
A typed agent instance
Call Signature
function agent<TInput, TOutput, CF>(signature: AxSignature<TInput, TOutput>, config: Omit<AxAgentConfig<TInput, TOutput>, "contextFields"> & object): AxAgent<TInput, TOutput>;Defined in: https://github.com/ax-llm/ax/blob/71ea5064d766efdc031d375243a8e525911833e7/src/ax/prompts/agent.ts#L1339
Creates a strongly-typed AI agent from a signature. This is the recommended way to create agents, providing better type inference and cleaner syntax.
Example
const myAgent = agent('context:string, query:string -> answer:string', {
contextFields: ['context'],
runtime: new AxJSRuntime(),
});Type Parameters
| Type Parameter |
|---|
TInput extends Record<string, any> |
TOutput extends Record<string, any> |
CF extends readonly string[] |
Parameters
| Parameter | Type | Description |
|---|---|---|
signature | AxSignature<TInput, TOutput> | The input/output signature as a string or AxSignature object |
config | Omit<AxAgentConfig<TInput, TOutput>, "contextFields"> & object | Configuration options for the agent (contextFields is required) |
Returns
AxAgent<TInput, TOutput>
A typed agent instance