AxSignature
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/sig.ts#L508
Type Parameters
Type Parameter | Default type |
---|---|
_TInput extends Record <string , any > | Record <string , any > |
_TOutput extends Record <string , any > | Record <string , any > |
Constructors
Constructor
new AxSignature<_TInput, _TOutput>(signature?: Readonly<
| string
| AxSignature<Record<string, any>, Record<string, any>>
| AxSignatureConfig>): AxSignature<_TInput, _TOutput>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/sig.ts#L537
Deprecated
Use AxSignature.create()
for better type safety instead of the constructor.
This constructor will be removed in v15.0.0.
Migration timeline:
- v13.0.24+: Deprecation warnings (current)
- v14.0.0: Runtime console warnings
- v15.0.0: Complete removal
Example
// Instead of: new AxSignature('userInput:string -> responseText:string')
// Use: AxSignature.create('userInput:string -> responseText:string')
Parameters
Parameter | Type |
---|---|
signature? | Readonly < | string | AxSignature <Record <string , any >, Record <string , any >> | AxSignatureConfig > |
Returns
AxSignature
<_TInput
, _TOutput
>
Methods
addInputField()
addInputField(field: Readonly<AxField>): void;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/sig.ts#L698
Parameters
Parameter | Type |
---|---|
field | Readonly <AxField > |
Returns
void
addOutputField()
addOutputField(field: Readonly<AxField>): void;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/sig.ts#L739
Parameters
Parameter | Type |
---|---|
field | Readonly <AxField > |
Returns
void
appendInputField()
appendInputField<K, T>(name: K, fieldType: T): AxSignature<_TInput & Record<K, InferFieldValueType<T>>, _TOutput>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/sig.ts#L841
Type Parameters
Type Parameter |
---|
K extends string |
T extends AxFieldType |
Parameters
Parameter | Type |
---|---|
name | K |
fieldType | T |
Returns
AxSignature
<_TInput
& Record
<K
, InferFieldValueType
<T
>>, _TOutput
>
appendOutputField()
appendOutputField<K, T>(name: K, fieldType: T): AxSignature<_TInput, _TOutput & Record<K, InferFieldValueType<T>>>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/sig.ts#L903
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
>>>
getDescription()
getDescription(): undefined | string;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/sig.ts#L838
Returns
undefined
| string
getInputFields()
getInputFields(): readonly AxIField[];
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/sig.ts#L836
Returns
readonly AxIField
[]
getOutputFields()
getOutputFields(): readonly AxIField[];
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/sig.ts#L837
Returns
readonly AxIField
[]
hash()
hash(): string;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/sig.ts#L1150
Returns
string
prependInputField()
prependInputField<K, T>(name: K, fieldType: T): AxSignature<Record<K, InferFieldValueType<T>> & _TInput, _TOutput>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/sig.ts#L856
Type Parameters
Type Parameter |
---|
K extends string |
T extends AxFieldType |
Parameters
Parameter | Type |
---|---|
name | K |
fieldType | T |
Returns
AxSignature
<Record
<K
, InferFieldValueType
<T
>> & _TInput
, _TOutput
>
prependOutputField()
prependOutputField<K, T>(name: K, fieldType: T): AxSignature<_TInput, Record<K, InferFieldValueType<T>> & _TOutput>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/sig.ts#L918
Type Parameters
Type Parameter |
---|
K extends string |
T extends AxFieldType |
Parameters
Parameter | Type |
---|---|
name | K |
fieldType | T |
Returns
AxSignature
<_TInput
, Record
<K
, InferFieldValueType
<T
>> & _TOutput
>
setDescription()
setDescription(desc: string): void;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/sig.ts#L685
Parameters
Parameter | Type |
---|---|
desc | string |
Returns
void
setInputFields()
setInputFields(fields: readonly AxField[]): void;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/sig.ts#L780
Parameters
Parameter | Type |
---|---|
fields | readonly AxField [] |
Returns
void
setOutputFields()
setOutputFields(fields: readonly AxField[]): void;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/sig.ts#L808
Parameters
Parameter | Type |
---|---|
fields | readonly AxField [] |
Returns
void
toJSON()
toJSON(): object;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/sig.ts#L1154
Returns
object
Name | Type |
---|---|
description | undefined | string |
id | string |
inputFields | AxIField [] |
outputFields | AxIField [] |
toJSONSchema()
toJSONSchema(): AxFunctionJSONSchema;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/sig.ts#L975
Returns
toString()
toString(): string;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/sig.ts#L1152
Returns
string
validate()
validate(): boolean;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/sig.ts#L1129
Returns
boolean
create()
static create<T>(signature: T): AxSignature<ParseSignature<T>["inputs"], ParseSignature<T>["outputs"]>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/sig.ts#L637
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"
]>