TitleExtractor
Defined in: llamaindex/src/extractors/MetadataExtractors.ts:130
Extract title from a list of nodes.
Extends
TitleExtractor<
Options>(nodes,options?):BaseNode<Metadata>[] |Promise<BaseNode<Metadata>[]>
Defined in: llamaindex/src/extractors/MetadataExtractors.ts:130
Extract title 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 TitleExtractor()
new TitleExtractor(
options?):TitleExtractor
Defined in: llamaindex/src/extractors/MetadataExtractors.ts:170
Constructor for the TitleExtractor class.
Parameters
options?
TitleExtractorsArgs
Returns
Overrides
Properties
llm
llm:
LLM<object,object>
Defined in: llamaindex/src/extractors/MetadataExtractors.ts:135
LLM instance.
isTextNodeOnly
isTextNodeOnly:
boolean=false
Defined in: llamaindex/src/extractors/MetadataExtractors.ts:142
Can work for mixture of text and non-text nodes
Default
Overrides
nodes
nodes:
number=5
Defined in: llamaindex/src/extractors/MetadataExtractors.ts:149
Number of nodes to extrct titles from.
Default
nodeTemplate
nodeTemplate:
TitleExtractorPrompt
Defined in: llamaindex/src/extractors/MetadataExtractors.ts:155
The prompt template to use for the title extractor.
combineTemplate
combineTemplate:
TitleCombinePrompt
Defined in: llamaindex/src/extractors/MetadataExtractors.ts:161
The prompt template to merge title with..
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
extract()
extract(
nodes):Promise<ExtractTitle[]>
Defined in: llamaindex/src/extractors/MetadataExtractors.ts:196
Extract titles from a list of nodes.
Parameters
nodes
BaseNode<Metadata>[]
Nodes to extract titles from.
Returns
Promise<ExtractTitle[]>
Titles 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.