NodeParser

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

Extends

• TransformComponent<Result>

Extended by

• TextSplitter
• MarkdownNodeParser
• SentenceWindowNodeParser

Type Parameters

Result

Result extends TextNode[] | Promise<TextNode[]> = TextNode[] | Promise<TextNode[]>

abstract NodeParser<Options>(nodes, options?): Result

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

Type Parameters

Options

Options extends Record<string, unknown>

Parameters

nodes

BaseNode<Metadata>[]

options?

Options

Returns

Result

Constructors

Constructor

new NodeParser<Result>(): NodeParser<Result>

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

Returns

NodeParser<Result>

Overrides

TransformComponent.constructor

Properties

includeMetadata

includeMetadata: boolean = true

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

---

includePrevNextRel

includePrevNextRel: boolean = true

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

---

id

id: string

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

Inherited from

TransformComponent.id

Methods

postProcessParsedNodes()

protected postProcessParsedNodes(nodes, parentDocMap): Awaited<Result>

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

Parameters

nodes

Awaited<Result>

parentDocMap

Map<string, TextNode<Metadata>>

Returns

Awaited<Result>

---

parseNodes()

abstract protected parseNodes(documents, showProgress?): Result

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

Parameters

documents

TextNode<Metadata>[]

showProgress?

boolean

Returns

Result

---

getNodesFromDocuments()

getNodesFromDocuments(documents): Result

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

Parameters

documents

TextNode<Metadata>[]

Returns

Result