BaseNode

Defined in: packages/core/src/schema/node.ts:57

Generic abstract class for retrievable nodes

Extended by

• TextNode

Type Parameters

T

T extends Metadata = Metadata

Constructors

Constructor

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

Defined in: packages/core/src/schema/node.ts:76

Parameters

init?

BaseNodeParams<T>

Returns

BaseNode<T>

Properties

id_

id_: string

Defined in: 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

embedding: undefined | number[]

Defined in: packages/core/src/schema/node.ts:65

---

metadata

metadata: T

Defined in: packages/core/src/schema/node.ts:68

---

excludedEmbedMetadataKeys

excludedEmbedMetadataKeys: string[]

Defined in: packages/core/src/schema/node.ts:69

---

excludedLlmMetadataKeys

excludedLlmMetadataKeys: string[]

Defined in: packages/core/src/schema/node.ts:70

---

relationships

relationships: Partial<Record<NodeRelationship, RelatedNodeType<T>>>

Defined in: packages/core/src/schema/node.ts:71

Accessors

hash

Defined in: packages/core/src/schema/node.ts:74

---

type

Get Signature

get abstract type(): ObjectType

Defined in: packages/core/src/schema/node.ts:94

Returns

ObjectType

---

sourceNode

Get Signature

get sourceNode(): undefined | RelatedNodeInfo<T>

Defined in: packages/core/src/schema/node.ts:103

Returns

undefined | RelatedNodeInfo<T>

---

prevNode

Get Signature

get prevNode(): undefined | RelatedNodeInfo<T>

Defined in: packages/core/src/schema/node.ts:113

Returns

undefined | RelatedNodeInfo<T>

---

nextNode

Get Signature

get nextNode(): undefined | RelatedNodeInfo<T>

Defined in: packages/core/src/schema/node.ts:125

Returns

undefined | RelatedNodeInfo<T>

---

parentNode

Get Signature

get parentNode(): undefined | RelatedNodeInfo<T>

Defined in: packages/core/src/schema/node.ts:135

Returns

undefined | RelatedNodeInfo<T>

---

childNodes

Get Signature

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

Defined in: packages/core/src/schema/node.ts:145

Returns

undefined | RelatedNodeInfo<T>[]

Methods

getContent()

abstract getContent(metadataMode): string

Defined in: packages/core/src/schema/node.ts:96

Parameters

metadataMode

MetadataMode

Returns

string

---

getMetadataStr()

abstract getMetadataStr(metadataMode): string

Defined in: packages/core/src/schema/node.ts:98

Parameters

metadataMode

MetadataMode

Returns

string

---

setContent()

abstract setContent(value): void

Defined in: packages/core/src/schema/node.ts:101

Parameters

value

unknown

Returns

void

---

generateHash()

abstract generateHash(): string

Defined in: packages/core/src/schema/node.ts:157

Returns

string

---

getEmbedding()

getEmbedding(): number[]

Defined in: packages/core/src/schema/node.ts:159

Returns

number[]

---

asRelatedNodeInfo()

asRelatedNodeInfo(): RelatedNodeInfo<T>

Defined in: packages/core/src/schema/node.ts:167

Returns

RelatedNodeInfo<T>

---

toJSON()

toJSON(): Record<string, any>

Defined in: 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

Record<string, any>

See

toMutableJSON - use to return a mutable JSON instead

---

clone()

clone(): BaseNode

Defined in: packages/core/src/schema/node.ts:190

Returns

BaseNode

---

toMutableJSON()

toMutableJSON(): Record<string, any>

Defined in: 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

Record<string, any>

• The JSON representation of the object.