Class: TextNode<T>
TextNode is the default node type for text. Most common node type in LlamaIndex.TS
Extends
BaseNode
<T
>
Extended by
Type parameters
• T extends Metadata
= Metadata
Constructors
new TextNode()
new TextNode<
T
>(init
):TextNode
<T
>
Parameters
• init: TextNodeParams
<T
>= {}
Returns
TextNode
<T
>
Overrides
Source
packages/llamaindex/src/Node.ts:219
Properties
embedding?
optional
embedding:number
[]
Inherited from
Source
packages/llamaindex/src/Node.ts:61
endCharIdx?
optional
endCharIdx:number
Source
packages/llamaindex/src/Node.ts:214
excludedEmbedMetadataKeys
excludedEmbedMetadataKeys:
string
[]
Inherited from
BaseNode
. excludedEmbedMetadataKeys
Source
packages/llamaindex/src/Node.ts:65
excludedLlmMetadataKeys
excludedLlmMetadataKeys:
string
[]
Inherited from
BaseNode
. excludedLlmMetadataKeys
Source
packages/llamaindex/src/Node.ts:66
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
Source
packages/llamaindex/src/Node.ts:60
metadata
metadata:
T
Inherited from
Source
packages/llamaindex/src/Node.ts:64
metadataSeparator
metadataSeparator:
string
Source
packages/llamaindex/src/Node.ts:217
relationships
relationships:
Partial
<Record
<NodeRelationship
,RelatedNodeType
<T
>>>
Inherited from
Source
packages/llamaindex/src/Node.ts:67
startCharIdx?
optional
startCharIdx:number
Source
packages/llamaindex/src/Node.ts:213
text
text:
string
Source
packages/llamaindex/src/Node.ts:210
textTemplate
textTemplate:
string
Source
packages/llamaindex/src/Node.ts:211
Accessors
childNodes
get
childNodes():undefined
|RelatedNodeInfo
<T
>[]
Returns
undefined
| RelatedNodeInfo
<T
>[]
Source
packages/llamaindex/src/Node.ts:139
hash
nextNode
get
nextNode():undefined
|RelatedNodeInfo
<T
>
Returns
undefined
| RelatedNodeInfo
<T
>
Source
packages/llamaindex/src/Node.ts:119
parentNode
get
parentNode():undefined
|RelatedNodeInfo
<T
>
Returns
undefined
| RelatedNodeInfo
<T
>
Source
packages/llamaindex/src/Node.ts:129
prevNode
get
prevNode():undefined
|RelatedNodeInfo
<T
>
Returns
undefined
| RelatedNodeInfo
<T
>
Source
packages/llamaindex/src/Node.ts:107
sourceNode
get
sourceNode():undefined
|RelatedNodeInfo
<T
>
Returns
undefined
| RelatedNodeInfo
<T
>
Source
packages/llamaindex/src/Node.ts:97
type
get
type():ObjectType
Returns
Source
packages/llamaindex/src/Node.ts:247
Methods
asRelatedNodeInfo()
asRelatedNodeInfo():
RelatedNodeInfo
<T
>
Returns
Inherited from
Source
packages/llamaindex/src/Node.ts:161
clone()
Returns
Inherited from
Source
packages/llamaindex/src/Node.ts:183
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
Source
packages/llamaindex/src/Node.ts:237
getContent()
getContent(
metadataMode
):string
Parameters
• metadataMode: MetadataMode
= MetadataMode.NONE
Returns
string
Overrides
Source
packages/llamaindex/src/Node.ts:252
getEmbedding()
getEmbedding():
number
[]
Returns
number
[]
Inherited from
Source
packages/llamaindex/src/Node.ts:153
getMetadataStr()
getMetadataStr(
metadataMode
):string
Parameters
• metadataMode: MetadataMode
Returns
string
Overrides
Source
packages/llamaindex/src/Node.ts:257
getNodeInfo()
getNodeInfo():
object
Returns
object
end
end:
undefined
|number
start
start:
undefined
|number
Source
packages/llamaindex/src/Node.ts:283
getText()
getText():
string
Returns
string
Source
packages/llamaindex/src/Node.ts:287
setContent()
setContent(
value
):void
Parameters
• value: string
Returns
void
Overrides
Source
packages/llamaindex/src/Node.ts:278
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
>
Inherited from
See
toMutableJSON - use to return a mutable JSON instead
Source
packages/llamaindex/src/Node.ts:174
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.