s() API

Signature, field, schema, and validation APIs.

Most Used

`AxField`

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

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

Full reference

`AxFieldType`

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

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

Full reference

`AxSignature`

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

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

Call Shape

TypeScript

addInputField(field: Readonly<AxField>): void;

Full reference

`AxSignatureConfig`

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

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

Full reference

`f`

Fluent field builder for creating type-safe signature fields.

Field	Value
Kind	`variable`
Form	`f`
Source	source

Call Shape

TypeScript

const f: () => AxSignatureBuilder & object;

Examples

TypeScript

const sig = f()
  .input('name', f.string('User name'))
  .input('age', f.number('Age in years'))
  .output('greeting', f.string('Personalized greeting'))
  .build();

TypeScript

const sig = f()
  .input('email', f.string().email())
  .input('score', f.number('Score between 0-100').min(0).max(100))
  .input('tags', f.string('Tag').array('List of tags'))
  .output('isValid', f.boolean())
  .build();

Full reference

`s`

Creates a type-safe signature from a string template.

Field	Value
Kind	`function`
Form	`s`
Returns	`AxSignature`<`ParseSignature`<`T`>[`"inputs"`], `ParseSignature`<`T`>[`"outputs"`]> A typed AxSignature instance
Source	source

Call Shape

TypeScript

function s<T>(signature: T): AxSignature<ParseSignature<T>["inputs"], ParseSignature<T>["outputs"]>;

Arguments And Options

Name	Type	Description
`signature`	`T`	The signature string in the format `"inputFields -> outputFields"`

Full reference

Advanced / internals / full reference

`AxContextFieldInput`

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

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

Call Shape

TypeScript

type AxContextFieldInput = 
  | string
  | {
  field: string;
  keepInPromptChars?: number;
  promptMaxChars?: number;
  reverseTruncate?: boolean;
};

Full reference

`AxContextFieldPromptConfig`

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

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

Call Shape

TypeScript

type AxContextFieldPromptConfig = 
  | {
  kind: "threshold";
  promptMaxChars: number;
}
  | {
  keepInPromptChars: number;
  kind: "truncate";
  reverseTruncate: boolean;
};

Full reference

`AxFieldOptions`

Per-field companion options for Standard Schema (zod/valibot/arktype) inputs and outputs. These encode ax-specific hints that schema libraries don’t represent natively.

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

Full reference

`AxFieldProcessor`

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

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

Full reference

`AxFieldProcessorProcess`

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

Field	Value
Kind	`typealias`
Form	`AxFieldProcessorProcess`
Returns	`unknown` \\| `Promise`<`unknown`>
Source	source

Call Shape

TypeScript

type AxFieldProcessorProcess = (value: AxFieldValue, context?: Readonly<{
  done?: boolean;
  sessionId?: string;
  values?: AxGenOut;
}>) => unknown | Promise<unknown>;

Arguments And Options

Name	Type	Description
`value`	`AxFieldValue`
`context?`	`Readonly`<{ `done?`: `boolean`; `sessionId?`: `string`; `values?`: `AxGenOut`; }>

Full reference

`AxFieldTemplateFn`

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

Field	Value
Kind	`typealias`
Form	`AxFieldTemplateFn`
Returns	`any`[]
Source	source

Call Shape

TypeScript

type AxFieldTemplateFn = (field: Readonly<AxField>, value: Readonly<AxFieldValue>) => any[];

Arguments And Options

Name	Type	Description
`field`	`Readonly`<`AxField`>
`value`	`Readonly`<`AxFieldValue`>

Full reference

`AxFieldValue`

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

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

Call Shape

TypeScript

type AxFieldValue = 
  | string
  | string[]
  | number
  | boolean
  | object
  | null
  | undefined
  | {
  data: string;
  mimeType: string;
}
  | object[]
  | {
  channels?: number;
  data?: string;
  format?: string;
  id?: string;
  mimeType?: string;
  sampleRate?: number;
  transcript?: string;
}
  | object[];

Full reference

`AxFluentFieldInfo`

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

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

Full reference

`AxFluentFieldType`

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

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

Call Shape

TypeScript

new AxFluentFieldType<TType, TIsArray, TOptions, TIsOptional, TIsInternal, TFields, TIsCached>(fieldType: object): AxFluentFieldType<TType, TIsArray, TOptions, TIsOptional, TIsInternal, TFields, TIsCached>;

Full reference

`AxFunctionJSONSchema`

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

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

Call Shape

TypeScript

type AxFunctionJSONSchema = object;

Full reference

`AxIField`

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

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

Call Shape

TypeScript

type AxIField = Omit<AxField, "title"> & object;

Full reference

`AxMCPJSONSchema`

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

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

Call Shape

TypeScript

type AxMCPJSONSchema = Record<string, unknown>;

Full reference

`axMCPToolInputSchemaToFunctionSchema`

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

Field	Value
Kind	`function`
Form	`axMCPToolInputSchemaToFunctionSchema`
Returns	`AxFunctionJSONSchema`
Source	source

Call Shape

TypeScript

function axMCPToolInputSchemaToFunctionSchema(schema: undefined | AxMCPJSONSchema): AxFunctionJSONSchema;

Arguments And Options

Name	Type	Description
`schema`	`undefined` \\| `AxMCPJSONSchema`

Full reference

`AxResultPickerFunctionFieldResults`

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

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

Call Shape

TypeScript

type AxResultPickerFunctionFieldResults<OUT> = object;

Full reference

`AxRuntimePrimitiveSignature`

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

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

Call Shape

TypeScript

type AxRuntimePrimitiveSignature = object;

Full reference

`AxSignatureBuilder`

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

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

Call Shape

TypeScript

input<K, T>(
   name: K, 
   fieldInfo: T, 
prepend?: boolean): AxSignatureBuilder<AddFieldToShape<_TInput, K, T, "input">, _TOutput>;

TypeScript

input<K, T>(
   name: K, 
   schema: T, 
opts?: AxFieldOptions): AxSignatureBuilder<_TInput & { [P in string]: InferOutput<T> }, _TOutput>;

TypeScript

input<T>(schema: T, opts?: object): AxSignatureBuilder<AsRecord<InferOutput<T>>, _TOutput>;

Full reference

`AxSignatureInput`

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

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

Call Shape

TypeScript

type AxSignatureInput = Readonly<
  | AxSignature
  | string
| AxSignatureConfig>;

Full reference

`AxStreamingFieldProcessorProcess`

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

Field	Value
Kind	`typealias`
Form	`AxStreamingFieldProcessorProcess`
Returns	`unknown` \\| `Promise`<`unknown`>
Source	source

Call Shape

TypeScript

type AxStreamingFieldProcessorProcess = (value: string, context?: Readonly<{
  done?: boolean;
  sessionId?: string;
  values?: AxGenOut;
}>) => unknown | Promise<unknown>;

Arguments And Options

Name	Type	Description
`value`	`string`
`context?`	`Readonly`<{ `done?`: `boolean`; `sessionId?`: `string`; `values?`: `AxGenOut`; }>

Full reference

Full Reference

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