BaseNode
Defined in: .build/typescript/packages/core/src/schema/node.ts:57
Generic abstract class for retrievable nodes
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”
protectednew BaseNode<T>(init?):BaseNode<T>
Defined in: .build/typescript/packages/core/src/schema/node.ts:76
Parameters
Section titled “Parameters”Returns
Section titled “Returns”BaseNode<T>
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.
embedding
Section titled “embedding”embedding:
undefined|number[]
Defined in: .build/typescript/packages/core/src/schema/node.ts:65
metadata
Section titled “metadata”metadata:
T
Defined in: .build/typescript/packages/core/src/schema/node.ts:68
excludedEmbedMetadataKeys
Section titled “excludedEmbedMetadataKeys”excludedEmbedMetadataKeys:
string[]
Defined in: .build/typescript/packages/core/src/schema/node.ts:69
excludedLlmMetadataKeys
Section titled “excludedLlmMetadataKeys”excludedLlmMetadataKeys:
string[]
Defined in: .build/typescript/packages/core/src/schema/node.ts:70
relationships
Section titled “relationships”relationships:
Partial<Record<NodeRelationship,RelatedNodeType<T>>>
Defined in: .build/typescript/packages/core/src/schema/node.ts:71
Accessors
Section titled “Accessors”Defined in: .build/typescript/packages/core/src/schema/node.ts:74
Get Signature
Section titled “Get Signature”get
abstracttype():ObjectType
Defined in: .build/typescript/packages/core/src/schema/node.ts:94
Returns
Section titled “Returns”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>
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>
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>
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>
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>[]
Methods
Section titled “Methods”getContent()
Section titled “getContent()”
abstractgetContent(metadataMode):string
Defined in: .build/typescript/packages/core/src/schema/node.ts:96
Parameters
Section titled “Parameters”metadataMode
Section titled “metadataMode”Returns
Section titled “Returns”string
getMetadataStr()
Section titled “getMetadataStr()”
abstractgetMetadataStr(metadataMode):string
Defined in: .build/typescript/packages/core/src/schema/node.ts:98
Parameters
Section titled “Parameters”metadataMode
Section titled “metadataMode”Returns
Section titled “Returns”string
setContent()
Section titled “setContent()”
abstractsetContent(value):void
Defined in: .build/typescript/packages/core/src/schema/node.ts:101
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”void
generateHash()
Section titled “generateHash()”
abstractgenerateHash():string
Defined in: .build/typescript/packages/core/src/schema/node.ts:157
Returns
Section titled “Returns”string
getEmbedding()
Section titled “getEmbedding()”getEmbedding():
number[]
Defined in: .build/typescript/packages/core/src/schema/node.ts:159
Returns
Section titled “Returns”number[]
asRelatedNodeInfo()
Section titled “asRelatedNodeInfo()”asRelatedNodeInfo():
RelatedNodeInfo<T>
Defined in: .build/typescript/packages/core/src/schema/node.ts:167
Returns
Section titled “Returns”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
clone()
Section titled “clone()”clone():
BaseNode
Defined in: .build/typescript/packages/core/src/schema/node.ts:190
Returns
Section titled “Returns”BaseNode
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.