Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

VectorIndexApi

import { VectorIndexApi } from "https://esm.sh/@supabase/storage-js@2.95.3/dist/index.d.mts";
class VectorIndexApi extends BaseApiClient<StorageError> {
constructor(
url: string,
headers?: {
[key: string]: string;
},
fetch?: Fetch,
);
createIndex(options: CreateIndexOptions): Promise<ApiResponse<undefined>>;
deleteIndex(vectorBucketName: string, indexName: string): Promise<ApiResponse<undefined>>;
getIndex(vectorBucketName: string, indexName: string): Promise<ApiResponse<{
index: VectorIndex;
}>>;
listIndexes(options: ListIndexesOptions): Promise<ApiResponse<ListIndexesResponse>>;
}

§Extends

§
BaseApiClient<StorageError>
[src]

§Constructors

§
new VectorIndexApi(url: string, headers?: {
[key: string]: string;
}, fetch?: Fetch)
[src]

Creates a new VectorIndexApi instance

§Methods

§
createIndex(options: CreateIndexOptions): Promise<ApiResponse<undefined>>
[src]

Creates a new vector index within a bucket

§
deleteIndex(vectorBucketName: string, indexName: string): Promise<ApiResponse<undefined>>
[src]

Deletes a vector index and all its data

§
getIndex(vectorBucketName: string, indexName: string): Promise<ApiResponse<{
index: VectorIndex;
}>>
[src]

Retrieves metadata for a specific vector index

§
listIndexes(options: ListIndexesOptions): Promise<ApiResponse<ListIndexesResponse>>
[src]

Lists vector indexes within a bucket with optional filtering and pagination