Class: CompactAndRefine

CompactAndRefine is a slight variation of Refine that first compacts the text chunks into the smallest possible number of chunks.

Hierarchy

• Refine

  ↳ CompactAndRefine

Constructors

constructor

• new CompactAndRefine(serviceContext?, textQATemplate?, refineTemplate?): CompactAndRefine

Parameters

Name	Type
serviceContext?	ServiceContext
textQATemplate?	(__namedParameters: { context: undefined | string = ""; query: undefined | string = "" }) => string
refineTemplate?	(__namedParameters: { context: undefined | string = ""; existingAnswer: undefined | string = ""; query: undefined | string = "" }) => string

Returns

CompactAndRefine

Inherited from

Refine.constructor

Defined in

packages/core/src/synthesizers/builders.ts:90

Properties

llm

• llm: LLM

Inherited from

Refine.llm

Defined in

packages/core/src/synthesizers/builders.ts:85

---

promptHelper

• promptHelper: PromptHelper

Inherited from

Refine.promptHelper

Defined in

packages/core/src/synthesizers/builders.ts:86

---

refineTemplate

• refineTemplate: (__namedParameters: { context: undefined | string = ""; existingAnswer: undefined | string = ""; query: undefined | string = "" }) => string

Type declaration

▸ («destructured»): string

Parameters

Name	Type	Default value
«destructured»	Object	undefined
› context	undefined | string	""
› existingAnswer	undefined | string	""
› query	undefined | string	""

Returns

string

Inherited from

Refine.refineTemplate

Defined in

packages/core/src/synthesizers/builders.ts:88

---

textQATemplate

• textQATemplate: (__namedParameters: { context: undefined | string = ""; query: undefined | string = "" }) => string

Type declaration

▸ («destructured»): string

Parameters

Name	Type	Default value
«destructured»	Object	undefined
› context	undefined | string	""
› query	undefined | string	""

Returns

string

Inherited from

Refine.textQATemplate

Defined in

packages/core/src/synthesizers/builders.ts:87

Methods

_getPromptModules

▸ _getPromptModules(): Record<string, any>

Returns

Record<string, any>

Inherited from

Refine._getPromptModules

Defined in

packages/core/src/prompts/Mixin.ts:82

---

_getPrompts

▸ _getPrompts(): Object

Returns

Object

Name	Type
refineTemplate	(__namedParameters: { context: undefined | string = ""; existingAnswer: undefined | string = ""; query: undefined | string = "" }) => string
textQATemplate	(__namedParameters: { context: undefined | string = ""; existingAnswer: undefined | string = ""; query: undefined | string = "" }) => string

Inherited from

Refine._getPrompts

Defined in

packages/core/src/synthesizers/builders.ts:103

---

_updatePrompts

▸ _updatePrompts(prompts): void

Parameters

Name	Type
prompts	Object
prompts.refineTemplate	(__namedParameters: { context: undefined | string = ""; existingAnswer: undefined | string = ""; query: undefined | string = "" }) => string
prompts.textQATemplate	(__namedParameters: { context: undefined | string = ""; existingAnswer: undefined | string = ""; query: undefined | string = "" }) => string

Returns

void

Inherited from

Refine._updatePrompts

Defined in

packages/core/src/synthesizers/builders.ts:113

---

complete

▸ complete(params): Promise<string | AsyncIterable<string>>

Parameters

Name	Type
params	Object
params.parentEvent?	Event
params.prompt	string
params.stream	boolean

Returns

Promise<string | AsyncIterable<string>>

Inherited from

Refine.complete

Defined in

packages/core/src/synthesizers/builders.ts:234

---

getPrompts

▸ getPrompts(): PromptsDict

Returns all prompts from the mixin and its modules

Returns

PromptsDict

Inherited from

Refine.getPrompts

Defined in

packages/core/src/prompts/Mixin.ts:27

---

getResponse

▸ getResponse(params): Promise<AsyncIterable<string>>

Get the response from a query and a list of text chunks.

Parameters

Name	Type
params	ResponseBuilderParamsStreaming

Returns

Promise<AsyncIterable<string>>

Overrides

Refine.getResponse

Defined in

packages/core/src/synthesizers/builders.ts:253

▸ getResponse(params): Promise<string>

Parameters

Name	Type
params	ResponseBuilderParamsNonStreaming

Returns

Promise<string>

Overrides

Refine.getResponse

Defined in

packages/core/src/synthesizers/builders.ts:256

---

updatePrompts

▸ updatePrompts(promptsDict): void

Updates the prompts in the mixin and its modules

Parameters

Name	Type
promptsDict	PromptsDict

Returns

void

Inherited from

Refine.updatePrompts

Defined in

packages/core/src/prompts/Mixin.ts:48

---

validatePrompts

▸ validatePrompts(promptsDict, moduleDict): void

Validates the prompt keys and module keys

Parameters

Name	Type
promptsDict	PromptsDict
moduleDict	ModuleDict

Returns

void

Inherited from

Refine.validatePrompts

Defined in

packages/core/src/prompts/Mixin.ts:10