ax() API

Structured generation APIs for typed programs.

Most Used

`ax`

Creates a type-safe AI generator from a signature string or AxSignature object.

Field	Value
Kind	`function`
Form	`ax`
Returns	`AxGen`<`ParseSignature`<`T`>[`"inputs"`], `ParseSignature`<`T`>[`"outputs"`] & `string` extends `ThoughtKey` ? `object` : `{ [P in string]?: string }`> An AxGen instance that can be executed with `.forward(ai, inputs)`
Source	source

Call Shape

TypeScript

function ax<T, ThoughtKey>(signature: T, options?: Readonly<AxAIServiceOptions & object & object>): AxGen<ParseSignature<T>["inputs"], ParseSignature<T>["outputs"] & string extends ThoughtKey ? object : { [P in string]?: string }>;

TypeScript

function ax<TInput, TOutput, ThoughtKey>(signature: AxSignature<TInput, TOutput>, options?: Readonly<AxAIServiceOptions & object & object>): AxGen<TInput, TOutput & string extends ThoughtKey ? object : { [P in string]?: string }>;

TypeScript

function ax(signature: Readonly<AxSignatureConfig>, options?: Readonly<AxProgramForwardOptions<any>>): AxGen<AxGenIn, AxGenOut>;

Arguments And Options

Name	Type	Description
`signature`	`T`	Either a signature string or a pre-built AxSignature object
`options?`	`Readonly`<`AxAIServiceOptions` & `object` & `object`>	Optional configuration for the generator

Examples

TypeScript

const qa = ax('question: string -> answer: string');
const result = await qa.forward(ai, { question: 'What is TypeScript?' });
console.log(result.answer);

TypeScript

const classifier = ax('text: string -> sentiment: class(positive, negative, neutral)');
const result = await classifier.forward(ai, { text: 'I love this!' });
console.log(result.sentiment); // 'positive'

Full reference

`AxFunctionProcessor`

TypeScript class exported by @ax-llm/ax. See the constructor, methods, and full reference below.

Field	Value
Kind	`class`
Form	`AxFunctionProcessor`
Source	source

Call Shape

TypeScript

new AxFunctionProcessor(funcList: readonly AxFunction[]): AxFunctionProcessor;

Full reference

`AxGen`

TypeScript class exported by @ax-llm/ax. See the constructor, methods, and full reference below.

Field	Value
Kind	`class`
Form	`AxGen`
Source	source

Call Shape

TypeScript

new AxGen<IN, OUT>(signature: 
  | string
  | Readonly<AxSignatureConfig>
| Readonly<AxSignature<IN & Record<string, any>, OUT>>, options?: Readonly<AxProgramForwardOptions<any>>): AxGen<IN, OUT>;

Full reference

`AxGenerateError`

TypeScript class exported by @ax-llm/ax. See the constructor, methods, and full reference below.

Field	Value
Kind	`class`
Form	`AxGenerateError`
Source	source

Call Shape

TypeScript

new AxGenerateError(
   message: string, 
   details: Readonly<AxGenerateErrorDetails>, 
   options?: ErrorOptions): AxGenerateError;

Full reference

`AxProgram`

TypeScript class exported by @ax-llm/ax. See the constructor, methods, and full reference below.

Field	Value
Kind	`class`
Form	`AxProgram`
Source	source

Call Shape

TypeScript

new AxProgram<IN, OUT>(signature: 
  | undefined
  | string
  | Readonly<AxSignature<Record<string, any>, Record<string, any>>>
| Readonly<AxSignatureConfig>, options?: Readonly<AxProgramOptions>): AxProgram<IN, OUT>;

Full reference

`fn`

Creates a fluent builder for defining callable functions/tools with typed args, return schemas, namespaces, and optional AxAgent discovery examples.

Field	Value
Kind	`function`
Form	`fn`
Returns	`AxFunctionBuilder`<{ }, `unknown`, `false`>
Source	source

Call Shape

TypeScript

function fn<TName>(name: TName): AxFunctionBuilder<{
}, unknown, false>;

Arguments And Options

Name	Type	Description
`name`	`TName`

Full reference

Advanced / internals / full reference

