SummaryExtractor
Defined in: packages/llamaindex/src/extractors/MetadataExtractors.ts:405
Extract summary from a list of nodes.
Extends
SummaryExtractor<
Options>(nodes,options?):BaseNode<Metadata>[] |Promise<BaseNode<Metadata>[]>
Defined in: packages/llamaindex/src/extractors/MetadataExtractors.ts:405
Extract summary from a list of nodes.
Type Parameters
Options
Options extends Record<string, unknown>
Parameters
nodes
BaseNode<Metadata>[]
options?
Options
Returns
BaseNode<Metadata>[] | Promise<BaseNode<Metadata>[]>
Constructors
Constructor
new SummaryExtractor(
options?):SummaryExtractor
Defined in: packages/llamaindex/src/extractors/MetadataExtractors.ts:428
Parameters
options?
SummaryExtractArgs
Returns
SummaryExtractor
Overrides
Properties
llm
llm:
LLM
Defined in: packages/llamaindex/src/extractors/MetadataExtractors.ts:410
LLM instance.
summaries
summaries:
string[]
Defined in: packages/llamaindex/src/extractors/MetadataExtractors.ts:416
List of summaries to extract: 'self', 'prev', 'next'
promptTemplate
promptTemplate:
SummaryPrompt
Defined in: packages/llamaindex/src/extractors/MetadataExtractors.ts:422
The prompt template to use for the summary extractor.
isTextNodeOnly
isTextNodeOnly:
boolean=true
Defined in: packages/llamaindex/src/extractors/types.ts:13
Inherited from
showProgress
showProgress:
boolean=true
Defined in: packages/llamaindex/src/extractors/types.ts:14
Inherited from
metadataMode
metadataMode:
MetadataMode=MetadataMode.ALL
Defined in: packages/llamaindex/src/extractors/types.ts:15
Inherited from
disableTemplateRewrite
disableTemplateRewrite:
boolean=false
Defined in: packages/llamaindex/src/extractors/types.ts:16
Inherited from
BaseExtractor.disableTemplateRewrite
inPlace
inPlace:
boolean=true
Defined in: packages/llamaindex/src/extractors/types.ts:17
Inherited from
numWorkers
numWorkers:
number=4
Defined in: packages/llamaindex/src/extractors/types.ts:18
Inherited from
Methods
generateNodeSummary()
generateNodeSummary(
node):Promise<string>
Defined in: packages/llamaindex/src/extractors/MetadataExtractors.ts:458
Extract summary from a node.
Parameters
node
BaseNode
Node to extract summary from.
Returns
Promise<string>
Summary extracted from the node.
extract()
extract(
nodes):Promise<object[] |ExtractSummary[]>
Defined in: packages/llamaindex/src/extractors/MetadataExtractors.ts:481
Extract summaries from a list of nodes.
Parameters
nodes
BaseNode<Metadata>[]
Nodes to extract summaries from.
Returns
Promise<object[] | ExtractSummary[]>
Summaries extracted from the nodes.
Overrides
processNodes()
processNodes(
nodes,excludedEmbedMetadataKeys,excludedLlmMetadataKeys):Promise<BaseNode<Metadata>[]>
Defined in: packages/llamaindex/src/extractors/types.ts:41
Parameters
nodes
BaseNode<Metadata>[]
Nodes to extract metadata from.
excludedEmbedMetadataKeys
Metadata keys to exclude from the embedding.
undefined | string[]
excludedLlmMetadataKeys
Metadata keys to exclude from the LLM.
undefined | string[]
Returns
Promise<BaseNode<Metadata>[]>
Metadata extracted from the nodes.