Class: abstract BaseNode<T>

Generic abstract class for retrievable nodes

Extended by

• TextNode

Type parameters

• T extends Metadata = Metadata

Constructors

new BaseNode()

new BaseNode<T>(init?): BaseNode<T>

Parameters

• init?: Partial <BaseNode<T>>

Returns

BaseNode<T>

Source

packages/core/src/Node.ts:60

Properties

embedding?

optional embedding: number[]

Source

packages/core/src/Node.ts:51

---

excludedEmbedMetadataKeys

excludedEmbedMetadataKeys: string[] = []

Source

packages/core/src/Node.ts:55

---

excludedLlmMetadataKeys

excludedLlmMetadataKeys: string[] = []

Source

packages/core/src/Node.ts:56

---

hash

hash: string = ""

Source

packages/core/src/Node.ts:58

---

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.

Source

packages/core/src/Node.ts:50

---

metadata

metadata: T

Source

packages/core/src/Node.ts:54

---

relationships

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

Source

packages/core/src/Node.ts:57

Accessors

childNodes

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

Returns

undefined | RelatedNodeInfo<T>[]

Source

packages/core/src/Node.ts:113

---

nextNode

get nextNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Source

packages/core/src/Node.ts:93

---

parentNode

get parentNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Source

packages/core/src/Node.ts:103

---

prevNode

get prevNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Source

packages/core/src/Node.ts:81

---

sourceNode

get sourceNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Source

packages/core/src/Node.ts:71

Methods

asRelatedNodeInfo()

asRelatedNodeInfo(): RelatedNodeInfo<T>

Returns

RelatedNodeInfo<T>

Source

packages/core/src/Node.ts:135

---

clone()

clone(): BaseNode <Metadata>

Returns

BaseNode <Metadata>

Source

packages/core/src/Node.ts:152

---

generateHash()

abstract generateHash(): string

Returns

string

Source

packages/core/src/Node.ts:125

---

getContent()

abstract getContent(metadataMode): string

Parameters

• metadataMode: MetadataMode

Returns

string

Source

packages/core/src/Node.ts:66

---

getEmbedding()

getEmbedding(): number[]

Returns

number[]

Source

packages/core/src/Node.ts:127

---

getMetadataStr()

abstract getMetadataStr(metadataMode): string

Parameters

• metadataMode: MetadataMode

Returns

string

Source

packages/core/src/Node.ts:67

---

getType()

abstract getType(): ObjectType

Returns

ObjectType

Source

packages/core/src/Node.ts:64

---

setContent()

abstract setContent(value): void

Parameters

• value: unknown

Returns

void

Source

packages/core/src/Node.ts:69

---

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

Source

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.

Source

packages/core/src/Node.ts:161