Skip to main content

Class: abstract BaseExtractor

Extended by

Implements

Constructors

new BaseExtractor()

new BaseExtractor(): BaseExtractor

Returns

BaseExtractor

Properties

disableTemplateRewrite

disableTemplateRewrite: boolean = false

Defined in

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


inPlace

inPlace: boolean = true

Defined in

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


isTextNodeOnly

isTextNodeOnly: boolean = true

Defined in

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


metadataMode

metadataMode: MetadataMode = MetadataMode.ALL

Defined in

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


numWorkers

numWorkers: number = 4

Defined in

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


showProgress

showProgress: boolean = true

Defined in

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

Methods

extract()

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

Parameters

nodes: BaseNode<Metadata>[]

Returns

Promise<Record<string, any>[]>

Defined in

packages/llamaindex/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.

Defined in

packages/llamaindex/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

Defined in

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