Class: BaseExtractor
Hierarchy
-
BaseExtractor
Implements
Constructors
constructor
• new BaseExtractor(): BaseExtractor
Returns
Properties
disableTemplateRewrite
• disableTemplateRewrite: boolean
= false
Defined in
packages/core/src/extractors/types.ts:13
inPlace
• inPlace: boolean
= true
Defined in
packages/core/src/extractors/types.ts:14
isTextNodeOnly
• isTextNodeOnly: boolean
= true
Defined in
packages/core/src/extractors/types.ts:10
metadataMode
• metadataMode: MetadataMode
= MetadataMode.ALL
Defined in
packages/core/src/extractors/types.ts:12
numWorkers
• numWorkers: number
= 4
Defined in
packages/core/src/extractors/types.ts:15
showProgress
• showProgress: boolean
= true
Defined in
packages/core/src/extractors/types.ts:11
Methods
extract
▸ extract(nodes
): Promise
<Record
<string
, any
>[]>
Parameters
Name | Type |
---|---|
nodes | BaseNode <Metadata >[] |
Returns
Promise
<Record
<string
, any
>[]>
Defined in
packages/core/src/extractors/types.ts:17
processNodes
▸ processNodes(nodes
, excludedEmbedMetadataKeys?
, excludedLlmMetadataKeys?
): Promise
<BaseNode
<Metadata
>[]>
Parameters
Name | Type | Default value | Description |
---|---|---|---|
nodes | BaseNode <Metadata >[] | undefined | 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
Metadata extracted from the nodes.
Defined in
packages/core/src/extractors/types.ts:34
transform
▸ transform(nodes
, options?
): Promise
<BaseNode
<Metadata
>[]>
Parameters
Name | Type |
---|---|
nodes | BaseNode <Metadata >[] |
options? | any |