Class: SummaryIndexLLMRetriever
LLM retriever for SummaryIndex which lets you select the most relevant chunks.
Implements
Constructors
constructor
• new SummaryIndexLLMRetriever(index
, choiceSelectPrompt?
, choiceBatchSize?
, formatNodeBatchFn?
, parseChoiceSelectAnswerFn?
, serviceContext?
): SummaryIndexLLMRetriever
Parameters
Name | Type | Default value |
---|---|---|
index | SummaryIndex | undefined |
choiceSelectPrompt? | (__namedParameters : { context : undefined | string = ""; query : undefined | string = "" }) => string | undefined |
choiceBatchSize | number | 10 |
formatNodeBatchFn? | NodeFormatterFunction | undefined |
parseChoiceSelectAnswerFn? | ChoiceSelectParserFunction | undefined |
serviceContext? | ServiceContext | undefined |
Returns
Defined in
packages/core/src/indices/summary/index.ts:320
Properties
choiceBatchSize
• choiceBatchSize: number
Defined in
packages/core/src/indices/summary/index.ts:314
choiceSelectPrompt
• choiceSelectPrompt: (__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
Defined in
packages/core/src/indices/summary/index.ts:313
formatNodeBatchFn
• formatNodeBatchFn: NodeFormatterFunction
Defined in
packages/core/src/indices/summary/index.ts:315
index
• index: SummaryIndex
Defined in
packages/core/src/indices/summary/index.ts:312
parseChoiceSelectAnswerFn
• parseChoiceSelectAnswerFn: ChoiceSelectParserFunction
Defined in
packages/core/src/indices/summary/index.ts:316
serviceContext
• Optional
serviceContext: ServiceContext
Implementation of
Defined in
packages/core/src/indices/summary/index.ts:317
Methods
retrieve
▸ retrieve(«destructured»
): Promise
<NodeWithScore
<Metadata
>[]>
Parameters
Name | Type |
---|---|
|