Skip to main content

Class: IndexList

The underlying structure of each index.

Extends​

Constructors​

new IndexList()​

new IndexList(indexId, summary): IndexList

Parameters​

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

• summary: undefined | string = undefined

Returns​

IndexList

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

nodes​

nodes: string[] = []

Defined in​

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

summary?​

optional summary: string

Inherited from​

IndexStruct.summary

Defined in​

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

type​

type: IndexStructType = IndexStructType.LIST

Defined in​

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

Methods​

addNode()​

addNode(node): void

Parameters​

• node: BaseNode<Metadata>

Returns​

void

Defined in​

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

getSummary()​

getSummary(): string

Returns​

string

Inherited from​

IndexStruct.getSummary

Defined in​

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

toJson()​

toJson(): Record<string, unknown>

Returns​

Record<string, unknown>

Overrides​

IndexStruct.toJson

Defined in​

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