AxSignature

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/sig.ts#L2405

Type Parameters

Methods

addInputField()

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

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/sig.ts#L2595

Parameters

Returns

void

addOutputField()

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

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/sig.ts#L2636

Parameters

Returns

void

appendInputField()

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

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/sig.ts#L2741

Type Parameters

Parameters

Returns

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

appendOutputField()

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

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/sig.ts#L2803

Type Parameters

Parameters

Returns

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

getDescription()

getDescription(): string | undefined;

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/sig.ts#L2735

Returns

string | undefined

getInputFields()

getInputFields(): readonly AxIField[];

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/sig.ts#L2733

Returns

readonly AxIField[]

getOutputFields()

getOutputFields(): readonly AxIField[];

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/sig.ts#L2734

Returns

readonly AxIField[]

hasComplexFields()

hasComplexFields(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/sig.ts#L2999

Returns

boolean

hash()

hash(): string;

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/sig.ts#L3043

Returns

string

prependInputField()

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

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/sig.ts#L2756

Type Parameters

Parameters

Returns

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

prependOutputField()

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

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/sig.ts#L2818

Type Parameters

Parameters

Returns

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

setDescription()

setDescription(desc: string): void;

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/sig.ts#L2582

Parameters

Returns

void

setInputFields()

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

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

Parameters

Returns

void

setOutputFields()

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

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

Parameters

Returns

void

toInputJSONSchema()

toInputJSONSchema(): AxFunctionJSONSchema;

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/sig.ts#L3064

Returns

AxFunctionJSONSchema

toJSON()

toJSON(): object;

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/sig.ts#L3047

Returns

object

toJSONSchema()

toJSONSchema(): AxFunctionJSONSchema;

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/sig.ts#L3056

Returns

AxFunctionJSONSchema

toString()

toString(): string;

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/sig.ts#L3045

Returns

string

validate()

validate(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/sig.ts#L3022

Returns

boolean

create()

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

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/sig.ts#L2522

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

Type Parameters

Parameters

Returns

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

empty()

static empty(): AxSignature;

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/sig.ts#L2538

Returns

AxSignature

from()

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

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/sig.ts#L2531

Type Parameters

Parameters

Returns

AxSignature<TInput, TOutput>