Skip to main content

Class: SummaryIndexLLMRetriever

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

Implements​

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

Defined in​

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

Properties​

choiceBatchSize​

choiceBatchSize: number

Defined in​

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

choiceSelectPrompt​

choiceSelectPrompt: ChoiceSelectPrompt

Defined in​

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

formatNodeBatchFn​

formatNodeBatchFn: NodeFormatterFunction

Defined in​

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

index​

index: SummaryIndex

Defined in​

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

parseChoiceSelectAnswerFn​

parseChoiceSelectAnswerFn: ChoiceSelectParserFunction

Defined in​

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

serviceContext?​

optional serviceContext: ServiceContext

Deprecated​

to be deprecated soon

Implementation of​

BaseRetriever.serviceContext

Defined in​

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

Methods​

retrieve()​

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

Parameters​

• __namedParameters: RetrieveParams

Returns​

Promise<NodeWithScore<Metadata>[]>

Implementation of​

BaseRetriever.retrieve

Defined in​

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