Skip to main content

Class: IndexDict

The underlying structure of each index.

Extends

Constructors

new IndexDict()

new IndexDict(indexId, summary): IndexDict

Parameters

indexId: `${string}-${string}-${string}-${string}-${string}` = ...

summary: undefined | string = undefined

Returns

IndexDict

Inherited from

IndexStruct.constructor

Defined in

packages/llamaindex/src/indices/IndexStruct.ts:10

Properties

indexId

indexId: string

Inherited from

IndexStruct.indexId

Defined in

packages/llamaindex/src/indices/IndexStruct.ts:7


nodesDict

nodesDict: Record<string, BaseNode<Metadata>> = {}

Defined in

packages/llamaindex/src/indices/json-to-index-struct.ts:11


summary?

optional summary: string

Inherited from

IndexStruct.summary

Defined in

packages/llamaindex/src/indices/IndexStruct.ts:8


type

type: IndexStructType = IndexStructType.SIMPLE_DICT

Defined in

packages/llamaindex/src/indices/json-to-index-struct.ts:12

Methods

addNode()

addNode(node, textId?): void

Parameters

node: BaseNode<Metadata>

textId?: string

Returns

void

Defined in

packages/llamaindex/src/indices/json-to-index-struct.ts:21


delete()

delete(nodeId): void

Parameters

nodeId: string

Returns

void

Defined in

packages/llamaindex/src/indices/json-to-index-struct.ts:40


getSummary()

getSummary(): string

Returns

string

Overrides

IndexStruct.getSummary

Defined in

packages/llamaindex/src/indices/json-to-index-struct.ts:14


toJson()

toJson(): Record<string, unknown>

Returns

Record<string, unknown>

Overrides

IndexStruct.toJson

Defined in

packages/llamaindex/src/indices/json-to-index-struct.ts:26