SentenceWindowNodeParser

Defined in: packages/core/src/node-parser/sentence-window.ts:13

Extends

• NodeParser<TextNode[]>

SentenceWindowNodeParser<Options>(nodes, options?): TextNode<Metadata>[]

Defined in: packages/core/src/node-parser/sentence-window.ts:13

Type Parameters

Options

Options extends Record<string, unknown>

Parameters

nodes

BaseNode<Metadata>[]

options?

Options

Returns

TextNode<Metadata>[]

Constructors

Constructor

new SentenceWindowNodeParser(params?): SentenceWindowNodeParser

Defined in: packages/core/src/node-parser/sentence-window.ts:24

Parameters

params?

PartialWithUndefined<{ windowSize: number; windowMetadataKey: string; originalTextMetadataKey: string; }>

Returns

SentenceWindowNodeParser

Overrides

NodeParser.constructor

Properties

includeMetadata

includeMetadata: boolean = true

Defined in: packages/core/src/node-parser/base.ts:17

Inherited from

NodeParser.includeMetadata

---

includePrevNextRel

includePrevNextRel: boolean = true

Defined in: packages/core/src/node-parser/base.ts:18

Inherited from

NodeParser.includePrevNextRel

---

DEFAULT_WINDOW_SIZE

static DEFAULT_WINDOW_SIZE: number = 3

Defined in: packages/core/src/node-parser/sentence-window.ts:14

---

DEFAULT_WINDOW_METADATA_KEY

static DEFAULT_WINDOW_METADATA_KEY: string = "window"

Defined in: packages/core/src/node-parser/sentence-window.ts:15

---

DEFAULT_ORIGINAL_TEXT_METADATA_KEY

static DEFAULT_ORIGINAL_TEXT_METADATA_KEY: string = "originalText"

Defined in: packages/core/src/node-parser/sentence-window.ts:16

---

windowSize

windowSize: number

Defined in: packages/core/src/node-parser/sentence-window.ts:18

---

windowMetadataKey

windowMetadataKey: string

Defined in: packages/core/src/node-parser/sentence-window.ts:19

---

originalTextMetadataKey

originalTextMetadataKey: string

Defined in: packages/core/src/node-parser/sentence-window.ts:20

---

sentenceSplitter

sentenceSplitter: TextSplitterFn

Defined in: packages/core/src/node-parser/sentence-window.ts:21

---

idGenerator()

idGenerator: () => string

Defined in: packages/core/src/node-parser/sentence-window.ts:22

Returns

string

---

id

id: string

Defined in: packages/core/src/schema/type.ts:22

Inherited from

NodeParser.id

Methods

postProcessParsedNodes()

protected postProcessParsedNodes(nodes, parentDocMap): TextNode<Metadata>[]

Defined in: packages/core/src/node-parser/base.ts:27

Parameters

nodes

TextNode<Metadata>[]

parentDocMap

Map<string, TextNode<Metadata>>

Returns

TextNode<Metadata>[]

Inherited from

NodeParser.postProcessParsedNodes

---

getNodesFromDocuments()

getNodesFromDocuments(documents): TextNode<Metadata>[]

Defined in: packages/core/src/node-parser/base.ts:84

Parameters

documents

TextNode<Metadata>[]

Returns

TextNode<Metadata>[]

Inherited from

NodeParser.getNodesFromDocuments

---

parseNodes()

parseNodes(nodes, showProgress?): TextNode<Metadata>[]

Defined in: packages/core/src/node-parser/sentence-window.ts:40

Parameters

nodes

TextNode<Metadata>[]

showProgress?

boolean

Returns

TextNode<Metadata>[]

Overrides

NodeParser.parseNodes

---

buildWindowNodesFromDocuments()

buildWindowNodesFromDocuments(documents): TextNode<Metadata>[]

Defined in: packages/core/src/node-parser/sentence-window.ts:47

Parameters

documents

Document<Metadata>[]

Returns

TextNode<Metadata>[]