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

VectorDataApi

import { VectorDataApi } from "https://esm.sh/@supabase/storage-js@2.89.0/dist/index.d.mts";
class VectorDataApi {
constructor(
url: string,
headers?: {
[key: string]: string;
},
fetch?: Fetch,
);
protected fetch: Fetch;
protected headers: {
[key: string]: string;
};
protected shouldThrowOnError: boolean;
protected url: string;
 
deleteVectors(options: DeleteVectorsOptions): Promise<ApiResponse<undefined>>;
getVectors(options: GetVectorsOptions): Promise<ApiResponse<GetVectorsResponse>>;
listVectors(options: ListVectorsOptions): Promise<ApiResponse<ListVectorsResponse>>;
putVectors(options: PutVectorsOptions): Promise<ApiResponse<undefined>>;
queryVectors(options: QueryVectorsOptions): Promise<ApiResponse<QueryVectorsResponse>>;
throwOnError(): this;
}

§Constructors

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

Creates a new VectorDataApi instance

§Properties

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

§Methods

§
deleteVectors(options: DeleteVectorsOptions): Promise<ApiResponse<undefined>>
[src]

Deletes vectors by their keys in batch (1-500 per request)

§
getVectors(options: GetVectorsOptions): Promise<ApiResponse<GetVectorsResponse>>
[src]

Retrieves vectors by their keys in batch

§
listVectors(options: ListVectorsOptions): Promise<ApiResponse<ListVectorsResponse>>
[src]

Lists vectors in an index with pagination

§
putVectors(options: PutVectorsOptions): Promise<ApiResponse<undefined>>
[src]

Inserts or updates vectors in batch (1-500 per request)

§
queryVectors(options: QueryVectorsOptions): Promise<ApiResponse<QueryVectorsResponse>>
[src]

Queries for similar vectors using approximate nearest neighbor search

§
throwOnError(): this
[src]

Enable throwing errors instead of returning them in the response