Class: TitleExtractor
Extract title from a list of nodes.
Hierarchy
-
↳
TitleExtractor
Constructors
constructor
• new TitleExtractor(options?
): TitleExtractor
Constructor for the TitleExtractor class.
Parameters
Name | Type |
---|---|
options? | TitleExtractorsArgs |
Returns
Overrides
Defined in
packages/core/src/extractors/MetadataExtractors.ts:147
Properties
combineTemplate
• combineTemplate: string
The prompt template to merge title with..
Defined in
packages/core/src/extractors/MetadataExtractors.ts:138
disableTemplateRewrite
• disableTemplateRewrite: boolean
= false
Inherited from
BaseExtractor.disableTemplateRewrite
Defined in
packages/core/src/extractors/types.ts:13
inPlace
• inPlace: boolean
= true
Inherited from
Defined in
packages/core/src/extractors/types.ts:14
isTextNodeOnly
• isTextNodeOnly: boolean
= false
Can work for mixture of text and non-text nodes
Default
false
Overrides
Defined in
packages/core/src/extractors/MetadataExtractors.ts:119
llm
• llm: LLM
<object
, object
>
LLM instance.
Defined in
packages/core/src/extractors/MetadataExtractors.ts:112
metadataMode
• metadataMode: MetadataMode
= MetadataMode.ALL
Inherited from
Defined in
packages/core/src/extractors/types.ts:12
nodeTemplate
• nodeTemplate: string
The prompt template to use for the title extractor.
Defined in
packages/core/src/extractors/MetadataExtractors.ts:132
nodes
• nodes: number
= 5
Number of nodes to extrct titles from.
Default
5
Defined in
packages/core/src/extractors/MetadataExtractors.ts:126
numWorkers
• numWorkers: number
= 4
Inherited from
Defined in
packages/core/src/extractors/types.ts:15
showProgress
• showProgress: boolean
= true
Inherited from
Defined in
packages/core/src/extractors/types.ts:11
Methods
extract
▸ extract(nodes
): Promise
<ExtractTitle
[]>
Extract titles from a list of nodes.
Parameters
Name | Type | Description |
---|---|---|
nodes | BaseNode <Metadata >[] | Nodes to extract titles from. |
Returns
Promise
<ExtractTitle
[]>
Titles extracted from the nodes.
Overrides
Defined in
packages/core/src/extractors/MetadataExtractors.ts:164
extractTitles
▸ extractTitles(nodesByDocument
): Promise
<Record
<string
, string
>>
Parameters
Name | Type |
---|---|
nodesByDocument | Record <string , BaseNode <Metadata >[]> |
Returns
Promise
<Record
<string
, string
>>
Defined in
packages/core/src/extractors/MetadataExtractors.ts:212
filterNodes
▸ filterNodes(nodes
): BaseNode
<Metadata
>[]
Parameters
Name | Type |
---|---|
nodes | BaseNode <Metadata >[] |
Returns
Defined in
packages/core/src/extractors/MetadataExtractors.ts:181
getTitlesCandidates
▸ getTitlesCandidates(nodes
): Promise
<string
[]>
Parameters
Name | Type |
---|---|
nodes | BaseNode <Metadata >[] |
Returns
Promise
<string
[]>
Defined in
packages/core/src/extractors/MetadataExtractors.ts:232
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.
Inherited from
Defined in
packages/core/src/extractors/types.ts:34
separateNodesByDocument
▸ separateNodesByDocument(nodes
): Record
<string
, BaseNode
<Metadata
>[]>
Parameters
Name | Type |
---|---|
nodes | BaseNode <Metadata >[] |
Returns
Record
<string
, BaseNode
<Metadata
>[]>
Defined in
packages/core/src/extractors/MetadataExtractors.ts:190
transform
▸ transform(nodes
, options?
): Promise
<BaseNode
<Metadata
>[]>
Parameters
Name | Type |
---|---|
nodes | BaseNode <Metadata >[] |
options? | any |