`AxAssertion`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxAssertion`
Source	source

Call Shape

TypeScript

fn(values: T): 
  | undefined
  | string
  | boolean
| Promise<undefined | string | boolean>;

Full reference

`AxAssertionError`

TypeScript class exported by @ax-llm/ax. See the constructor, methods, and full reference below.

Field	Value
Kind	`class`
Form	`AxAssertionError`
Source	source

Call Shape

TypeScript

new AxAssertionError(__namedParameters: Readonly<{
  message: string;
}>): AxAssertionError;

Full reference

`AxBestOfN`

TypeScript class exported by @ax-llm/ax. See the constructor, methods, and full reference below.

Field	Value
Kind	`class`
Form	`AxBestOfN`
Source	source

Call Shape

TypeScript

new AxBestOfN<IN, OUT>(program: Readonly<AxProgrammable<IN, OUT>>, options: Readonly<AxBestOfNOptions<IN, OUT>>): AxBestOfN<IN, OUT>;

Full reference

`AxBestOfNOptions`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxBestOfNOptions`
Source	source

Call Shape

TypeScript

type AxBestOfNOptions<IN, OUT> = object;

Full reference

`AxFunctionError`

TypeScript class exported by @ax-llm/ax. See the constructor, methods, and full reference below.

Field	Value
Kind	`class`
Form	`AxFunctionError`
Source	source

Call Shape

TypeScript

new AxFunctionError(fields: object[]): AxFunctionError;

Full reference

`AxGenDeltaOut`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxGenDeltaOut`
Source	source

Call Shape

TypeScript

type AxGenDeltaOut<OUT> = object;

Full reference

`AxGenerateErrorDetails`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxGenerateErrorDetails`
Source	source

Call Shape

TypeScript

type AxGenerateErrorDetails = object;

Full reference

`AxGenerateResult`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxGenerateResult`
Source	source

Call Shape

TypeScript

type AxGenerateResult<OUT> = OUT & object;

Full reference

`AxGenIn`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxGenIn`
Source	source

Call Shape

TypeScript

type AxGenIn = object;

Full reference

`AxGenInput`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxGenInput`
Source	source

Call Shape

TypeScript

type AxGenInput<T> = T extends AxGen<infer IN, any> ? IN : T extends AxSignature<infer IN2, any> ? IN2 : T extends AxSignatureBuilder<infer IN3, any> ? IN3 : T extends string ? ParseSignature<T> extends object ? IN4 : never : never;

Full reference

`AxGenMetricsInstruments`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxGenMetricsInstruments`
Source	source

Full reference

`AxGenOut`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxGenOut`
Source	source

Call Shape

TypeScript

type AxGenOut = object;

Full reference

`AxGenOutput`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxGenOutput`
Source	source

Call Shape

TypeScript

type AxGenOutput<T> = T extends AxGen<any, infer OUT> ? OUT : T extends AxSignature<any, infer OUT2> ? OUT2 : T extends AxSignatureBuilder<any, infer OUT3> ? OUT3 : T extends string ? ParseSignature<T> extends object ? OUT4 : never : never;

Full reference

`AxGenStreamingOut`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxGenStreamingOut`
Source	source

Call Shape

TypeScript

type AxGenStreamingOut<OUT> = AsyncGenerator<AxGenDeltaOut<OUT>, void, unknown>;

Full reference

`AxProgramDemos`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxProgramDemos`
Source	source

Call Shape

TypeScript

type AxProgramDemos<IN, OUT, ID> = object;

Full reference

`AxProgramExamples`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxProgramExamples`
Source	source

Call Shape

TypeScript

type AxProgramExamples<IN, OUT> = 
  | AxProgramDemos<IN, OUT>
  | AxProgramDemos<IN, OUT>["traces"];

Full reference

`AxProgramForwardOptions`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxProgramForwardOptions`
Source	source

Call Shape

TypeScript

type AxProgramForwardOptions<MODEL> = AxAIServiceOptions & object;

Full reference

`AxProgramForwardOptionsWithModels`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxProgramForwardOptionsWithModels`
Source	source

Call Shape

TypeScript

type AxProgramForwardOptionsWithModels<T> = AxProgramForwardOptions<AxAIServiceModelType<T>>;

Full reference

`AxProgrammable`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxProgrammable`
Source	source

Call Shape

TypeScript

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

Full reference

`AxProgramOptions`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxProgramOptions`
Source	source

Full reference

`AxProgramStreamingForwardOptions`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxProgramStreamingForwardOptions`
Source	source

Call Shape

TypeScript

type AxProgramStreamingForwardOptions<MODEL> = Omit<AxProgramForwardOptions<MODEL>, "stream">;

Full reference

