AxSignature

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2052

Type Parameters

Type Parameter	Default type
`_TInput` extends `Record`<`string`, `any`>	`Record`<`string`, `any`>
`_TOutput` extends `Record`<`string`, `any`>	`Record`<`string`, `any`>

Methods

addInputField()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2241

Parameters

Parameter	Type
`field`	`Readonly`<`AxField`>

Returns

void

addOutputField()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2282

Parameters

Parameter	Type
`field`	`Readonly`<`AxField`>

Returns

void

appendInputField()

TypeScript

appendInputField<K, T>(name: K, fieldType: T): AxSignature<_TInput & Record<K, InferFieldValueType<T, "input">>, _TOutput>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2384

Type Parameters

Type Parameter
`K` extends `string`
`T` extends `AxFieldType`

Parameters

Parameter	Type
`name`	`K`
`fieldType`	`T`

Returns

AxSignature<_TInput & Record<K, InferFieldValueType<T, "input">>, _TOutput>

appendOutputField()

TypeScript

appendOutputField<K, T>(name: K, fieldType: T): AxSignature<_TInput, _TOutput & Record<K, InferFieldValueType<T, "output">>>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2452

Type Parameters

Type Parameter
`K` extends `string`
`T` extends `AxFieldType`

Parameters

Parameter	Type
`name`	`K`
`fieldType`	`T`

Returns

AxSignature<_TInput, _TOutput & Record<K, InferFieldValueType<T, "output">>>

getDescription()

TypeScript

getDescription(): undefined | string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2381

Returns

undefined | string

getInputFields()

TypeScript

getInputFields(): readonly AxIField[];

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2379

Returns

readonly AxIField[]

getOutputFields()

TypeScript

getOutputFields(): readonly AxIField[];

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2380

Returns

readonly AxIField[]

hasComplexFields()

TypeScript

hasComplexFields(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2658

Returns

boolean

hash()

TypeScript

hash(): string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2701

Returns

string

prependInputField()

TypeScript

prependInputField<K, T>(name: K, fieldType: T): AxSignature<Record<K, InferFieldValueType<T, "input">> & _TInput, _TOutput>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2402

Type Parameters

Type Parameter
`K` extends `string`
`T` extends `AxFieldType`

Parameters

Parameter	Type
`name`	`K`
`fieldType`	`T`

Returns

AxSignature<Record<K, InferFieldValueType<T, "input">> & _TInput, _TOutput>

prependOutputField()

TypeScript

prependOutputField<K, T>(name: K, fieldType: T): AxSignature<_TInput, Record<K, InferFieldValueType<T, "output">> & _TOutput>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2470

Type Parameters

Type Parameter
`K` extends `string`
`T` extends `AxFieldType`

Parameters

Parameter	Type
`name`	`K`
`fieldType`	`T`

Returns

AxSignature<_TInput, Record<K, InferFieldValueType<T, "output">> & _TOutput>

setDescription()

TypeScript

setDescription(desc: string): void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2228

Parameters

Parameter	Type
`desc`	`string`

Returns

void

setInputFields()

TypeScript

setInputFields(fields: readonly AxField[]): void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2323

Parameters

Parameter	Type
`fields`	readonly `AxField`[]

Returns

void

setOutputFields()

TypeScript

setOutputFields(fields: readonly AxField[]): void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2351

Parameters

Parameter	Type
`fields`	readonly `AxField`[]

Returns

void

toInputJSONSchema()

TypeScript

toInputJSONSchema(): AxFunctionJSONSchema;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2720

Returns

AxFunctionJSONSchema

toJSON()

TypeScript

toJSON(): object;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2705

Returns

object

Name	Type
`description`	`undefined` \| `string`
`id`	`string`
`inputFields`	`AxIField`[]
`outputFields`	`AxIField`[]

toJSONSchema()

TypeScript

toJSONSchema(): AxFunctionJSONSchema;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2714

Returns

AxFunctionJSONSchema

toString()

TypeScript

toString(): string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2703

Returns

string

validate()

TypeScript

validate(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2680

Returns

boolean

create()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2169

Static factory method for type inference. Creates a typed AxSignature instance from a signature string.

Type Parameters

Type Parameter
`T` extends `string`

Parameters

Parameter	Type
`signature`	`T`

Returns

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

empty()

TypeScript

static empty(): AxSignature;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2185

Returns

AxSignature

from()

TypeScript

static from<TInput, TOutput>(signature?: AxSignatureInput): AxSignature<TInput, TOutput>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/sig.ts#L2178

Type Parameters

Type Parameter	Default type
`TInput` extends `Record`<`string`, `any`>	`Record`<`string`, `any`>
`TOutput` extends `Record`<`string`, `any`>	`Record`<`string`, `any`>

Parameters

Parameter	Type
`signature?`	`AxSignatureInput`

Returns

AxSignature<TInput, TOutput>