SummaryIndexLLMRetriever

Defined in: packages/llamaindex/src/indices/summary/index.ts:310

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

Extends

• BaseRetriever

Constructors

Constructor

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

Defined in: packages/llamaindex/src/indices/summary/index.ts:317

Parameters

index

SummaryIndex

choiceSelectPrompt?

ChoiceSelectPrompt

choiceBatchSize?

number = 10

formatNodeBatchFn?

NodeFormatterFunction

parseChoiceSelectAnswerFn?

ChoiceSelectParserFunction

Returns

SummaryIndexLLMRetriever

Overrides

BaseRetriever.constructor

Properties

index

index: SummaryIndex

Defined in: packages/llamaindex/src/indices/summary/index.ts:311

---

choiceSelectPrompt

choiceSelectPrompt: ChoiceSelectPrompt

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

---

choiceBatchSize

choiceBatchSize: number

Defined in: packages/llamaindex/src/indices/summary/index.ts:313

---

formatNodeBatchFn

formatNodeBatchFn: NodeFormatterFunction

Defined in: packages/llamaindex/src/indices/summary/index.ts:314

---

parseChoiceSelectAnswerFn

parseChoiceSelectAnswerFn: ChoiceSelectParserFunction

Defined in: packages/llamaindex/src/indices/summary/index.ts:315

Methods

_retrieve()

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

Defined in: packages/llamaindex/src/indices/summary/index.ts:333

Parameters

query

QueryBundle

Returns

Promise<NodeWithScore<Metadata>[]>

Overrides

BaseRetriever._retrieve