LlamaIndexTS/apps/docs/docs/api/classes/SimpleNodeParser.md

id, title, sidebar_label, sidebar_position, custom_edit_url

id	title	sidebar_label	sidebar_position	custom_edit_url
SimpleNodeParser	Class: SimpleNodeParser	SimpleNodeParser	0	null

SimpleNodeParser is the default NodeParser. It splits documents into TextNodes using a splitter, by default SentenceSplitter

Implements

• NodeParser

Constructors

constructor

• new SimpleNodeParser(init?)

Parameters

Name	Type
init?	Object
init.chunkOverlap?	number
init.chunkSize?	number
init.includeMetadata?	boolean
init.includePrevNextRel?	boolean
init.textSplitter?	SentenceSplitter

Defined in

NodeParser.ts:93

Properties

includeMetadata

• includeMetadata: boolean

Whether to include metadata in the nodes.

Defined in

NodeParser.ts:87

---

includePrevNextRel

• includePrevNextRel: boolean

Whether to include previous and next relationships in the nodes.

Defined in

NodeParser.ts:91

---

textSplitter

• textSplitter: SentenceSplitter

The text splitter to use.

Defined in

NodeParser.ts:83

Methods

getNodesFromDocuments

▸ getNodesFromDocuments(documents): TextNode[]

Generate Node objects from documents

Parameters

Name	Type
documents	Document[]

Returns

TextNode[]

Implementation of

NodeParser.getNodesFromDocuments

Defined in

NodeParser.ts:124

---

fromDefaults

▸ Static fromDefaults(init?): SimpleNodeParser

Parameters

Name	Type
init?	Object
init.chunkOverlap?	number
init.chunkSize?	number
init.includeMetadata?	boolean
init.includePrevNextRel?	boolean

Returns

SimpleNodeParser

Defined in

NodeParser.ts:111