AxSignature

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L2377

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/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L2567

Parameters

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

Returns

void

addOutputField()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L2608

Parameters

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

Returns

void

appendInputField()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L2713

Type Parameters

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

Parameters

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

Returns

AxSignature<_TInput & AddedFieldShape<K, T, "input">, _TOutput>

appendOutputField()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L2775

Type Parameters

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

Parameters

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

Returns

AxSignature<_TInput, _TOutput & AddedFieldShape<K, T, "output">>

getDescription()

TypeScript

getDescription(): string | undefined;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L2707

Returns

string | undefined

getInputFields()

TypeScript

getInputFields(): readonly AxIField[];

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

Returns

readonly AxIField[]

getOutputFields()

TypeScript

getOutputFields(): readonly AxIField[];

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L2706

Returns

readonly AxIField[]

hasComplexFields()

TypeScript

hasComplexFields(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L2971

Returns

boolean

hash()

TypeScript

hash(): string;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L3015

Returns

string

prependInputField()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L2728

Type Parameters

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

Parameters

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

Returns

AxSignature<AddedFieldShape<K, T, "input"> & _TInput, _TOutput>

prependOutputField()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L2790

Type Parameters

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

Parameters

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

Returns

AxSignature<_TInput, AddedFieldShape<K, T, "output"> & _TOutput>

setDescription()

TypeScript

setDescription(desc: string): void;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L2554

Parameters

Parameter	Type
`desc`	`string`

Returns

void

setInputFields()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L2649

Parameters

Parameter	Type
`fields`	readonly `AxField`[]

Returns

void

setOutputFields()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L2677

Parameters

Parameter	Type
`fields`	readonly `AxField`[]

Returns

void

toInputJSONSchema()

TypeScript

toInputJSONSchema(): AxFunctionJSONSchema;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L3036

Returns

AxFunctionJSONSchema

toJSON()

TypeScript

toJSON(): object;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L3019

Returns

object

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

toJSONSchema()

TypeScript

toJSONSchema(): AxFunctionJSONSchema;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L3028

Returns

AxFunctionJSONSchema

toString()

TypeScript

toString(): string;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L3017

Returns

string

validate()

TypeScript

validate(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L2994

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/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L2494

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/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L2510

Returns

AxSignature

from()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/sig.ts#L2503

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>