BaseNode

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

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:85

Parameters

init?

BaseNodeParams<T>

Returns

BaseNode<T>

Properties

id_

id_: string

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

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: number[] | undefined

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

---

metadata

metadata: T

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

---

excludedEmbedMetadataKeys

excludedEmbedMetadataKeys: string[]

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

---

excludedLlmMetadataKeys

excludedLlmMetadataKeys: string[]

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

---

relationships

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

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

Accessors

hash

Get Signature

get hash(): string

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

Returns

string

Set Signature

set hash(newValue): void

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

Parameters

newValue

string

Returns

void

---

type

Get Signature

get abstract type(): ObjectType

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

Returns

ObjectType

---

sourceNode

Get Signature

get sourceNode(): RelatedNodeInfo<T> | undefined

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

Returns

RelatedNodeInfo<T> | undefined

---

prevNode

Get Signature

get prevNode(): RelatedNodeInfo<T> | undefined

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

Returns

RelatedNodeInfo<T> | undefined

---

nextNode

Get Signature

get nextNode(): RelatedNodeInfo<T> | undefined

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

Returns

RelatedNodeInfo<T> | undefined

---

parentNode

Get Signature

get parentNode(): RelatedNodeInfo<T> | undefined

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

Returns

RelatedNodeInfo<T> | undefined

---

childNodes

Get Signature

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

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

Returns

RelatedNodeInfo<T>[] | undefined

Methods

getContent()

abstract getContent(metadataMode): string

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

Parameters

metadataMode

MetadataMode

Returns

string

---

getMetadataStr()

abstract getMetadataStr(metadataMode): string

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

Parameters

metadataMode

MetadataMode

Returns

string

---

setContent()

abstract setContent(value): void

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

Parameters

value

unknown

Returns

void

---

generateHash()

abstract generateHash(): string

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

Returns

string

---

getEmbedding()

getEmbedding(): number[]

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

Returns

number[]

---

asRelatedNodeInfo()

asRelatedNodeInfo(): RelatedNodeInfo<T>

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

Returns

RelatedNodeInfo<T>

---

toJSON()

toJSON(): Record<string, any>

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

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:199

Returns

BaseNode

---

toMutableJSON()

toMutableJSON(): Record<string, any>

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

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.