MetadataAwareTextSplitter

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

Extends

• TextSplitter

Extended by

• SentenceSplitter
• TokenTextSplitter

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

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

Type Parameters

Options

Options extends Record<string, unknown>

Parameters

nodes

BaseNode<Metadata>[]

options?

Options

Returns

TextNode<Metadata>[]

Constructors

Constructor

new MetadataAwareTextSplitter(): MetadataAwareTextSplitter

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

Returns

MetadataAwareTextSplitter

Inherited from

TextSplitter.constructor

Properties

includeMetadata

includeMetadata: boolean = true

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

Inherited from

TextSplitter.includeMetadata

---

includePrevNextRel

includePrevNextRel: boolean = true

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

Inherited from

TextSplitter.includePrevNextRel

---

id

id: string

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

Inherited from

TextSplitter.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

TextSplitter.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

TextSplitter.getNodesFromDocuments

---

splitText()

abstract splitText(text): string[]

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

Parameters

text

string

Returns

string[]

Inherited from

TextSplitter.splitText

---

splitTexts()

splitTexts(texts): string[]

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

Parameters

texts

string[]

Returns

string[]

Inherited from

TextSplitter.splitTexts

---

splitTextMetadataAware()

abstract splitTextMetadataAware(text, metadata): string[]

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

Parameters

text

string

metadata

string

Returns

string[]

---

splitTextsMetadataAware()

splitTextsMetadataAware(texts, metadata): string[]

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

Parameters

texts

string[]

metadata

string[]

Returns

string[]

---

getMetadataString()

protected getMetadataString(node): string

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

Parameters

node

TextNode

Returns

string

---

parseNodes()

protected parseNodes(nodes): TextNode<Metadata>[]

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

Parameters

nodes

TextNode<Metadata>[]

Returns

TextNode<Metadata>[]

Overrides

TextSplitter.parseNodes