SentenceWindowNodeParser
Defined in: packages/core/src/node-parser/sentence-window.ts:12
Extends
Section titled “Extends”SentenceWindowNodeParser<
Options>(nodes,options?):TextNode<Metadata>[]
Defined in: packages/core/src/node-parser/sentence-window.ts:12
Type Parameters
Section titled “Type Parameters”Options
Section titled “Options”Options extends Record<string, unknown>
Parameters
Section titled “Parameters”options?
Section titled “options?”Options
Returns
Section titled “Returns”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SentenceWindowNodeParser(
params?):SentenceWindowNodeParser
Defined in: packages/core/src/node-parser/sentence-window.ts:23
Parameters
Section titled “Parameters”params?
Section titled “params?”Partial<SentenceWindowNodeParserParams>
Returns
Section titled “Returns”SentenceWindowNodeParser
Overrides
Section titled “Overrides”Properties
Section titled “Properties”includeMetadata
Section titled “includeMetadata”includeMetadata:
boolean=true
Defined in: packages/core/src/node-parser/base.ts:17
Inherited from
Section titled “Inherited from”includePrevNextRel
Section titled “includePrevNextRel”includePrevNextRel:
boolean=true
Defined in: packages/core/src/node-parser/base.ts:18
Inherited from
Section titled “Inherited from”DEFAULT_WINDOW_SIZE
Section titled “DEFAULT_WINDOW_SIZE”
staticDEFAULT_WINDOW_SIZE:number=3
Defined in: packages/core/src/node-parser/sentence-window.ts:13
DEFAULT_WINDOW_METADATA_KEY
Section titled “DEFAULT_WINDOW_METADATA_KEY”
staticDEFAULT_WINDOW_METADATA_KEY:string="window"
Defined in: packages/core/src/node-parser/sentence-window.ts:14
DEFAULT_ORIGINAL_TEXT_METADATA_KEY
Section titled “DEFAULT_ORIGINAL_TEXT_METADATA_KEY”
staticDEFAULT_ORIGINAL_TEXT_METADATA_KEY:string="originalText"
Defined in: packages/core/src/node-parser/sentence-window.ts:15
windowSize
Section titled “windowSize”windowSize:
number
Defined in: packages/core/src/node-parser/sentence-window.ts:17
windowMetadataKey
Section titled “windowMetadataKey”windowMetadataKey:
string
Defined in: packages/core/src/node-parser/sentence-window.ts:18
originalTextMetadataKey
Section titled “originalTextMetadataKey”originalTextMetadataKey:
string
Defined in: packages/core/src/node-parser/sentence-window.ts:19
sentenceSplitter
Section titled “sentenceSplitter”sentenceSplitter:
TextSplitterFn
Defined in: packages/core/src/node-parser/sentence-window.ts:20
idGenerator()
Section titled “idGenerator()”idGenerator: () =>
string
Defined in: packages/core/src/node-parser/sentence-window.ts:21
Returns
Section titled “Returns”string
id:
string
Defined in: packages/core/src/schema/type.ts:22
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”postProcessParsedNodes()
Section titled “postProcessParsedNodes()”
protectedpostProcessParsedNodes(nodes,parentDocMap):TextNode<Metadata>[]
Defined in: packages/core/src/node-parser/base.ts:27
Parameters
Section titled “Parameters”parentDocMap
Section titled “parentDocMap”Map<string, TextNode<Metadata>>
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”NodeParser.postProcessParsedNodes
getNodesFromDocuments()
Section titled “getNodesFromDocuments()”Defined in: packages/core/src/node-parser/base.ts:84
Parameters
Section titled “Parameters”documents
Section titled “documents”Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”NodeParser.getNodesFromDocuments
parseNodes()
Section titled “parseNodes()”Defined in: packages/core/src/node-parser/sentence-window.ts:31
Parameters
Section titled “Parameters”showProgress?
Section titled “showProgress?”boolean
Returns
Section titled “Returns”Overrides
Section titled “Overrides”buildWindowNodesFromDocuments()
Section titled “buildWindowNodesFromDocuments()”buildWindowNodesFromDocuments(
documents):TextNode<Metadata>[]
Defined in: packages/core/src/node-parser/sentence-window.ts:38