KeywordExtractor
Defined in: .build/typescript/packages/llamaindex/src/extractors/MetadataExtractors.ts:35
Extract keywords from a list of nodes.
Extends
Section titled “Extends”KeywordExtractor<
Options>(nodes,options?):BaseNode<Metadata>[] |Promise<BaseNode<Metadata>[]>
Defined in: .build/typescript/packages/llamaindex/src/extractors/MetadataExtractors.ts:35
Extract keywords 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 KeywordExtractor(
options?):KeywordExtractor
Defined in: .build/typescript/packages/llamaindex/src/extractors/MetadataExtractors.ts:61
Constructor for the KeywordExtractor class.
Parameters
Section titled “Parameters”options?
Section titled “options?”KeywordExtractArgs
Returns
Section titled “Returns”KeywordExtractor
Throws
Section titled “Throws”If keywords is less than 1.
Overrides
Section titled “Overrides”Properties
Section titled “Properties”llm:
LLM
Defined in: .build/typescript/packages/llamaindex/src/extractors/MetadataExtractors.ts:40
LLM instance.
keywords
Section titled “keywords”keywords:
number=5
Defined in: .build/typescript/packages/llamaindex/src/extractors/MetadataExtractors.ts:47
Number of keywords to extract.
Default
Section titled “Default”5promptTemplate
Section titled “promptTemplate”promptTemplate:
KeywordExtractPrompt
Defined in: .build/typescript/packages/llamaindex/src/extractors/MetadataExtractors.ts:53
The prompt template to use for the question 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”extractKeywordsFromNodes()
Section titled “extractKeywordsFromNodes()”extractKeywordsFromNodes(
node):Promise<object|ExtractKeyword>
Defined in: .build/typescript/packages/llamaindex/src/extractors/MetadataExtractors.ts:82
Parameters
Section titled “Parameters”BaseNode
Node to extract keywords from.
Returns
Section titled “Returns”Promise<object | ExtractKeyword>
Keywords extracted from the node.
extract()
Section titled “extract()”extract(
nodes):Promise<ExtractKeyword[] |object[]>
Defined in: .build/typescript/packages/llamaindex/src/extractors/MetadataExtractors.ts:106
Parameters
Section titled “Parameters”BaseNode<Metadata>[]
Nodes to extract keywords from.
Returns
Section titled “Returns”Promise<ExtractKeyword[] | object[]>
Keywords 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.