Skip to main content

Class: BaseNode

Generic abstract class for retrievable nodes

Hierarchy​

Constructors​

constructor​

• new BaseNode(init?)

Parameters​

NameType
init?Partial<BaseNode>

Defined in​

Node.ts:48

Properties​

embedding​

• Optional embedding: number[]

Defined in​

Node.ts:39

excludedEmbedMetadataKeys​

• excludedEmbedMetadataKeys: string[] = []

Defined in​

Node.ts:43

excludedLlmMetadataKeys​

• excludedLlmMetadataKeys: string[] = []

Defined in​

Node.ts:44

hash​

• hash: string = ""

Defined in​

Node.ts:46

id_​

• id_: string

Defined in​

Node.ts:38

metadata​

• metadata: Record<string, any> = {}

Defined in​

Node.ts:42

relationships​

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

Defined in​

Node.ts:45

Accessors​

childNodes​

• get childNodes(): undefined | RelatedNodeInfo[]

Returns​

undefined | RelatedNodeInfo[]

Defined in​

Node.ts:104

nextNode​

• get nextNode(): undefined | RelatedNodeInfo

Returns​

undefined | RelatedNodeInfo

Defined in​

Node.ts:84

nodeId​

• get nodeId(): string

Returns​

string

Defined in​

Node.ts:58

parentNode​

• get parentNode(): undefined | RelatedNodeInfo

Returns​

undefined | RelatedNodeInfo

Defined in​

Node.ts:94

prevNode​

• get prevNode(): undefined | RelatedNodeInfo

Returns​

undefined | RelatedNodeInfo

Defined in​

Node.ts:72

sourceNode​

• get sourceNode(): undefined | RelatedNodeInfo

Returns​

undefined | RelatedNodeInfo

Defined in​

Node.ts:62

Methods​

asRelatedNodeInfo​

▸ asRelatedNodeInfo(): RelatedNodeInfo

Returns​

RelatedNodeInfo

Defined in​

Node.ts:124

getContent​

▸ Abstract getContent(metadataMode): string

Parameters​

NameType
metadataModeMetadataMode

Returns​

string

Defined in​

Node.ts:54

getEmbedding​

▸ getEmbedding(): number[]

Returns​

number[]

Defined in​

Node.ts:116

getMetadataStr​

▸ Abstract getMetadataStr(metadataMode): string

Parameters​

NameType
metadataModeMetadataMode

Returns​

string

Defined in​

Node.ts:55

getType​

▸ Abstract getType(): ObjectType

Returns​

ObjectType

Defined in​

Node.ts:52

setContent​

▸ Abstract setContent(value): void

Parameters​

NameType
valueany

Returns​

void

Defined in​

Node.ts:56