Skip to main content

Class: SummaryIndexLLMRetriever

LLM retriever for SummaryIndex which lets you select the most relevant chunks.

Extends

Constructors

new SummaryIndexLLMRetriever()

new SummaryIndexLLMRetriever(index, choiceSelectPrompt?, choiceBatchSize?, formatNodeBatchFn?, parseChoiceSelectAnswerFn?, serviceContext?): SummaryIndexLLMRetriever

Parameters

index: SummaryIndex

choiceSelectPrompt?: ChoiceSelectPrompt

choiceBatchSize?: number = 10

formatNodeBatchFn?: NodeFormatterFunction

parseChoiceSelectAnswerFn?: ChoiceSelectParserFunction

serviceContext?: ServiceContext

Returns

SummaryIndexLLMRetriever

Overrides

BaseRetriever.constructor

Defined in

packages/llamaindex/src/indices/summary/index.ts:312

Properties

choiceBatchSize

choiceBatchSize: number

Defined in

packages/llamaindex/src/indices/summary/index.ts:306


choiceSelectPrompt

choiceSelectPrompt: ChoiceSelectPrompt

Defined in

packages/llamaindex/src/indices/summary/index.ts:305


formatNodeBatchFn

formatNodeBatchFn: NodeFormatterFunction

Defined in

packages/llamaindex/src/indices/summary/index.ts:307


index

index: SummaryIndex

Defined in

packages/llamaindex/src/indices/summary/index.ts:304


objectMap

objectMap: Map<string, unknown>

Inherited from

BaseRetriever.objectMap

Defined in

packages/core/retriever/dist/index.d.ts:20


parseChoiceSelectAnswerFn

parseChoiceSelectAnswerFn: ChoiceSelectParserFunction

Defined in

packages/llamaindex/src/indices/summary/index.ts:308


serviceContext?

optional serviceContext: ServiceContext

Defined in

packages/llamaindex/src/indices/summary/index.ts:309

Methods

_getPromptModules()

protected _getPromptModules(): object

Return a dictionary of sub-modules within the current module that also implement PromptMixin (so that their prompts can also be get/set).

Can be blank if no sub-modules.

Returns

object

Inherited from

BaseRetriever._getPromptModules

Defined in

packages/core/retriever/dist/index.d.ts:23


_getPrompts()

protected _getPrompts(): object

Returns

object

Inherited from

BaseRetriever._getPrompts

Defined in

packages/core/retriever/dist/index.d.ts:22


_handleRecursiveRetrieval()

_handleRecursiveRetrieval(params, nodes): Promise<NodeWithScore<Metadata>[]>

Parameters

params: QueryBundle

nodes: NodeWithScore<Metadata>[]

Returns

Promise<NodeWithScore<Metadata>[]>

Inherited from

BaseRetriever._handleRecursiveRetrieval

Defined in

packages/core/retriever/dist/index.d.ts:27


_retrieve()

_retrieve(query): Promise<NodeWithScore<Metadata>[]>

Parameters

query: QueryBundle

Returns

Promise<NodeWithScore<Metadata>[]>

Overrides

BaseRetriever._retrieve

Defined in

packages/llamaindex/src/indices/summary/index.ts:330


_retrieveFromObject()

_retrieveFromObject(object, queryBundle, score): NodeWithScore<Metadata>[]

Parameters

object: unknown

queryBundle: QueryBundle

score: number

Returns

NodeWithScore<Metadata>[]

Inherited from

BaseRetriever._retrieveFromObject

Defined in

packages/core/retriever/dist/index.d.ts:28


_updatePrompts()

protected _updatePrompts(): void

Returns

void

Inherited from

BaseRetriever._updatePrompts

Defined in

packages/core/retriever/dist/index.d.ts:21


getPrompts()

getPrompts(): PromptsRecord

Returns

PromptsRecord

Inherited from

BaseRetriever.getPrompts

Defined in

packages/core/prompts/dist/index.d.ts:58


retrieve()

retrieve(params): Promise<NodeWithScore<Metadata>[]>

Parameters

params: QueryType

Returns

Promise<NodeWithScore<Metadata>[]>

Inherited from

BaseRetriever.retrieve

Defined in

packages/core/retriever/dist/index.d.ts:25


updatePrompts()

updatePrompts(prompts): void

Parameters

prompts: PromptsRecord

Returns

void

Inherited from

BaseRetriever.updatePrompts

Defined in

packages/core/prompts/dist/index.d.ts:59


validatePrompts()

validatePrompts(promptsDict, moduleDict): void

Parameters

promptsDict: PromptsRecord

moduleDict: ModuleRecord

Returns

void

Inherited from

BaseRetriever.validatePrompts

Defined in

packages/core/prompts/dist/index.d.ts:57