Skip to content

AxProgramWithSignature

Class: AxProgramWithSignature<IN, OUT>

Extended by

Type Parameters

IN extends AxGenIn

OUT extends AxGenOut

Implements

Constructors

new AxProgramWithSignature()

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

Parameters

signature: Readonly<string | AxSignature>

options?: Readonly<AxProgramWithSignatureOptions>

Returns

AxProgramWithSignature<IN, OUT>

Defined in

src/ax/dsp/program.ts:95

Properties

demos?

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

Defined in

src/ax/dsp/program.ts:88


examples?

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

Defined in

src/ax/dsp/program.ts:87


sigHash

protected sigHash: string

Defined in

src/ax/dsp/program.ts:85


signature

protected signature: AxSignature

Defined in

src/ax/dsp/program.ts:84


trace?

protected optional trace: Record<string, AxFieldValue>

Defined in

src/ax/dsp/program.ts:89


usage

protected usage: AxTokenUsage & object[] = []

Defined in

src/ax/dsp/program.ts:90

Methods

forward()

forward(_ai, _values, _options?): Promise<OUT>

Parameters

_ai: Readonly<AxAIService>

_values: IN

_options?: Readonly<AxProgramForwardOptions>

Returns

Promise<OUT>

Defined in

src/ax/dsp/program.ts:120


getSignature()

getSignature(): AxSignature

Returns

AxSignature

Defined in

src/ax/dsp/program.ts:109


getTraces()

getTraces(): AxProgramTrace[]

Returns

AxProgramTrace[]

Implementation of

AxTunable.getTraces

Defined in

src/ax/dsp/program.ts:185


getUsage()

getUsage(): AxTokenUsage & object[]

Returns

AxTokenUsage & object[]

Implementation of

AxUsable.getUsage

Defined in

src/ax/dsp/program.ts:199


register()

register(prog): void

Parameters

prog: Readonly<AxTunable & AxUsable>

Returns

void

Defined in

src/ax/dsp/program.ts:113


resetUsage()

resetUsage(): void

Returns

void

Implementation of

AxUsable.resetUsage

Defined in

src/ax/dsp/program.ts:209


setDemos()

setDemos(demos): void

Parameters

demos: readonly AxProgramDemos[]

Returns

void

Implementation of

AxTunable.setDemos

Defined in

src/ax/dsp/program.ts:216


setExamples()

setExamples(examples): void

Parameters

examples: Readonly<AxProgramExamples>

Returns

void

Implementation of

AxTunable.setExamples

Defined in

src/ax/dsp/program.ts:144


setId()

setId(id): void

Parameters

id: string

Returns

void

Implementation of

AxTunable.setId

Defined in

src/ax/dsp/program.ts:131


setParentId()

setParentId(parentId): void

Parameters

parentId: string

Returns

void

Implementation of

AxTunable.setParentId

Defined in

src/ax/dsp/program.ts:138