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