`AxProgramStreamingForwardOptionsWithModels`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxProgramStreamingForwardOptionsWithModels`
Source	source

Call Shape

TypeScript

type AxProgramStreamingForwardOptionsWithModels<T> = AxProgramStreamingForwardOptions<AxAIServiceModelType<T>>;

Full reference

`AxProgramTrace`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxProgramTrace`
Source	source

Call Shape

TypeScript

type AxProgramTrace<IN, OUT> = object;

Full reference

`AxProgramUsage`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxProgramUsage`
Source	source

Call Shape

TypeScript

type AxProgramUsage = AxChatResponse["modelUsage"] & object;

Full reference

`AxPromptTemplate`

TypeScript class exported by @ax-llm/ax. See the constructor, methods, and full reference below.

Field	Value
Kind	`class`
Form	`AxPromptTemplate`
Source	source

Call Shape

TypeScript

new AxPromptTemplate(
   sig: Readonly<AxSignature>, 
   options?: Readonly<AxPromptTemplateOptions>, 
   fieldTemplates?: Record<string, AxFieldTemplateFn>): AxPromptTemplate;

Full reference

`AxPromptTemplateOptions`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxPromptTemplateOptions`
Source	source

Full reference

`AxRefine`

TypeScript class exported by @ax-llm/ax. See the constructor, methods, and full reference below.

Field	Value
Kind	`class`
Form	`AxRefine`
Source	source

Call Shape

TypeScript

new AxRefine<IN, OUT>(program: Readonly<AxProgrammable<IN, OUT>>, options: Readonly<AxRefineOptions<IN, OUT>>): AxRefine<IN, OUT>;

Full reference

`AxRefineError`

TypeScript class exported by @ax-llm/ax. See the constructor, methods, and full reference below.

Field	Value
Kind	`class`
Form	`AxRefineError`
Source	source

Call Shape

TypeScript

new AxRefineError(message: string, attempts: readonly AxAttempt<any, any>[]): AxRefineError;

Full reference

`AxRefineOptions`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxRefineOptions`
Source	source

Call Shape

TypeScript

type AxRefineOptions<IN, OUT> = object;

Full reference

`AxRefineStrategy`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxRefineStrategy`
Source	source

Call Shape

TypeScript

type AxRefineStrategy = "auto" | "native-samples" | "serial";

Full reference

`AxStreamingAssertion`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxStreamingAssertion`
Source	source

Call Shape

TypeScript

fn(content: string, done?: boolean): 
  | undefined
  | string
  | boolean
| Promise<undefined | string | boolean>;

Full reference

`AxStreamingAssertionError`

TypeScript class exported by @ax-llm/ax. See the constructor, methods, and full reference below.

Field	Value
Kind	`class`
Form	`AxStreamingAssertionError`
Source	source

Call Shape

TypeScript

new AxStreamingAssertionError(__namedParameters: Readonly<{
  message: string;
}>): AxStreamingAssertionError;

Full reference

`bestOfN`

TypeScript function exported by @ax-llm/ax. See the call shape, arguments, and full reference below.

Field	Value
Kind	`function`
Form	`bestOfN`
Returns	`AxBestOfN`<`IN`, `OUT`>
Source	source

Call Shape

TypeScript

function bestOfN<IN, OUT>(program: Readonly<AxProgrammable<IN, OUT>>, options: Readonly<AxBestOfNOptions<IN, OUT>>): AxBestOfN<IN, OUT>;

Arguments And Options

Name	Type	Description
`program`	`Readonly`<`AxProgrammable`<`IN`, `OUT`>>
`options`	`Readonly`<`AxBestOfNOptions`<`IN`, `OUT`>>

Full reference

`refine`

TypeScript function exported by @ax-llm/ax. See the call shape, arguments, and full reference below.

Field	Value
Kind	`function`
Form	`refine`
Returns	`AxRefine`<`IN`, `OUT`>
Source	source

Call Shape

TypeScript

function refine<IN, OUT>(program: Readonly<AxProgrammable<IN, OUT>>, options: Readonly<AxRefineOptions<IN, OUT>>): AxRefine<IN, OUT>;

Arguments And Options

Name	Type	Description
`program`	`Readonly`<`AxProgrammable`<`IN`, `OUT`>>
`options`	`Readonly`<`AxRefineOptions`<`IN`, `OUT`>>

Full reference

Full Reference

Open the full TypeScript reference. This page highlights the ax symbols most relevant to everyday use.