Saltar al contenido principal

Class: BaseNode<T>

Generic abstract class for retrievable nodes

Type parameters

NameType
Textends Metadata = Metadata

Hierarchy

Constructors

constructor

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

Type parameters

NameType
Textends Metadata = Metadata

Parameters

NameType
init?Partial<BaseNode<T>>

Returns

BaseNode<T>

Defined in

packages/core/src/Node.ts:60

Properties

embedding

Optional embedding: number[]

Defined in

packages/core/src/Node.ts:51


excludedEmbedMetadataKeys

excludedEmbedMetadataKeys: string[] = []

Defined in

packages/core/src/Node.ts:55


excludedLlmMetadataKeys

excludedLlmMetadataKeys: string[] = []

Defined in

packages/core/src/Node.ts:56


hash

hash: string = ""

Defined in

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.

Defined in

packages/core/src/Node.ts:50


metadata

metadata: T

Defined in

packages/core/src/Node.ts:54


relationships

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

Defined in

packages/core/src/Node.ts:57

Accessors

childNodes

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

Returns

undefined | RelatedNodeInfo<T>[]

Defined in

packages/core/src/Node.ts:113


nextNode

get nextNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Defined in

packages/core/src/Node.ts:93


parentNode

get parentNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Defined in

packages/core/src/Node.ts:103


prevNode

get prevNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Defined in

packages/core/src/Node.ts:81


sourceNode

get sourceNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Defined in

packages/core/src/Node.ts:71

Methods

asRelatedNodeInfo

asRelatedNodeInfo(): RelatedNodeInfo<T>

Returns

RelatedNodeInfo<T>

Defined in

packages/core/src/Node.ts:135


clone

clone(): BaseNode<Metadata>

Returns

BaseNode<Metadata>

Defined in

packages/core/src/Node.ts:152


generateHash

generateHash(): string

Returns

string

Defined in

packages/core/src/Node.ts:125


getContent

getContent(metadataMode): string

Parameters

NameType
metadataModeMetadataMode

Returns

string

Defined in

packages/core/src/Node.ts:66


getEmbedding

getEmbedding(): number[]

Returns

number[]

Defined in

packages/core/src/Node.ts:127


getMetadataStr

getMetadataStr(metadataMode): string

Parameters

NameType
metadataModeMetadataMode

Returns

string

Defined in

packages/core/src/Node.ts:67


getType

getType(): ObjectType

Returns

ObjectType

Defined in

packages/core/src/Node.ts:64


setContent

setContent(value): void

Parameters

NameType
valueunknown

Returns

void

Defined in

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

Defined in

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.

Defined in

packages/core/src/Node.ts:161