Skip to main content

Class: TitleExtractor()

Extract title from a list of nodes.

Extends

TitleExtractor<Options>(nodes, options?): Promise<BaseNode<Metadata>[]>

Extract title from a list of nodes.

Type Parameters

Options extends Record<string, unknown>

Parameters

nodes: BaseNode<Metadata>[]

options?: Options

Returns

Promise<BaseNode<Metadata>[]>

Defined in

packages/llamaindex/src/extractors/MetadataExtractors.ts:126

Constructors

new TitleExtractor()

new TitleExtractor(options?): TitleExtractor

Constructor for the TitleExtractor class.

Parameters

options?: TitleExtractorsArgs

Returns

TitleExtractor

Overrides

BaseExtractor.constructor

Defined in

packages/llamaindex/src/extractors/MetadataExtractors.ts:166

Properties

combineTemplate

combineTemplate: TitleCombinePrompt

The prompt template to merge title with..

Defined in

packages/llamaindex/src/extractors/MetadataExtractors.ts:157


disableTemplateRewrite

disableTemplateRewrite: boolean = false

Inherited from

BaseExtractor.disableTemplateRewrite

Defined in

packages/llamaindex/src/extractors/types.ts:16


id

id: string

Inherited from

BaseExtractor.id

Defined in

packages/core/schema/dist/index.d.ts:171


inPlace

inPlace: boolean = true

Inherited from

BaseExtractor.inPlace

Defined in

packages/llamaindex/src/extractors/types.ts:17


isTextNodeOnly

isTextNodeOnly: boolean = false

Can work for mixture of text and non-text nodes

Default

false

Overrides

BaseExtractor.isTextNodeOnly

Defined in

packages/llamaindex/src/extractors/MetadataExtractors.ts:138


llm

llm: LLM<object, object>

LLM instance.

Defined in

packages/llamaindex/src/extractors/MetadataExtractors.ts:131


metadataMode

metadataMode: MetadataMode = MetadataMode.ALL

Inherited from

BaseExtractor.metadataMode

Defined in

packages/llamaindex/src/extractors/types.ts:15


nodeTemplate

nodeTemplate: TitleExtractorPrompt

The prompt template to use for the title extractor.

Defined in

packages/llamaindex/src/extractors/MetadataExtractors.ts:151


nodes

nodes: number = 5

Number of nodes to extrct titles from.

Default

5

Defined in

packages/llamaindex/src/extractors/MetadataExtractors.ts:145


numWorkers

numWorkers: number = 4

Inherited from

BaseExtractor.numWorkers

Defined in

packages/llamaindex/src/extractors/types.ts:18


showProgress

showProgress: boolean = true

Inherited from

BaseExtractor.showProgress

Defined in

packages/llamaindex/src/extractors/types.ts:14

Methods

extract()

extract(nodes): Promise<ExtractTitle[]>

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

BaseExtractor.extract

Defined in

packages/llamaindex/src/extractors/MetadataExtractors.ts:192


processNodes()

processNodes(nodes, excludedEmbedMetadataKeys, excludedLlmMetadataKeys): Promise<BaseNode<Metadata>[]>

Parameters

nodes: BaseNode<Metadata>[]

Nodes to extract metadata from.

excludedEmbedMetadataKeys: undefined | string[] = undefined

Metadata keys to exclude from the embedding.

excludedLlmMetadataKeys: undefined | string[] = undefined

Metadata keys to exclude from the LLM.

Returns

Promise<BaseNode<Metadata>[]>

Metadata extracted from the nodes.

Inherited from

BaseExtractor.processNodes

Defined in

packages/llamaindex/src/extractors/types.ts:39