SummaryIndexLLMRetriever
Defined in: .build/typescript/packages/llamaindex/src/indices/summary/index.ts:310
LLM retriever for SummaryIndex which lets you select the most relevant chunks.
Extends
Section titled “Extends”BaseRetriever
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SummaryIndexLLMRetriever(
index,choiceSelectPrompt?,choiceBatchSize?,formatNodeBatchFn?,parseChoiceSelectAnswerFn?):SummaryIndexLLMRetriever
Defined in: .build/typescript/packages/llamaindex/src/indices/summary/index.ts:317
Parameters
Section titled “Parameters”choiceSelectPrompt?
Section titled “choiceSelectPrompt?”ChoiceSelectPrompt
choiceBatchSize?
Section titled “choiceBatchSize?”number = 10
formatNodeBatchFn?
Section titled “formatNodeBatchFn?”parseChoiceSelectAnswerFn?
Section titled “parseChoiceSelectAnswerFn?”Returns
Section titled “Returns”SummaryIndexLLMRetriever
Overrides
Section titled “Overrides”BaseRetriever.constructor
Properties
Section titled “Properties”index:
SummaryIndex
Defined in: .build/typescript/packages/llamaindex/src/indices/summary/index.ts:311
choiceSelectPrompt
Section titled “choiceSelectPrompt”choiceSelectPrompt:
ChoiceSelectPrompt
Defined in: .build/typescript/packages/llamaindex/src/indices/summary/index.ts:312
choiceBatchSize
Section titled “choiceBatchSize”choiceBatchSize:
number
Defined in: .build/typescript/packages/llamaindex/src/indices/summary/index.ts:313
formatNodeBatchFn
Section titled “formatNodeBatchFn”formatNodeBatchFn:
NodeFormatterFunction
Defined in: .build/typescript/packages/llamaindex/src/indices/summary/index.ts:314
parseChoiceSelectAnswerFn
Section titled “parseChoiceSelectAnswerFn”parseChoiceSelectAnswerFn:
ChoiceSelectParserFunction
Defined in: .build/typescript/packages/llamaindex/src/indices/summary/index.ts:315
Methods
Section titled “Methods”_retrieve()
Section titled “_retrieve()”_retrieve(
query):Promise<NodeWithScore<Metadata>[]>
Defined in: .build/typescript/packages/llamaindex/src/indices/summary/index.ts:333
Parameters
Section titled “Parameters”QueryBundle
Returns
Section titled “Returns”Promise<NodeWithScore<Metadata>[]>
Overrides
Section titled “Overrides”BaseRetriever._retrieve