Class: SummaryExtractor
Extract summary from a list of nodes.
Hierarchy
-
↳
SummaryExtractor
Constructors
constructor
• new SummaryExtractor(options?
): SummaryExtractor
Parameters
Name | Type |
---|---|
options? | SummaryExtractArgs |
Returns
Overrides
Defined in
packages/core/src/extractors/MetadataExtractors.ts:394
Properties
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
= true
Inherited from
Defined in
packages/core/src/extractors/types.ts:10
llm
• llm: LLM
<object
, object
>
LLM instance.
Defined in
packages/core/src/extractors/MetadataExtractors.ts:376
metadataMode
• metadataMode: MetadataMode
= MetadataMode.ALL
Inherited from
Defined in
packages/core/src/extractors/types.ts:12
nextSummary
• Private
nextSummary: boolean
Defined in
packages/core/src/extractors/MetadataExtractors.ts:392
numWorkers
• numWorkers: number
= 4
Inherited from
Defined in
packages/core/src/extractors/types.ts:15
prevSummary
• Private
prevSummary: boolean
Defined in
packages/core/src/extractors/MetadataExtractors.ts:391
promptTemplate
• promptTemplate: string
The prompt template to use for the summary extractor.
Defined in
packages/core/src/extractors/MetadataExtractors.ts:388
selfSummary
• Private
selfSummary: boolean
Defined in
packages/core/src/extractors/MetadataExtractors.ts:390
showProgress
• showProgress: boolean
= true
Inherited from
Defined in
packages/core/src/extractors/types.ts:11
summaries
• summaries: string
[]
List of summaries to extract: 'self', 'prev', 'next'
Defined in
packages/core/src/extractors/MetadataExtractors.ts:382
Methods
extract
▸ extract(nodes
): Promise
<{}[] | ExtractSummary
[]>
Extract summaries from a list of nodes.
Parameters
Name | Type | Description |
---|---|---|
nodes | BaseNode <Metadata >[] | Nodes to extract summaries from. |
Returns
Promise
<{}[] | ExtractSummary
[]>
Summaries extracted from the nodes.
Overrides
Defined in
packages/core/src/extractors/MetadataExtractors.ts:443
generateNodeSummary
▸ generateNodeSummary(node
): Promise
<string
>
Extract summary from a node.
Parameters
Name | Type | Description |
---|---|---|
node | BaseNode <Metadata > | Node to extract summary from. |
Returns
Promise
<string
>
Summary extracted from the node.
Defined in
packages/core/src/extractors/MetadataExtractors.ts:420
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