AxRAG

Class: AxRAG

Extends

• AxChainOfThought<object, object>

Constructors

new AxRAG()

new AxRAG(queryFn, options): AxRAG

Parameters

• queryFn

• options: Readonly<AxGenOptions & object>

Returns

AxRAG

Overrides

AxChainOfThought.constructor

Defined in

src/ax/prompts/rag.ts:23

Properties

demos?

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

Inherited from

AxChainOfThought.demos

Defined in

src/ax/dsp/program.ts:88

---

examples?

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

Inherited from

AxChainOfThought.examples

Defined in

src/ax/dsp/program.ts:87

---

sigHash

protected sigHash: string

Inherited from

AxChainOfThought.sigHash

Defined in

src/ax/dsp/program.ts:85

---

signature

protected signature: AxSignature

Inherited from

AxChainOfThought.signature

Defined in

src/ax/dsp/program.ts:84

---

trace?

protected optional trace: Record<string, AxFieldValue>

Inherited from

AxChainOfThought.trace

Defined in

src/ax/dsp/program.ts:89

---

usage

protected usage: AxTokenUsage & object[] = []

Inherited from

AxChainOfThought.usage

Defined in

src/ax/dsp/program.ts:90

Methods

addAssert()

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

Parameters

• fn

• message?: string

• optional?: boolean

Returns

void

Inherited from

AxChainOfThought.addAssert

Defined in

src/ax/dsp/generate.ts:133

---

addStreamingAssert()

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

Parameters

• fieldName: string

• fn

• message?: string

• optional?: boolean

Returns

void

Inherited from

AxChainOfThought.addStreamingAssert

Defined in

src/ax/dsp/generate.ts:141

---

forward()

forward(ai, __namedParameters, options?): Promise<object>

Parameters

• ai: Readonly<AxAIService>

• __namedParameters: Readonly<object>

• options?: Readonly<AxProgramForwardOptions>

Returns

Promise<object>

answer

answer: string

reason

reason: string

Overrides

AxChainOfThought.forward

Defined in

src/ax/prompts/rag.ts:44

---

getSignature()

getSignature(): AxSignature

Returns

AxSignature

Inherited from

AxChainOfThought.getSignature

Defined in

src/ax/dsp/program.ts:109

---

getTraces()

getTraces(): AxProgramTrace[]

Returns

AxProgramTrace[]

Inherited from

AxChainOfThought.getTraces

Defined in

src/ax/dsp/program.ts:185

---

getUsage()

getUsage(): AxTokenUsage & object[]

Returns

AxTokenUsage & object[]

Inherited from

AxChainOfThought.getUsage

Defined in

src/ax/dsp/program.ts:199

---

register()

register(prog): void

Parameters

• prog: Readonly<AxTunable & AxUsable>

Returns

void

Inherited from

AxChainOfThought.register

Defined in

src/ax/dsp/program.ts:113

---

resetUsage()

resetUsage(): void

Returns

void

Inherited from

AxChainOfThought.resetUsage

Defined in

src/ax/dsp/program.ts:209

---

setDemos()

setDemos(demos): void

Parameters

• demos: readonly AxProgramDemos[]

Returns

void

Inherited from

AxChainOfThought.setDemos

Defined in

src/ax/dsp/program.ts:216

---

setExamples()

setExamples(examples): void

Parameters

• examples: Readonly<AxProgramExamples>

Returns

void

Inherited from

AxChainOfThought.setExamples

Defined in

src/ax/dsp/program.ts:144

---

setId()

setId(id): void

Parameters

• id: string

Returns

void

Inherited from

AxChainOfThought.setId

Defined in

src/ax/dsp/program.ts:131

---

setParentId()

setParentId(parentId): void

Parameters

• parentId: string

Returns

void

Inherited from

AxChainOfThought.setParentId

Defined in

src/ax/dsp/program.ts:138