VectorStoreIndexAdmin
Optional index-administration contract for vector stores (REQ-16).
Adapters that can manage indexes at runtime (Postgres, Redis, LanceDB)
implement this alongside VectorStoreCore. Edge adapters whose
indexes are provisioned out-of-band (Cloudflare Vectorize via
wrangler.toml, Upstash Vector via its dashboard) MUST NOT
implement this — attempting admin calls on them should be a
typecheck error, not a runtime no-op (REQ-17).
Methods
Section titled “Methods”createIndex()
Section titled “createIndex()”createIndex(params): Promise<void>;Create a new vector index with the specified configuration. Implementations SHOULD be idempotent.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
|
|
Returns
Section titled “Returns”Promise<void>
deleteIndex()
Section titled “deleteIndex()”deleteIndex(indexName): Promise<void>;Delete an index and all its vectors.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
|
|
|
Returns
Section titled “Returns”Promise<void>
deleteVectors()
Section titled “deleteVectors()”deleteVectors(indexName, params): Promise<void>;Delete specific vectors from an index, either by id or by filter.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
|
|
|
|
|
{ |
|
|
|
|
|
|
Returns
Section titled “Returns”Promise<void>