Skip to content

AxGenerate

Class: AxGenerate<IN, OUT>

Extends

Extended by

Type Parameters

IN extends AxGenIn = AxGenIn

OUT extends AxGenerateResult<AxGenOut> = AxGenerateResult<AxGenOut>

Constructors

new AxGenerate()

new AxGenerate<IN, OUT>(ai, signature, options?): AxGenerate<IN, OUT>

Parameters

ai: AxAIService

signature: Readonly<string | AxSignature>

options?: Readonly<AxGenerateOptions>

Returns

AxGenerate<IN, OUT>

Overrides

AxProgramWithSignature.constructor

Defined in

src/ax/dsp/generate.ts:86

Properties

demos?

protected optional demos: Record<string, AxFieldValue>[]

Inherited from

AxProgramWithSignature.demos

Defined in

src/ax/dsp/program.ts:81


examples?

protected optional examples: Record<string, AxFieldValue>[]

Inherited from

AxProgramWithSignature.examples

Defined in

src/ax/dsp/program.ts:80


sigHash

protected sigHash: string

Inherited from

AxProgramWithSignature.sigHash

Defined in

src/ax/dsp/program.ts:78


signature

protected signature: AxSignature

Inherited from

AxProgramWithSignature.signature

Defined in

src/ax/dsp/program.ts:77


trace?

protected optional trace: Record<string, AxFieldValue>

Inherited from

AxProgramWithSignature.trace

Defined in

src/ax/dsp/program.ts:82


usage

protected usage: AxTokenUsage & object[] = []

Inherited from

AxProgramWithSignature.usage

Defined in

src/ax/dsp/program.ts:83

Methods

addAssert()

addAssert(fn, message?, optional?): void

Parameters

fn

message?: string

optional?: boolean

Returns

void

Defined in

src/ax/dsp/generate.ts:135


addStreamingAssert()

addStreamingAssert(fieldName, fn, message?, optional?): void

Parameters

fieldName: string

fn

message?: string

optional?: boolean

Returns

void

Defined in

src/ax/dsp/generate.ts:143


forward()

forward(values, options?): Promise<OUT>

Parameters

values: IN

options?: Readonly<AxProgramForwardOptions>

Returns

Promise<OUT>

Overrides

AxProgramWithSignature.forward

Defined in

src/ax/dsp/generate.ts:442


getSignature()

getSignature(): AxSignature

Returns

AxSignature

Inherited from

AxProgramWithSignature.getSignature

Defined in

src/ax/dsp/program.ts:95


getTraces()

getTraces(): AxProgramTrace[]

Returns

AxProgramTrace[]

Inherited from

AxProgramWithSignature.getTraces

Defined in

src/ax/dsp/program.ts:169


getUsage()

getUsage(): AxTokenUsage & object[]

Returns

AxTokenUsage & object[]

Inherited from

AxProgramWithSignature.getUsage

Defined in

src/ax/dsp/program.ts:183


processFunctions()

processFunctions(functionCalls, mem, sessionId?, traceId?): Promise<void>

Parameters

functionCalls: readonly AxChatResponseFunctionCall[]

mem: Readonly<AxMemory>

sessionId?: string

traceId?: string

Returns

Promise<void>

Defined in

src/ax/dsp/generate.ts:471


register()

register(prog): void

Parameters

prog: Readonly<AxTunable & AxUsable>

Returns

void

Inherited from

AxProgramWithSignature.register

Defined in

src/ax/dsp/program.ts:99


resetUsage()

resetUsage(): void

Returns

void

Inherited from

AxProgramWithSignature.resetUsage

Defined in

src/ax/dsp/program.ts:193


setDemos()

setDemos(demos): void

Parameters

demos: readonly AxProgramDemos[]

Returns

void

Inherited from

AxProgramWithSignature.setDemos

Defined in

src/ax/dsp/program.ts:200


setExamples()

setExamples(examples): void

Parameters

examples: Readonly<AxProgramExamples>

Returns

void

Inherited from

AxProgramWithSignature.setExamples

Defined in

src/ax/dsp/program.ts:128


setId()

setId(id): void

Parameters

id: string

Returns

void

Inherited from

AxProgramWithSignature.setId

Defined in

src/ax/dsp/program.ts:115


setParentId()

setParentId(parentId): void

Parameters

parentId: string

Returns

void

Inherited from

AxProgramWithSignature.setParentId

Defined in

src/ax/dsp/program.ts:122