BaseExtractor
Defined in: .build/typescript/packages/llamaindex/src/extractors/types.ts:12
Extends
Section titled “Extends”TransformComponent
Extended by
Section titled “Extended by”
abstractBaseExtractor<Options>(nodes,options?):BaseNode<Metadata>[] |Promise<BaseNode<Metadata>[]>
Defined in: .build/typescript/packages/llamaindex/src/extractors/types.ts:12
Type Parameters
Section titled “Type Parameters”Options
Section titled “Options”Options extends Record<string, unknown>
Parameters
Section titled “Parameters”BaseNode<Metadata>[]
options?
Section titled “options?”Options
Returns
Section titled “Returns”BaseNode<Metadata>[] | Promise<BaseNode<Metadata>[]>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BaseExtractor():
BaseExtractor
Defined in: .build/typescript/packages/llamaindex/src/extractors/types.ts:20
Returns
Section titled “Returns”BaseExtractor
Overrides
Section titled “Overrides”TransformComponent.constructor
Properties
Section titled “Properties”isTextNodeOnly
Section titled “isTextNodeOnly”isTextNodeOnly:
boolean=true
Defined in: .build/typescript/packages/llamaindex/src/extractors/types.ts:13
showProgress
Section titled “showProgress”showProgress:
boolean=true
Defined in: .build/typescript/packages/llamaindex/src/extractors/types.ts:14
metadataMode
Section titled “metadataMode”metadataMode:
MetadataMode=MetadataMode.ALL
Defined in: .build/typescript/packages/llamaindex/src/extractors/types.ts:15
disableTemplateRewrite
Section titled “disableTemplateRewrite”disableTemplateRewrite:
boolean=false
Defined in: .build/typescript/packages/llamaindex/src/extractors/types.ts:16
inPlace
Section titled “inPlace”inPlace:
boolean=true
Defined in: .build/typescript/packages/llamaindex/src/extractors/types.ts:17
numWorkers
Section titled “numWorkers”numWorkers:
number=4
Defined in: .build/typescript/packages/llamaindex/src/extractors/types.ts:18
Methods
Section titled “Methods”extract()
Section titled “extract()”
abstractextract(nodes):Promise<Record<string,any>[]>
Defined in: .build/typescript/packages/llamaindex/src/extractors/types.ts:32
Parameters
Section titled “Parameters”BaseNode<Metadata>[]
Returns
Section titled “Returns”Promise<Record<string, any>[]>
processNodes()
Section titled “processNodes()”processNodes(
nodes,excludedEmbedMetadataKeys,excludedLlmMetadataKeys):Promise<BaseNode<Metadata>[]>
Defined in: .build/typescript/packages/llamaindex/src/extractors/types.ts:41
Parameters
Section titled “Parameters”BaseNode<Metadata>[]
Nodes to extract metadata from.
excludedEmbedMetadataKeys
Section titled “excludedEmbedMetadataKeys”Metadata keys to exclude from the embedding.
undefined | string[]
excludedLlmMetadataKeys
Section titled “excludedLlmMetadataKeys”Metadata keys to exclude from the LLM.
undefined | string[]
Returns
Section titled “Returns”Promise<BaseNode<Metadata>[]>
Metadata extracted from the nodes.