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