Class: abstract BaseExtractor

Extended by

• KeywordExtractor
• QuestionsAnsweredExtractor
• SummaryExtractor
• TitleExtractor

Implements

• TransformComponent

Constructors

new BaseExtractor()

new BaseExtractor(): BaseExtractor

Returns

BaseExtractor

Properties

disableTemplateRewrite

disableTemplateRewrite: boolean = false

Source

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

---

inPlace

inPlace: boolean = true

Source

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

---

isTextNodeOnly

isTextNodeOnly: boolean = true

Source

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

---

metadataMode

metadataMode: MetadataMode = MetadataMode.ALL

Source

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

---

numWorkers

numWorkers: number = 4

Source

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

---

showProgress

showProgress: boolean = true

Source

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

Methods

extract()

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

Parameters

• nodes: BaseNode <Metadata>[]

Returns

Promise<Record<string, any>[]>

Source

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

---

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.

Source

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

---

transform()

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

Parameters

• nodes: BaseNode <Metadata>[]

• options?: any

Returns

Promise <BaseNode <Metadata>[]>

Implementation of

TransformComponent . transform

Source

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