Class: IndexClient

Defined in: packages/sdk/src/backend/indexes.ts:274

Control-plane client for the vector database.

Constructors

Constructor

new IndexClient(config): IndexClient

Defined in: packages/sdk/src/backend/indexes.ts:278

Parameters

config

PlatformConfig

Returns

IndexClient

Methods

configureIndex()

configureIndex(name, opts): Promise<IndexDescription>

Defined in: packages/sdk/src/backend/indexes.ts:331

Parameters

name

string

opts

deletionProtection?

boolean

tags?

Record<string, string>

Returns

Promise<IndexDescription>

---

createIndex()

createIndex(opts): Promise<IndexDescription>

Defined in: packages/sdk/src/backend/indexes.ts:289

Parameters

opts

CreateIndexOptions

Returns

Promise<IndexDescription>

---

deleteIndex()

deleteIndex(name): Promise<{ deleted: string; }>

Defined in: packages/sdk/src/backend/indexes.ts:351

Parameters

name

string

Returns

Promise<{ deleted: string; }>

---

describeIndex()

describeIndex(name): Promise<IndexDescription>

Defined in: packages/sdk/src/backend/indexes.ts:322

Parameters

name

string

Returns

Promise<IndexDescription>

---

index()

index(name): IndexHandle

Defined in: packages/sdk/src/backend/indexes.ts:361

Bind a data-plane handle to an index.

Parameters

name

string

Returns

IndexHandle

---

listIndexes()

listIndexes(): Promise<IndexDescription[]>

Defined in: packages/sdk/src/backend/indexes.ts:310

Returns

Promise<IndexDescription[]>