Class: TextNode<T>

TextNode is the default node type for text. Most common node type in LlamaIndex.TS

Type parameters

Name	Type
T	extends Metadata = Metadata

Hierarchy

• BaseNode<T>

  ↳ TextNode

  ↳↳ IndexNode

  ↳↳ Document

Constructors

constructor

• new TextNode<T>(init?)

Type parameters

Name	Type
T	extends Metadata = Metadata

Parameters

Name	Type
init?	Partial<TextNode<T>>

Overrides

BaseNode.constructor

Defined in

packages/core/src/Node.ts:161

Properties

embedding

• Optional embedding: number[]

Inherited from

BaseNode.embedding

Defined in

packages/core/src/Node.ts:50

---

endCharIdx

• Optional endCharIdx: number

Defined in

packages/core/src/Node.ts:156

---

excludedEmbedMetadataKeys

• excludedEmbedMetadataKeys: string[] = []

Inherited from

BaseNode.excludedEmbedMetadataKeys

Defined in

packages/core/src/Node.ts:54

---

excludedLlmMetadataKeys

• excludedLlmMetadataKeys: string[] = []

Inherited from

BaseNode.excludedLlmMetadataKeys

Defined in

packages/core/src/Node.ts:55

---

hash

• hash: string = ""

Inherited from

BaseNode.hash

Defined in

packages/core/src/Node.ts:57

---

id_

• id_: string

The unique ID of the Node/Document. The trailing underscore is here to avoid collisions with the id keyword in Python.

Set to a UUID by default.

Inherited from

BaseNode.id_

Defined in

packages/core/src/Node.ts:49

---

metadata

• metadata: T

Inherited from

BaseNode.metadata

Defined in

packages/core/src/Node.ts:53

---

metadataSeparator

• metadataSeparator: string = "\n"

Defined in

packages/core/src/Node.ts:159

---

relationships

• relationships: Partial<Record<NodeRelationship, RelatedNodeType<T>>> = {}

Inherited from

BaseNode.relationships

Defined in

packages/core/src/Node.ts:56

---

startCharIdx

• Optional startCharIdx: number

Defined in

packages/core/src/Node.ts:155

---

text

• text: string = ""

Defined in

packages/core/src/Node.ts:154

Accessors

childNodes

• get childNodes(): undefined | RelatedNodeInfo<T>[]

Returns

undefined | RelatedNodeInfo<T>[]

Inherited from

BaseNode.childNodes

Defined in

packages/core/src/Node.ts:111

---

nextNode

• get nextNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Inherited from

BaseNode.nextNode

Defined in

packages/core/src/Node.ts:91

---

parentNode

• get parentNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Inherited from

BaseNode.parentNode

Defined in

packages/core/src/Node.ts:101

---

prevNode

• get prevNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Inherited from

BaseNode.prevNode

Defined in

packages/core/src/Node.ts:79

---

sourceNode

• get sourceNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Inherited from

BaseNode.sourceNode

Defined in

packages/core/src/Node.ts:69

Methods

asRelatedNodeInfo

▸ asRelatedNodeInfo(): RelatedNodeInfo<T>

Returns

RelatedNodeInfo<T>

Inherited from

BaseNode.asRelatedNodeInfo

Defined in

packages/core/src/Node.ts:133

---

generateHash

▸ generateHash(): string

Generate a hash of the text node. The ID is not part of the hash as it can change independent of content.

Returns

string

Overrides

BaseNode.generateHash

Defined in

packages/core/src/Node.ts:177

---

getContent

▸ getContent(metadataMode?): string

Parameters

Name	Type	Default value
metadataMode	MetadataMode	MetadataMode.NONE

Returns

string

Overrides

BaseNode.getContent

Defined in

packages/core/src/Node.ts:191

---

getEmbedding

▸ getEmbedding(): number[]

Returns

number[]

Inherited from

BaseNode.getEmbedding

Defined in

packages/core/src/Node.ts:125

---

getMetadataStr

▸ getMetadataStr(metadataMode): string

Parameters

Name	Type
metadataMode	MetadataMode

Returns

string

Overrides

BaseNode.getMetadataStr

Defined in

packages/core/src/Node.ts:196

---

getNodeInfo

▸ getNodeInfo(): Object

Returns

Object

Name	Type
end	undefined | number
start	undefined | number

Defined in

packages/core/src/Node.ts:223

---

getText

▸ getText(): string

Returns

string

Defined in

packages/core/src/Node.ts:227

---

getType

▸ getType(): ObjectType

Returns

ObjectType

Overrides

BaseNode.getType

Defined in

packages/core/src/Node.ts:187

---

setContent

▸ setContent(value): void

Parameters

Name	Type
value	string

Returns

void

Overrides

BaseNode.setContent

Defined in

packages/core/src/Node.ts:217

---

toJSON

▸ toJSON(): Record<string, any>

Used with built in JSON.stringify

Returns

Record<string, any>

Inherited from

BaseNode.toJSON

Defined in

packages/core/src/Node.ts:145