Class: SentenceWindowNodeParser

A NodeParser generates Nodes from Documents

Implements

• NodeParser

Constructors

new SentenceWindowNodeParser()

new SentenceWindowNodeParser(init?): SentenceWindowNodeParser

Parameters

• init?: Partial <SentenceWindowNodeParser>

Returns

SentenceWindowNodeParser

Source

packages/core/src/nodeParsers/SentenceWindowNodeParser.ts:36

Properties

includeMetadata

includeMetadata: boolean = true

Whether to include metadata in the nodes.

Source

packages/core/src/nodeParsers/SentenceWindowNodeParser.ts:30

---

includePrevNextRel

includePrevNextRel: boolean = true

Whether to include previous and next relationships in the nodes.

Source

packages/core/src/nodeParsers/SentenceWindowNodeParser.ts:34

---

originalTextMetadataKey

originalTextMetadataKey: string = DEFAULT_OG_TEXT_METADATA_KEY

The metadata key to store the original sentence in.

Source

packages/core/src/nodeParsers/SentenceWindowNodeParser.ts:26

---

textSplitter

textSplitter: SentenceSplitter

The text splitter to use.

Source

packages/core/src/nodeParsers/SentenceWindowNodeParser.ts:14

---

windowMetadataKey

windowMetadataKey: string = DEFAULT_WINDOW_METADATA_KEY

The metadata key to store the sentence window under.

Source

packages/core/src/nodeParsers/SentenceWindowNodeParser.ts:22

---

windowSize

windowSize: number = DEFAULT_WINDOW_SIZE

The number of sentences on each side of a sentence to capture.

Source

packages/core/src/nodeParsers/SentenceWindowNodeParser.ts:18

Methods

buildWindowNodesFromDocument()

protected buildWindowNodesFromDocument(doc): BaseNode <Metadata>[]

Parameters

• doc: BaseNode <Metadata>

Returns

BaseNode <Metadata>[]

Source

packages/core/src/nodeParsers/SentenceWindowNodeParser.ts:57

---

getNodesFromDocuments()

getNodesFromDocuments(documents): BaseNode <Metadata>[]

Generates an array of nodes from an array of documents.

Parameters

• documents: BaseNode <Metadata>[]

The documents to generate nodes from.

Returns

BaseNode <Metadata>[]

An array of nodes.

Implementation of

NodeParser . getNodesFromDocuments

Source

packages/core/src/nodeParsers/SentenceWindowNodeParser.ts:51

---

transform()

transform(nodes, _options?): Promise <BaseNode <Metadata>[]>

Parameters

• nodes: BaseNode <Metadata>[]

• _options?: any

Returns

Promise <BaseNode <Metadata>[]>

Implementation of

NodeParser . transform

Source

packages/core/src/nodeParsers/SentenceWindowNodeParser.ts:47

---

fromDefaults()

static fromDefaults(init?): SentenceWindowNodeParser

Parameters

• init?: Partial <SentenceWindowNodeParser>

Returns

SentenceWindowNodeParser

Source

packages/core/src/nodeParsers/SentenceWindowNodeParser.ts:41