Class: TitleExtractor

Extract title from a list of nodes.

Hierarchy

• BaseExtractor

  ↳ TitleExtractor

Constructors

constructor

• new TitleExtractor(options?): TitleExtractor

Constructor for the TitleExtractor class.

Parameters

Name	Type
options?	TitleExtractorsArgs

Returns

TitleExtractor

Overrides

BaseExtractor.constructor

Defined in

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

Properties

combineTemplate

• combineTemplate: string

The prompt template to merge title with..

Defined in

packages/core/src/extractors/MetadataExtractors.ts:136

---

disableTemplateRewrite

• disableTemplateRewrite: boolean = false

Inherited from

BaseExtractor.disableTemplateRewrite

Defined in

packages/core/src/extractors/types.ts:12

---

inPlace

• inPlace: boolean = true

Inherited from

BaseExtractor.inPlace

Defined in

packages/core/src/extractors/types.ts:13

---

isTextNodeOnly

• isTextNodeOnly: boolean = false

Can work for mixture of text and non-text nodes

Default

false

Overrides

BaseExtractor.isTextNodeOnly

Defined in

packages/core/src/extractors/MetadataExtractors.ts:117

---

llm

• llm: LLM

LLM instance.

Defined in

packages/core/src/extractors/MetadataExtractors.ts:110

---

metadataMode

• metadataMode: MetadataMode = MetadataMode.ALL

Inherited from

BaseExtractor.metadataMode

Defined in

packages/core/src/extractors/types.ts:11

---

nodeTemplate

• nodeTemplate: string

The prompt template to use for the title extractor.

Defined in

packages/core/src/extractors/MetadataExtractors.ts:130

---

nodes

• nodes: number = 5

Number of nodes to extrct titles from.

Default

5

Defined in

packages/core/src/extractors/MetadataExtractors.ts:124

---

numWorkers

• numWorkers: number = 4

Inherited from

BaseExtractor.numWorkers

Defined in

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

---

showProgress

• showProgress: boolean = true

Inherited from

BaseExtractor.showProgress

Defined in

packages/core/src/extractors/types.ts:10

Methods

extract

▸ extract(nodes): Promise<ExtractTitle[]>

Extract titles from a list of nodes.

Parameters

Name	Type	Description
nodes	BaseNode<Metadata>[]	Nodes to extract titles from.

Returns

Promise<ExtractTitle[]>

Titles extracted from the nodes.

Overrides

BaseExtractor.extract

Defined in

packages/core/src/extractors/MetadataExtractors.ts:162

---

processNodes

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

Parameters

Name	Type	Default value	Description
nodes	BaseNode<Metadata>[]	undefined	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/core/src/extractors/types.ts:33

---

transform

▸ transform(nodes, options?): Promise<BaseNode<Metadata>[]>

Parameters

Name	Type
nodes	BaseNode<Metadata>[]
options?	any

Returns

Promise<BaseNode<Metadata>[]>

Inherited from

BaseExtractor.transform

Defined in

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