AxGen

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/generate.ts#L124

Extends

AxProgram<IN, OUT>

Extended by

AxDefaultResultReranker

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/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/generate.ts#L139

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

AxProgram.constructor

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/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/generate.ts#L800

Parameters

Parameter	Type
`ai`	`Readonly`<`AxAIService`>
`values`	`IN` \| `AxMessage`<`IN`>[]
`options`	`Readonly`<`AxProgramForwardOptions`<`any`>>

Returns

AxGenStreamingOut<OUT>

addAssert()

addAssert(fn: (values: OUT) => 
  | undefined
  | string
  | boolean
  | Promise<undefined | string | boolean>, message?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/generate.ts#L197

Parameters

Parameter	Type
`fn`	(`values`: `OUT`) => \| `undefined` \| `string` \| `boolean` \| `Promise`<`undefined` \| `string` \| `boolean`>
`message?`	`string`

Returns

void

addFieldProcessor()

addFieldProcessor(fieldName: keyof OUT, fn: (value: OUT[keyof OUT], context?: object) => unknown): void;

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/generate.ts#L272

Parameters

Parameter	Type
`fieldName`	keyof `OUT`
`fn`	(`value`: `OUT`[keyof `OUT`], `context?`: `object`) => `unknown`

Returns

void

addStreamingAssert()

addStreamingAssert(
   fieldName: keyof OUT, 
   fn: (content: string, done?: boolean) => undefined | string | boolean, 
   message?: string): void;

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/generate.ts#L201

Parameters

Parameter	Type
`fieldName`	keyof `OUT`
`fn`	(`content`: `string`, `done?`: `boolean`) => `undefined` \| `string` \| `boolean`
`message?`	`string`

Returns

void

addStreamingFieldProcessor()

addStreamingFieldProcessor(fieldName: keyof OUT, fn: (value: string, context?: object) => unknown): void;

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/generate.ts#L258

Parameters

Parameter	Type
`fieldName`	keyof `OUT`
`fn`	(`value`: `string`, `context?`: `object`) => `unknown`

Returns

void

applyOptimization()

applyOptimization(optimizedProgram: AxOptimizedProgram<OUT>): void;

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/program.ts#L213

Apply optimized configuration to this program

Parameters

Parameter	Type	Description
`optimizedProgram`	`AxOptimizedProgram`<`OUT`>	The optimized program configuration to apply

Returns

void

Implementation of

AxProgrammable.applyOptimization

Inherited from

AxProgram.applyOptimization

forward()

forward<T>(
   ai: T, 
   values: IN | AxMessage<IN>[], 
options?: Readonly<AxProgramForwardOptionsWithModels<T>>): Promise<OUT>;

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/generate.ts#L898

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

AxProgrammable.forward

getSignature()

getSignature(): AxSignature;

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/program.ts#L56

getTraces()

getTraces(): AxProgramTrace<IN, OUT>[];

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/program.ts#L154

Returns

AxProgramTrace<IN, OUT>[]

Implementation of

AxProgrammable.getTraces

Inherited from

AxProgram.getTraces

getUsage()

getUsage(): AxModelUsage & object[];

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/program.ts#L168

Returns

AxModelUsage & object[]

Implementation of

AxProgrammable.getUsage

Inherited from

AxProgram.getUsage

register()

register(prog: Readonly<AxTunable<IN, OUT> & AxUsable>): void;

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/program.ts#L84

Parameters

Parameter	Type
`prog`	`Readonly`<`AxTunable`<`IN`, `OUT`> & `AxUsable`>

Returns

void

Inherited from

AxProgram.register

resetUsage()

resetUsage(): void;

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/program.ts#L178

Returns

void

Implementation of

AxProgrammable.resetUsage

Inherited from

AxProgram.resetUsage

setDemos()

setDemos(demos: readonly AxProgramDemos<IN, OUT>[]): void;

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/program.ts#L185

Parameters

Parameter	Type
`demos`	readonly `AxProgramDemos`<`IN`, `OUT`>[]

Returns

void

Implementation of

AxProgrammable.setDemos

Inherited from

AxProgram.setDemos

setDescription()

setDescription(description: string): void;

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/program.ts#L74

Parameters

Parameter	Type
`description`	`string`

Returns

void

Inherited from

AxProgram.setDescription

setExamples()

setExamples(examples: Readonly<AxProgramExamples<IN, OUT>>, options?: Readonly<AxSetExamplesOptions>): void;

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/generate.ts#L1091

Parameters

Parameter	Type
`examples`	`Readonly`<`AxProgramExamples`<`IN`, `OUT`>>
`options?`	`Readonly`<`AxSetExamplesOptions`>

Returns

void

Implementation of

AxProgrammable.setExamples

Overrides

AxProgram.setExamples

setId()

setId(id: string): void;

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/program.ts#L91

Parameters

Parameter	Type
`id`	`string`

Returns

void

Implementation of

AxProgrammable.setId

Inherited from

AxProgram.setId

setParentId()

setParentId(parentId: string): void;

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/program.ts#L98

Parameters

Parameter	Type
`parentId`	`string`

Returns

void

Implementation of

AxProgrammable.setParentId

Inherited from

AxProgram.setParentId

setSignature()

setSignature(signature: 
  | undefined
  | Readonly<
  | string
  | AxSignature<Record<string, any>, Record<string, any>>
  | AxSignatureConfig>): void;

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/program.ts#L60

Parameters

Parameter	Type
`signature`	\| `undefined` \| `Readonly`< \| `string` \| `AxSignature`<`Record`<`string`, `any`>, `Record`<`string`, `any`>> \| `AxSignatureConfig`>

Returns

void

Inherited from

AxProgram.setSignature

streamingForward()

streamingForward<T>(
   ai: T, 
   values: IN | AxMessage<IN>[], 
options?: Readonly<AxProgramStreamingForwardOptionsWithModels<T>>): AxGenStreamingOut<OUT>;

Defined in: https://github.com/ax-llm/ax/blob/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/generate.ts#L1036

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/be56d0cb4027af0a3a23d397cd01a57261e362d4/src/ax/dsp/generate.ts#L177

Parameters

Parameter	Type
`meter?`	`Meter`

Returns

void