agent Generated TypeScript API reference. typescript api api/reference build/apidocs/Function.agent.md function agent

agent

Call Signature

TypeScript
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/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/agentInternal/coordinator.ts#L850

Type Parameters

Type ParameterDefault type
T extends string-
CF extends readonly AxContextFieldInput[][]

Parameters

ParameterType
signatureT
configOmit<AxAgentConfig<ParseSignature<T>["inputs"], ParseSignature<T>["outputs"]>, "contextFields"> & object

Returns

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

Call Signature

TypeScript
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/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/agentInternal/coordinator.ts#L863

Type Parameters

Type ParameterDefault type
TInput extends Record<string, any>-
TOutput extends Record<string, any>-
CF extends readonly AxContextFieldInput[][]

Parameters

ParameterType
signatureAxSignature<TInput, TOutput>
configOmit<AxAgentConfig<TInput, TOutput>, "contextFields"> & object

Returns

AxAgent<TInput, TOutput>

Call Signature

TypeScript
function agent(signature: Readonly<AxSignatureConfig>, config: AxAgentConfig<AxGenIn, AxGenOut>): AxAgent<AxGenIn, AxGenOut>;

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

Parameters

ParameterType
signatureReadonly<AxSignatureConfig>
configAxAgentConfig<AxGenIn, AxGenOut>

Returns

AxAgent<AxGenIn, AxGenOut>

Docs