StorageVectorsClient

import { StorageVectorsClient } from "https://esm.sh/@supabase/storage-js@2.101.0/dist/index.d.mts";

class StorageVectorsClient extends VectorBucketApi {

constructor(url: string, options?: StorageVectorsClientOptions);

createBucket(vectorBucketName: string): Promise<ApiResponse<undefined>>;

deleteBucket(vectorBucketName: string): Promise<ApiResponse<undefined>>;

from(vectorBucketName: string): VectorBucketScope;

getBucket(vectorBucketName: string): Promise<ApiResponse<{

vectorBucket: VectorBucket;

}>>;

listBuckets(options?: ListVectorBucketsOptions): Promise<ApiResponse<ListVectorBucketsResponse>>;

}

§Extends

VectorBucketApi

[src]

§Constructors

new StorageVectorsClient(url: string, options?: StorageVectorsClientOptions)

[src]

@param url

Base URL of the Storage Vectors REST API.

@param options.headers

Optional headers (for example Authorization) applied to every request.

@param options.fetch

Optional custom fetch implementation for non-browser runtimes.

@example

Creating a StorageVectorsClient instance

const client = new StorageVectorsClient(url, options)

§Methods

createBucket(vectorBucketName: string): Promise<ApiResponse<undefined>>

[src]

@param vectorBucketName

Unique name for the vector bucket

@return

Promise with empty response on success or error

@example

Creating a vector bucket

const { data, error } = await supabase
  .storage
  .vectors
  .createBucket('embeddings-prod')

deleteBucket(vectorBucketName: string): Promise<ApiResponse<undefined>>

[src]

@param vectorBucketName

Name of the vector bucket to delete

@return

Promise with empty response on success or error

@example

Delete a vector bucket

const { data, error } = await supabase
  .storage
  .vectors
  .deleteBucket('embeddings-old')

from(vectorBucketName: string): VectorBucketScope

[src]

@param vectorBucketName

Name of the vector bucket

@return

Bucket-scoped client with index and vector operations

@example

Accessing a vector bucket

const bucket = supabase.storage.vectors.from('embeddings-prod')

getBucket(vectorBucketName: string): Promise<ApiResponse<{

vectorBucket: VectorBucket;

}>>

[src]

@param vectorBucketName

Name of the vector bucket

@return

Promise with bucket metadata or error

@example

Get bucket metadata

const { data, error } = await supabase
  .storage
  .vectors
  .getBucket('embeddings-prod')

console.log('Bucket created:', data?.vectorBucket.creationTime)

listBuckets(options?: ListVectorBucketsOptions): Promise<ApiResponse<ListVectorBucketsResponse>>

[src]

@param options

Optional filters (prefix, maxResults, nextToken)

@return

Promise with list of buckets or error

@example

List vector buckets

const { data, error } = await supabase
  .storage
  .vectors
  .listBuckets({ prefix: 'embeddings-' })

data?.vectorBuckets.forEach(bucket => {
  console.log(bucket.vectorBucketName)
})