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.89.0/dist/index.d.mts";
class VectorIndexApi {
constructor(
url: string,
headers?: {
[key: string]: string;
},
fetch?: Fetch,
);
protected fetch: Fetch;
protected headers: {
[key: string]: string;
};
protected shouldThrowOnError: boolean;
protected url: string;
 
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>>;
throwOnError(): this;
}

§Constructors

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

Creates a new VectorIndexApi instance

§Properties

§
headers: {
[key: string]: string;
}
[src]
§
shouldThrowOnError: boolean
[src]
§
url: string
[src]

§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

§
throwOnError(): this
[src]

Enable throwing errors instead of returning them in the response