Skip to main content

Class: abstract IndexStruct

The underlying structure of each index.

Extended by

Constructors

new IndexStruct()

new IndexStruct(indexId, summary): IndexStruct

Parameters

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

summary: undefined | string = undefined

Returns

IndexStruct

Defined in

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

Properties

indexId

indexId: string

Defined in

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


summary?

optional summary: string

Defined in

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

Methods

getSummary()

getSummary(): string

Returns

string

Defined in

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


toJson()

toJson(): Record<string, unknown>

Returns

Record<string, unknown>

Defined in

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