IndexNode
Defined in: .build/typescript/packages/core/src/schema/node.ts:307
TextNode is the default node type for text. Most common node type in LlamaIndex.TS
Extends
Section titled “Extends”TextNode<T>
Type Parameters
Section titled “Type Parameters”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new IndexNode<
T>(init?):IndexNode<T>
Defined in: .build/typescript/packages/core/src/schema/node.ts:310
Parameters
Section titled “Parameters”Returns
Section titled “Returns”IndexNode<T>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”id_:
string
Defined in: .build/typescript/packages/core/src/schema/node.ts:64
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
Section titled “Inherited from”embedding
Section titled “embedding”embedding:
undefined|number[]
Defined in: .build/typescript/packages/core/src/schema/node.ts:65
Inherited from
Section titled “Inherited from”metadata
Section titled “metadata”metadata:
T
Defined in: .build/typescript/packages/core/src/schema/node.ts:68
Inherited from
Section titled “Inherited from”excludedEmbedMetadataKeys
Section titled “excludedEmbedMetadataKeys”excludedEmbedMetadataKeys:
string[]
Defined in: .build/typescript/packages/core/src/schema/node.ts:69
Inherited from
Section titled “Inherited from”TextNode.excludedEmbedMetadataKeys
excludedLlmMetadataKeys
Section titled “excludedLlmMetadataKeys”excludedLlmMetadataKeys:
string[]
Defined in: .build/typescript/packages/core/src/schema/node.ts:70
Inherited from
Section titled “Inherited from”TextNode.excludedLlmMetadataKeys
relationships
Section titled “relationships”relationships:
Partial<Record<NodeRelationship,RelatedNodeType<T>>>
Defined in: .build/typescript/packages/core/src/schema/node.ts:71
Inherited from
Section titled “Inherited from”text:
string
Defined in: .build/typescript/packages/core/src/schema/node.ts:218
Inherited from
Section titled “Inherited from”textTemplate
Section titled “textTemplate”textTemplate:
string
Defined in: .build/typescript/packages/core/src/schema/node.ts:219
Inherited from
Section titled “Inherited from”startCharIdx?
Section titled “startCharIdx?”
optionalstartCharIdx:number
Defined in: .build/typescript/packages/core/src/schema/node.ts:221
Inherited from
Section titled “Inherited from”endCharIdx?
Section titled “endCharIdx?”
optionalendCharIdx:number
Defined in: .build/typescript/packages/core/src/schema/node.ts:222
Inherited from
Section titled “Inherited from”metadataSeparator
Section titled “metadataSeparator”metadataSeparator:
string
Defined in: .build/typescript/packages/core/src/schema/node.ts:225
Inherited from
Section titled “Inherited from”indexId
Section titled “indexId”indexId:
string
Defined in: .build/typescript/packages/core/src/schema/node.ts:308
Accessors
Section titled “Accessors”Defined in: .build/typescript/packages/core/src/schema/node.ts:74
Inherited from
Section titled “Inherited from”sourceNode
Section titled “sourceNode”Get Signature
Section titled “Get Signature”get sourceNode():
undefined|RelatedNodeInfo<T>
Defined in: .build/typescript/packages/core/src/schema/node.ts:103
Returns
Section titled “Returns”undefined | RelatedNodeInfo<T>
Inherited from
Section titled “Inherited from”prevNode
Section titled “prevNode”Get Signature
Section titled “Get Signature”get prevNode():
undefined|RelatedNodeInfo<T>
Defined in: .build/typescript/packages/core/src/schema/node.ts:113
Returns
Section titled “Returns”undefined | RelatedNodeInfo<T>
Inherited from
Section titled “Inherited from”nextNode
Section titled “nextNode”Get Signature
Section titled “Get Signature”get nextNode():
undefined|RelatedNodeInfo<T>
Defined in: .build/typescript/packages/core/src/schema/node.ts:125
Returns
Section titled “Returns”undefined | RelatedNodeInfo<T>
Inherited from
Section titled “Inherited from”parentNode
Section titled “parentNode”Get Signature
Section titled “Get Signature”get parentNode():
undefined|RelatedNodeInfo<T>
Defined in: .build/typescript/packages/core/src/schema/node.ts:135
Returns
Section titled “Returns”undefined | RelatedNodeInfo<T>
Inherited from
Section titled “Inherited from”childNodes
Section titled “childNodes”Get Signature
Section titled “Get Signature”get childNodes():
undefined|RelatedNodeInfo<T>[]
Defined in: .build/typescript/packages/core/src/schema/node.ts:145
Returns
Section titled “Returns”undefined | RelatedNodeInfo<T>[]
Inherited from
Section titled “Inherited from”Get Signature
Section titled “Get Signature”get type():
ObjectType
Defined in: .build/typescript/packages/core/src/schema/node.ts:316
Returns
Section titled “Returns”Overrides
Section titled “Overrides”Methods
Section titled “Methods”getEmbedding()
Section titled “getEmbedding()”getEmbedding():
number[]
Defined in: .build/typescript/packages/core/src/schema/node.ts:159
Returns
Section titled “Returns”number[]
Inherited from
Section titled “Inherited from”asRelatedNodeInfo()
Section titled “asRelatedNodeInfo()”asRelatedNodeInfo():
RelatedNodeInfo<T>
Defined in: .build/typescript/packages/core/src/schema/node.ts:167
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”toJSON()
Section titled “toJSON()”toJSON():
Record<string,any>
Defined in: .build/typescript/packages/core/src/schema/node.ts:181
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
Section titled “Returns”Record<string, any>
toMutableJSON - use to return a mutable JSON instead
Inherited from
Section titled “Inherited from”clone()
Section titled “clone()”clone():
BaseNode
Defined in: .build/typescript/packages/core/src/schema/node.ts:190
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”toMutableJSON()
Section titled “toMutableJSON()”toMutableJSON():
Record<string,any>
Defined in: .build/typescript/packages/core/src/schema/node.ts:200
Converts the object to a JSON representation. Properties can be safely modified as a deep clone of the properties are created.
Returns
Section titled “Returns”Record<string, any>
- The JSON representation of the object.
Inherited from
Section titled “Inherited from”generateHash()
Section titled “generateHash()”generateHash():
string
Defined in: .build/typescript/packages/core/src/schema/node.ts:247
Generate a hash of the text node. The ID is not part of the hash as it can change independent of content.
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”getContent()
Section titled “getContent()”getContent(
metadataMode):string
Defined in: .build/typescript/packages/core/src/schema/node.ts:262
Parameters
Section titled “Parameters”metadataMode
Section titled “metadataMode”MetadataMode = MetadataMode.NONE
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”getMetadataStr()
Section titled “getMetadataStr()”getMetadataStr(
metadataMode):string
Defined in: .build/typescript/packages/core/src/schema/node.ts:267
Parameters
Section titled “Parameters”metadataMode
Section titled “metadataMode”Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”setContent()
Section titled “setContent()”setContent(
value):void
Defined in: .build/typescript/packages/core/src/schema/node.ts:288
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”getNodeInfo()
Section titled “getNodeInfo()”getNodeInfo():
object
Defined in: .build/typescript/packages/core/src/schema/node.ts:293
Returns
Section titled “Returns”object
start:
undefined|number
end:
undefined|number
Inherited from
Section titled “Inherited from”getText()
Section titled “getText()”getText():
string
Defined in: .build/typescript/packages/core/src/schema/node.ts:297
Returns
Section titled “Returns”string