KeywordExtractor
Defined in: llamaindex/src/extractors/MetadataExtractors.ts:35
Extract keywords from a list of nodes.
Extends
KeywordExtractor<
Options>(nodes,options?):BaseNode<Metadata>[] |Promise<BaseNode<Metadata>[]>
Defined in: llamaindex/src/extractors/MetadataExtractors.ts:35
Extract keywords from a list of nodes.
Type Parameters
• Options extends Record<string, unknown>
Parameters
nodes
BaseNode<Metadata>[]
options?
Options
Returns
BaseNode<Metadata>[] | Promise<BaseNode<Metadata>[]>
Constructors
new KeywordExtractor()
new KeywordExtractor(
options?):KeywordExtractor
Defined in: llamaindex/src/extractors/MetadataExtractors.ts:61
Constructor for the KeywordExtractor class.
Parameters
options?
KeywordExtractArgs
Returns
Throws
If keywords is less than 1.
Overrides
Properties
llm
llm:
LLM<object,object>
Defined in: llamaindex/src/extractors/MetadataExtractors.ts:40
LLM instance.
keywords
keywords:
number=5
Defined in: llamaindex/src/extractors/MetadataExtractors.ts:47
Number of keywords to extract.
Default
promptTemplate
promptTemplate:
KeywordExtractPrompt
Defined in: llamaindex/src/extractors/MetadataExtractors.ts:53
The prompt template to use for the question extractor.
isTextNodeOnly
isTextNodeOnly:
boolean=true
Defined in: llamaindex/src/extractors/types.ts:13
Inherited from
showProgress
showProgress:
boolean=true
Defined in: llamaindex/src/extractors/types.ts:14
Inherited from
metadataMode
metadataMode:
MetadataMode=MetadataMode.ALL
Defined in: llamaindex/src/extractors/types.ts:15
Inherited from
disableTemplateRewrite
disableTemplateRewrite:
boolean=false
Defined in: llamaindex/src/extractors/types.ts:16
Inherited from
BaseExtractor.disableTemplateRewrite
inPlace
inPlace:
boolean=true
Defined in: llamaindex/src/extractors/types.ts:17
Inherited from
numWorkers
numWorkers:
number=4
Defined in: llamaindex/src/extractors/types.ts:18
Inherited from
Methods
extractKeywordsFromNodes()
extractKeywordsFromNodes(
node):Promise<object|ExtractKeyword>
Defined in: llamaindex/src/extractors/MetadataExtractors.ts:82
Parameters
node
BaseNode<Metadata>
Node to extract keywords from.
Returns
Promise<object | ExtractKeyword>
Keywords extracted from the node.
extract()
extract(
nodes):Promise<ExtractKeyword[] |object[]>
Defined in: llamaindex/src/extractors/MetadataExtractors.ts:106
Parameters
nodes
BaseNode<Metadata>[]
Nodes to extract keywords from.
Returns
Promise<ExtractKeyword[] | object[]>
Keywords extracted from the nodes.
Overrides
processNodes()
processNodes(
nodes,excludedEmbedMetadataKeys,excludedLlmMetadataKeys):Promise<BaseNode<Metadata>[]>
Defined in: 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.