Skip to main content

Class: abstract BaseExtractor()

Extends

Extended by

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

Type Parameters

Options extends Record<string, unknown>

Parameters

nodes: BaseNode<Metadata>[]

options?: Options

Returns

Promise<BaseNode<Metadata>[]>

Defined in

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

Constructors

new BaseExtractor()

new BaseExtractor(): BaseExtractor

Returns

BaseExtractor

Overrides

TransformComponent.constructor

Defined in

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

Properties

disableTemplateRewrite

disableTemplateRewrite: boolean = false

Defined in

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


id

id: string

Inherited from

TransformComponent.id

Defined in

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


inPlace

inPlace: boolean = true

Defined in

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


isTextNodeOnly

isTextNodeOnly: boolean = true

Defined in

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


metadataMode

metadataMode: MetadataMode = MetadataMode.ALL

Defined in

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


numWorkers

numWorkers: number = 4

Defined in

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


showProgress

showProgress: boolean = true

Defined in

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

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:30


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:39