Class: BaseExtractor

Hierarchy

• BaseExtractor

  ↳ KeywordExtractor

  ↳ QuestionsAnsweredExtractor

  ↳ SummaryExtractor

  ↳ TitleExtractor

Implements

• TransformComponent

Constructors

constructor

• new BaseExtractor(): BaseExtractor

Returns

BaseExtractor

Properties

disableTemplateRewrite

• disableTemplateRewrite: boolean = false

Defined in

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

---

inPlace

• inPlace: boolean = true

Defined in

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

---

isTextNodeOnly

• isTextNodeOnly: boolean = true

Defined in

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

---

metadataMode

• metadataMode: MetadataMode = MetadataMode.ALL

Defined in

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

---

numWorkers

• numWorkers: number = 4

Defined in

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

---

showProgress

• showProgress: boolean = true

Defined in

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

Methods

extract

▸ extract(nodes): Promise<Record<string, any>[]>

Parameters

Name	Type
nodes	BaseNode<Metadata>[]

Returns

Promise<Record<string, any>[]>

Defined in

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

---

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.

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>[]>

Implementation of

TransformComponent.transform

Defined in

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