Skip to main content

Interface: IndexState

Defined in: vector-index.ts:22

Properties​

done​

done: number

Defined in: vector-index.ts:32


error?​

optional error?: Error

Defined in: vector-index.ts:34


model?​

optional model?: ProviderInfo & object

Defined in: vector-index.ts:31

The model the index is built with.

Type Declaration​

model​

model: string


status​

status: "waiting" | "indexing" | "ready" | "error"

Defined in: vector-index.ts:29

  • waiting: no embedding model is available yet (see ai.getState().embedPending);
  • indexing: embedding documents (done of total);
  • ready: every document is indexed with model;
  • error: the last attempt failed (error); it is tried again when the model changes.

total​

total: number

Defined in: vector-index.ts:33