AxProgram
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/program.ts#L17
Extended by
Type Parameters
Type Parameter |
---|
IN |
OUT |
Implements
Constructors
Constructor
new AxProgram<IN, OUT>(signature:
| undefined
| Readonly<
| string
| AxSignature<Record<string, any>, Record<string, any>>
| AxSignatureConfig>, options?: Readonly<AxProgramOptions>): AxProgram<IN, OUT>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/program.ts#L31
Parameters
Parameter | Type |
---|---|
signature | | undefined | Readonly < | string | AxSignature <Record <string , any >, Record <string , any >> | AxSignatureConfig > |
options? | Readonly <AxProgramOptions > |
Returns
AxProgram
<IN
, OUT
>
Methods
getSignature()
getSignature(): AxSignature;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/program.ts#L55
Returns
getTraces()
getTraces(): AxProgramTrace<IN, OUT>[];
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/program.ts#L153
Returns
AxProgramTrace
<IN
, OUT
>[]
getUsage()
getUsage(): AxModelUsage & object[];
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/program.ts#L167
Returns
AxModelUsage
& object
[]
Implementation of
register()
register(prog: Readonly<AxTunable<IN, OUT> & AxUsable>): void;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/program.ts#L83
Parameters
Parameter | Type |
---|---|
prog | Readonly <AxTunable <IN , OUT > & AxUsable > |
Returns
void
resetUsage()
resetUsage(): void;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/program.ts#L177
Returns
void
Implementation of
setDemos()
setDemos(demos: readonly AxProgramDemos<IN, OUT>[]): void;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/program.ts#L184
Parameters
Parameter | Type |
---|---|
demos | readonly AxProgramDemos <IN , OUT >[] |
Returns
void
setDescription()
setDescription(description: string): void;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/program.ts#L73
Parameters
Parameter | Type |
---|---|
description | string |
Returns
void
setExamples()
setExamples(examples: Readonly<AxProgramExamples<IN, OUT>>, options?: Readonly<AxSetExamplesOptions>): void;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/program.ts#L103
Parameters
Parameter | Type |
---|---|
examples | Readonly <AxProgramExamples <IN , OUT >> |
options? | Readonly <AxSetExamplesOptions > |
Returns
void
setId()
setId(id: string): void;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/program.ts#L90
Parameters
Parameter | Type |
---|---|
id | string |
Returns
void
setParentId()
setParentId(parentId: string): void;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/program.ts#L97
Parameters
Parameter | Type |
---|---|
parentId | string |
Returns
void
setSignature()
setSignature(signature:
| undefined
| Readonly<
| string
| AxSignature<Record<string, any>, Record<string, any>>
| AxSignatureConfig>): void;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/program.ts#L59
Parameters
Parameter | Type |
---|---|
signature | | undefined | Readonly < | string | AxSignature <Record <string , any >, Record <string , any >> | AxSignatureConfig > |
Returns
void