AxGen
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/generate.ts#L122
Extends
AxProgram
<IN
,OUT
>
Extended by
Type Parameters
Type Parameter | Default type |
---|---|
IN | any |
OUT extends AxGenOut | any |
Implements
AxProgrammable
<IN
,OUT
>
Constructors
Constructor
new AxGen<IN, OUT>(signature:
| NonNullable<Readonly<string | AxSignature<Record<string, any>, Record<string, any>> | AxSignatureConfig> | undefined>
| AxSignature<any, any>, options?: Readonly<AxProgramForwardOptions<any>>): AxGen<IN, OUT>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/generate.ts#L136
Parameters
Parameter | Type |
---|---|
signature | | NonNullable <Readonly<string | AxSignature<Record<string, any>, Record<string, any>> | AxSignatureConfig> | undefined> | AxSignature <any , any > |
options? | Readonly <AxProgramForwardOptions <any >> |
Returns
AxGen
<IN
, OUT
>
Overrides
Methods
_forward1()
_forward1(
ai: Readonly<AxAIService>,
values: IN | AxMessage<IN>[],
options: Readonly<AxProgramForwardOptions<any>>): AxGenStreamingOut<OUT>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/generate.ts#L676
Parameters
Parameter | Type |
---|---|
ai | Readonly <AxAIService > |
values | IN | AxMessage <IN >[] |
options | Readonly <AxProgramForwardOptions <any >> |
Returns
AxGenStreamingOut
<OUT
>
addAssert()
addAssert(fn: (values: Record<string, unknown>) => undefined | boolean | Promise<undefined | boolean>, message?: string): void;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/generate.ts#L195
Parameters
Parameter | Type |
---|---|
fn | (values : Record <string , unknown >) => undefined | boolean | Promise <undefined | boolean > |
message? | string |
Returns
void
addFieldProcessor()
addFieldProcessor(fieldName: string, fn:
| AxFieldProcessorProcess
| AxStreamingFieldProcessorProcess): void;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/generate.ts#L242
Parameters
Parameter | Type |
---|---|
fieldName | string |
fn | | AxFieldProcessorProcess | AxStreamingFieldProcessorProcess |
Returns
void
addStreamingAssert()
addStreamingAssert(
fieldName: string,
fn: (content: string, done?: boolean) => undefined | boolean,
message?: string): void;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/generate.ts#L199
Parameters
Parameter | Type |
---|---|
fieldName | string |
fn | (content : string , done? : boolean ) => undefined | boolean |
message? | string |
Returns
void
addStreamingFieldProcessor()
addStreamingFieldProcessor(fieldName: string, fn:
| AxFieldProcessorProcess
| AxStreamingFieldProcessorProcess): void;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/generate.ts#L235
Parameters
Parameter | Type |
---|---|
fieldName | string |
fn | | AxFieldProcessorProcess | AxStreamingFieldProcessorProcess |
Returns
void
forward()
forward<T>(
ai: T,
values: IN | AxMessage<IN>[],
options?: Readonly<AxProgramForwardOptionsWithModels<T>>): Promise<OUT>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/generate.ts#L774
Type Parameters
Type Parameter |
---|
T extends Readonly <AxAIService <unknown , unknown , string >> |
Parameters
Parameter | Type |
---|---|
ai | T |
values | IN | AxMessage <IN >[] |
options? | Readonly <AxProgramForwardOptionsWithModels <T >> |
Returns
Promise
<OUT
>
Implementation of
getSignature()
getSignature(): AxSignature;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/program.ts#L55
Returns
Implementation of
Inherited from
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
>[]
Implementation of
Inherited from
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
Inherited from
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
Inherited from
resetUsage()
resetUsage(): void;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/program.ts#L177
Returns
void
Implementation of
Inherited from
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
Implementation of
Inherited from
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
Inherited from
setExamples()
setExamples(examples: Readonly<AxProgramExamples<IN, OUT>>, options?: Readonly<AxSetExamplesOptions>): void;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/generate.ts#L978
Parameters
Parameter | Type |
---|---|
examples | Readonly <AxProgramExamples <IN , OUT >> |
options? | Readonly <AxSetExamplesOptions > |
Returns
void
Implementation of
Overrides
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
Implementation of
Inherited from
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
Implementation of
Inherited from
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
Inherited from
streamingForward()
streamingForward<T>(
ai: T,
values: IN | AxMessage<IN>[],
options?: Readonly<AxProgramStreamingForwardOptionsWithModels<T>>): AxGenStreamingOut<OUT>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/generate.ts#L923
Type Parameters
Type Parameter |
---|
T extends Readonly <AxAIService <unknown , unknown , string >> |
Parameters
Parameter | Type |
---|---|
ai | T |
values | IN | AxMessage <IN >[] |
options? | Readonly <AxProgramStreamingForwardOptionsWithModels <T >> |
Returns
AxGenStreamingOut
<OUT
>
Implementation of
AxProgrammable
.streamingForward
updateMeter()
updateMeter(meter?: Meter): void;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/generate.ts#L175
Parameters
Parameter | Type |
---|---|
meter? | Meter |
Returns
void