Skip to main content

Class: abstract BaseNode<T>

Generic abstract class for retrievable nodes

Extended by​

Type parameters​

• T extends Metadata = Metadata

Constructors​

new BaseNode()​

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

Parameters​

• init?: BaseNodeParams<T>

Returns​

BaseNode<T>

Source​

packages/core/dist/schema/index.d.ts:57

Properties​

embedding?​

optional embedding: number[]

Source​

packages/core/dist/schema/index.d.ts:51

excludedEmbedMetadataKeys​

excludedEmbedMetadataKeys: string[]

Source​

packages/core/dist/schema/index.d.ts:53

excludedLlmMetadataKeys​

excludedLlmMetadataKeys: string[]

Source​

packages/core/dist/schema/index.d.ts:54

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/dist/schema/index.d.ts:50

metadata​

metadata: T

Source​

packages/core/dist/schema/index.d.ts:52

relationships​

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

Source​

packages/core/dist/schema/index.d.ts:55

Accessors​

childNodes​

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

Returns​

undefined | RelatedNodeInfo<T>[]

Source​

packages/core/dist/schema/index.d.ts:66

hash​

nextNode​

get nextNode(): undefined | RelatedNodeInfo<T>

Returns​

undefined | RelatedNodeInfo<T>

Source​

packages/core/dist/schema/index.d.ts:64

parentNode​

get parentNode(): undefined | RelatedNodeInfo<T>

Returns​

undefined | RelatedNodeInfo<T>

Source​

packages/core/dist/schema/index.d.ts:65

prevNode​

get prevNode(): undefined | RelatedNodeInfo<T>

Returns​

undefined | RelatedNodeInfo<T>

Source​

packages/core/dist/schema/index.d.ts:63

sourceNode​

get sourceNode(): undefined | RelatedNodeInfo<T>

Returns​

undefined | RelatedNodeInfo<T>

Source​

packages/core/dist/schema/index.d.ts:62

type​

get abstract type(): ObjectType

Returns​

ObjectType

Source​

packages/core/dist/schema/index.d.ts:58

Methods​

asRelatedNodeInfo()​

asRelatedNodeInfo(): RelatedNodeInfo<T>

Returns​

RelatedNodeInfo<T>

Source​

packages/core/dist/schema/index.d.ts:69

clone()​

clone(): BaseNode <Metadata>

Returns​

BaseNode <Metadata>

Source​

packages/core/dist/schema/index.d.ts:76

generateHash()​

abstract generateHash(): string

Returns​

string

Source​

packages/core/dist/schema/index.d.ts:67

getContent()​

abstract getContent(metadataMode): string

Parameters​

• metadataMode: MetadataMode

Returns​

string

Source​

packages/core/dist/schema/index.d.ts:59

getEmbedding()​

getEmbedding(): number[]

Returns​

number[]

Source​

packages/core/dist/schema/index.d.ts:68

getMetadataStr()​

abstract getMetadataStr(metadataMode): string

Parameters​

• metadataMode: MetadataMode

Returns​

string

Source​

packages/core/dist/schema/index.d.ts:60

setContent()​

abstract setContent(value): void

Parameters​

• value: unknown

Returns​

void

Source​

packages/core/dist/schema/index.d.ts:61

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/dist/schema/index.d.ts:75

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/dist/schema/index.d.ts:82