メインコンテンツまでスキップ

Class: TextNode<T>

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

Type parameters

NameType
Textends Metadata = Metadata

Hierarchy

Constructors

constructor

new TextNode<T>(init?)

Type parameters

NameType
Textends Metadata = Metadata

Parameters

NameType
init?Partial<TextNode<T>>

Overrides

BaseNode.constructor

Defined in

packages/core/src/Node.ts:177

Properties

embedding

Optional embedding: number[]

Inherited from

BaseNode.embedding

Defined in

packages/core/src/Node.ts:52


endCharIdx

Optional endCharIdx: number

Defined in

packages/core/src/Node.ts:172


excludedEmbedMetadataKeys

excludedEmbedMetadataKeys: string[] = []

Inherited from

BaseNode.excludedEmbedMetadataKeys

Defined in

packages/core/src/Node.ts:56


excludedLlmMetadataKeys

excludedLlmMetadataKeys: string[] = []

Inherited from

BaseNode.excludedLlmMetadataKeys

Defined in

packages/core/src/Node.ts:57


hash

hash: string = ""

Inherited from

BaseNode.hash

Defined in

packages/core/src/Node.ts:59


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:51


metadata

metadata: T

Inherited from

BaseNode.metadata

Defined in

packages/core/src/Node.ts:55


metadataSeparator

metadataSeparator: string = "\n"

Defined in

packages/core/src/Node.ts:175


relationships

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

Inherited from

BaseNode.relationships

Defined in

packages/core/src/Node.ts:58


startCharIdx

Optional startCharIdx: number

Defined in

packages/core/src/Node.ts:171


text

text: string = ""

Defined in

packages/core/src/Node.ts:170

Accessors

childNodes

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

Returns

undefined | RelatedNodeInfo<T>[]

Inherited from

BaseNode.childNodes

Defined in

packages/core/src/Node.ts:113


nextNode

get nextNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Inherited from

BaseNode.nextNode

Defined in

packages/core/src/Node.ts:93


parentNode

get parentNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Inherited from

BaseNode.parentNode

Defined in

packages/core/src/Node.ts:103


prevNode

get prevNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Inherited from

BaseNode.prevNode

Defined in

packages/core/src/Node.ts:81


sourceNode

get sourceNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Inherited from

BaseNode.sourceNode

Defined in

packages/core/src/Node.ts:71

Methods

asRelatedNodeInfo

asRelatedNodeInfo(): RelatedNodeInfo<T>

Returns

RelatedNodeInfo<T>

Inherited from

BaseNode.asRelatedNodeInfo

Defined in

packages/core/src/Node.ts:135


clone

clone(): BaseNode<Metadata>

Returns

BaseNode<Metadata>

Inherited from

BaseNode.clone

Defined in

packages/core/src/Node.ts:152


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:193


getContent

getContent(metadataMode?): string

Parameters

NameTypeDefault value
metadataModeMetadataModeMetadataMode.NONE

Returns

string

Overrides

BaseNode.getContent

Defined in

packages/core/src/Node.ts:207


getEmbedding

getEmbedding(): number[]

Returns

number[]

Inherited from

BaseNode.getEmbedding

Defined in

packages/core/src/Node.ts:127


getMetadataStr

getMetadataStr(metadataMode): string

Parameters

NameType
metadataModeMetadataMode

Returns

string

Overrides

BaseNode.getMetadataStr

Defined in

packages/core/src/Node.ts:212


getNodeInfo

getNodeInfo(): Object

Returns

Object

NameType
endundefined | number
startundefined | number

Defined in

packages/core/src/Node.ts:239


getText

getText(): string

Returns

string

Defined in

packages/core/src/Node.ts:243


getType

getType(): ObjectType

Returns

ObjectType

Overrides

BaseNode.getType

Defined in

packages/core/src/Node.ts:203


setContent

setContent(value): void

Parameters

NameType
valuestring

Returns

void

Overrides

BaseNode.setContent

Defined in

packages/core/src/Node.ts:233


toJSON

toJSON(): Record<string, any>

Called by built in JSON.stringify (see https://javascript.info/json) Properties are read-only as they are not deep-cloned (not necessary for stringification).

Returns

Record<string, any>

See

toMutableJSON - use to return a mutable JSON instead

Inherited from

BaseNode.toJSON

Defined in

packages/core/src/Node.ts:148


toMutableJSON

toMutableJSON(): Record<string, any>

Converts the object to a JSON representation. Properties can be safely modified as a deep clone of the properties are created.

Returns

Record<string, any>

  • The JSON representation of the object.

Inherited from

BaseNode.toMutableJSON

Defined in

packages/core/src/Node.ts:161