@supabase/storage-js 2.79.1-canary.1 → 2.80.0

package/dist/main/lib/vectors/VectorDataApi.js

@@ -0,0 +1,336 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const constants_1 = require("./constants");
+const errors_1 = require("./errors");
+const fetch_1 = require("./fetch");
+const helpers_1 = require("./helpers");
+/**
+ * API class for managing Vector Data within Vector Indexes
+ * Provides methods for inserting, querying, listing, and deleting vector embeddings
+ */
+class VectorDataApi {
+    constructor(url, headers = {}, fetch) {
+        this.shouldThrowOnError = false;
+        this.url = url.replace(/\/$/, '');
+        this.headers = Object.assign(Object.assign({}, constants_1.DEFAULT_HEADERS), headers);
+        this.fetch = (0, helpers_1.resolveFetch)(fetch);
+    }
+    /**
+     * Enable throwing errors instead of returning them in the response
+     * When enabled, failed operations will throw instead of returning { data: null, error }
+     *
+     * @returns This instance for method chaining
+     * @example
+     * ```typescript
+     * const client = new VectorDataApi(url, headers)
+     * client.throwOnError()
+     * const { data } = await client.putVectors(options) // throws on error
+     * ```
+     */
+    throwOnError() {
+        this.shouldThrowOnError = true;
+        return this;
+    }
+    /**
+     * Inserts or updates vectors in batch (upsert operation)
+     * Accepts 1-500 vectors per request. Larger batches should be split
+     *
+     * @param options - Vector insertion options
+     * @param options.vectorBucketName - Name of the parent vector bucket
+     * @param options.indexName - Name of the target index
+     * @param options.vectors - Array of vectors to insert/update (1-500 items)
+     * @returns Promise with empty response on success or error
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `S3VectorConflictException` if duplicate key conflict occurs (HTTP 409)
+     * - `S3VectorNotFoundException` if bucket or index doesn't exist (HTTP 404)
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * const { data, error } = await client.putVectors({
+     *   vectorBucketName: 'embeddings-prod',
+     *   indexName: 'documents-openai-small',
+     *   vectors: [
+     *     {
+     *       key: 'doc-1',
+     *       data: { float32: [0.1, 0.2, 0.3, ...] }, // 1536 dimensions
+     *       metadata: { title: 'Introduction', page: 1 }
+     *     },
+     *     {
+     *       key: 'doc-2',
+     *       data: { float32: [0.4, 0.5, 0.6, ...] },
+     *       metadata: { title: 'Conclusion', page: 42 }
+     *     }
+     *   ]
+     * })
+     * ```
+     */
+    putVectors(options) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            try {
+                // Validate batch size
+                if (options.vectors.length < 1 || options.vectors.length > 500) {
+                    throw new Error('Vector batch size must be between 1 and 500 items');
+                }
+                const data = yield (0, fetch_1.post)(this.fetch, `${this.url}/PutVectors`, options, {
+                    headers: this.headers,
+                });
+                return { data: data || {}, error: null };
+            }
+            catch (error) {
+                if (this.shouldThrowOnError) {
+                    throw error;
+                }
+                if ((0, errors_1.isStorageVectorsError)(error)) {
+                    return { data: null, error };
+                }
+                throw error;
+            }
+        });
+    }
+    /**
+     * Retrieves vectors by their keys in batch
+     * Optionally includes vector data and/or metadata in response
+     * Additional permissions required when returning data or metadata
+     *
+     * @param options - Vector retrieval options
+     * @param options.vectorBucketName - Name of the parent vector bucket
+     * @param options.indexName - Name of the index
+     * @param options.keys - Array of vector keys to retrieve
+     * @param options.returnData - Whether to include vector embeddings (requires permission)
+     * @param options.returnMetadata - Whether to include metadata (requires permission)
+     * @returns Promise with array of vectors or error
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `S3VectorNotFoundException` if bucket or index doesn't exist (HTTP 404)
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * const { data, error } = await client.getVectors({
+     *   vectorBucketName: 'embeddings-prod',
+     *   indexName: 'documents-openai-small',
+     *   keys: ['doc-1', 'doc-2', 'doc-3'],
+     *   returnData: false,     // Don't return embeddings
+     *   returnMetadata: true   // Return metadata only
+     * })
+     * if (data) {
+     *   data.vectors.forEach(v => console.log(v.key, v.metadata))
+     * }
+     * ```
+     */
+    getVectors(options) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            try {
+                const data = yield (0, fetch_1.post)(this.fetch, `${this.url}/GetVectors`, options, {
+                    headers: this.headers,
+                });
+                return { data, error: null };
+            }
+            catch (error) {
+                if (this.shouldThrowOnError) {
+                    throw error;
+                }
+                if ((0, errors_1.isStorageVectorsError)(error)) {
+                    return { data: null, error };
+                }
+                throw error;
+            }
+        });
+    }
+    /**
+     * Lists/scans vectors in an index with pagination
+     * Supports parallel scanning via segment configuration for high-throughput scenarios
+     * Additional permissions required when returning data or metadata
+     *
+     * @param options - Vector listing options
+     * @param options.vectorBucketName - Name of the parent vector bucket
+     * @param options.indexName - Name of the index
+     * @param options.maxResults - Maximum results per page (default: 500, max: 1000)
+     * @param options.nextToken - Pagination token from previous response
+     * @param options.returnData - Whether to include vector embeddings (requires permission)
+     * @param options.returnMetadata - Whether to include metadata (requires permission)
+     * @param options.segmentCount - Total parallel segments (1-16) for distributed scanning
+     * @param options.segmentIndex - Zero-based segment index (0 to segmentCount-1)
+     * @returns Promise with array of vectors, pagination token, or error
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `S3VectorNotFoundException` if bucket or index doesn't exist (HTTP 404)
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * // Simple pagination
+     * let nextToken: string | undefined
+     * do {
+     *   const { data, error } = await client.listVectors({
+     *     vectorBucketName: 'embeddings-prod',
+     *     indexName: 'documents-openai-small',
+     *     maxResults: 500,
+     *     nextToken,
+     *     returnMetadata: true
+     *   })
+     *   if (error) break
+     *   console.log('Batch:', data.vectors.length)
+     *   nextToken = data.nextToken
+     * } while (nextToken)
+     *
+     * // Parallel scanning (4 concurrent workers)
+     * const workers = [0, 1, 2, 3].map(async (segmentIndex) => {
+     *   const { data } = await client.listVectors({
+     *     vectorBucketName: 'embeddings-prod',
+     *     indexName: 'documents-openai-small',
+     *     segmentCount: 4,
+     *     segmentIndex,
+     *     returnMetadata: true
+     *   })
+     *   return data?.vectors || []
+     * })
+     * const results = await Promise.all(workers)
+     * ```
+     */
+    listVectors(options) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            try {
+                // Validate segment configuration
+                if (options.segmentCount !== undefined) {
+                    if (options.segmentCount < 1 || options.segmentCount > 16) {
+                        throw new Error('segmentCount must be between 1 and 16');
+                    }
+                    if (options.segmentIndex !== undefined) {
+                        if (options.segmentIndex < 0 || options.segmentIndex >= options.segmentCount) {
+                            throw new Error(`segmentIndex must be between 0 and ${options.segmentCount - 1}`);
+                        }
+                    }
+                }
+                const data = yield (0, fetch_1.post)(this.fetch, `${this.url}/ListVectors`, options, {
+                    headers: this.headers,
+                });
+                return { data, error: null };
+            }
+            catch (error) {
+                if (this.shouldThrowOnError) {
+                    throw error;
+                }
+                if ((0, errors_1.isStorageVectorsError)(error)) {
+                    return { data: null, error };
+                }
+                throw error;
+            }
+        });
+    }
+    /**
+     * Queries for similar vectors using approximate nearest neighbor (ANN) search
+     * Returns top-K most similar vectors based on the configured distance metric
+     * Supports optional metadata filtering (requires GetVectors permission)
+     *
+     * @param options - Query options
+     * @param options.vectorBucketName - Name of the parent vector bucket
+     * @param options.indexName - Name of the index
+     * @param options.queryVector - Query embedding to find similar vectors
+     * @param options.topK - Number of nearest neighbors to return (default: 10)
+     * @param options.filter - Optional JSON filter for metadata (requires GetVectors permission)
+     * @param options.returnDistance - Whether to include similarity distances
+     * @param options.returnMetadata - Whether to include metadata (requires GetVectors permission)
+     * @returns Promise with array of similar vectors ordered by distance
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `S3VectorNotFoundException` if bucket or index doesn't exist (HTTP 404)
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * // Semantic search with filtering
+     * const { data, error } = await client.queryVectors({
+     *   vectorBucketName: 'embeddings-prod',
+     *   indexName: 'documents-openai-small',
+     *   queryVector: { float32: [0.1, 0.2, 0.3, ...] }, // 1536 dimensions
+     *   topK: 5,
+     *   filter: {
+     *     category: 'technical',
+     *     published: true
+     *   },
+     *   returnDistance: true,
+     *   returnMetadata: true
+     * })
+     * if (data) {
+     *   data.matches.forEach(match => {
+     *     console.log(`${match.key}: distance=${match.distance}`)
+     *     console.log('Metadata:', match.metadata)
+     *   })
+     * }
+     * ```
+     */
+    queryVectors(options) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            try {
+                const data = yield (0, fetch_1.post)(this.fetch, `${this.url}/QueryVectors`, options, {
+                    headers: this.headers,
+                });
+                return { data, error: null };
+            }
+            catch (error) {
+                if (this.shouldThrowOnError) {
+                    throw error;
+                }
+                if ((0, errors_1.isStorageVectorsError)(error)) {
+                    return { data: null, error };
+                }
+                throw error;
+            }
+        });
+    }
+    /**
+     * Deletes vectors by their keys in batch
+     * Accepts 1-500 keys per request
+     *
+     * @param options - Vector deletion options
+     * @param options.vectorBucketName - Name of the parent vector bucket
+     * @param options.indexName - Name of the index
+     * @param options.keys - Array of vector keys to delete (1-500 items)
+     * @returns Promise with empty response on success or error
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `S3VectorNotFoundException` if bucket or index doesn't exist (HTTP 404)
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * const { error } = await client.deleteVectors({
+     *   vectorBucketName: 'embeddings-prod',
+     *   indexName: 'documents-openai-small',
+     *   keys: ['doc-1', 'doc-2', 'doc-3']
+     * })
+     * if (!error) {
+     *   console.log('Vectors deleted successfully')
+     * }
+     * ```
+     */
+    deleteVectors(options) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            try {
+                // Validate batch size
+                if (options.keys.length < 1 || options.keys.length > 500) {
+                    throw new Error('Keys batch size must be between 1 and 500 items');
+                }
+                const data = yield (0, fetch_1.post)(this.fetch, `${this.url}/DeleteVectors`, options, {
+                    headers: this.headers,
+                });
+                return { data: data || {}, error: null };
+            }
+            catch (error) {
+                if (this.shouldThrowOnError) {
+                    throw error;
+                }
+                if ((0, errors_1.isStorageVectorsError)(error)) {
+                    return { data: null, error };
+                }
+                throw error;
+            }
+        });
+    }
+}
+exports.default = VectorDataApi;
+//# sourceMappingURL=VectorDataApi.js.map

package/dist/main/lib/vectors/VectorDataApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VectorDataApi.js","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorDataApi.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAC7C,qCAAgD;AAChD,mCAAqC;AACrC,uCAAwC;AAaxC;;;GAGG;AACH,MAAqB,aAAa;IAMhC,YAAY,GAAW,EAAE,UAAqC,EAAE,EAAE,KAAa;QAFrE,uBAAkB,GAAG,KAAK,CAAA;QAGlC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACjC,IAAI,CAAC,OAAO,mCAAQ,2BAAe,GAAK,OAAO,CAAE,CAAA;QACjD,IAAI,CAAC,KAAK,GAAG,IAAA,sBAAY,EAAC,KAAK,CAAC,CAAA;IAClC,CAAC;IAED;;;;;;;;;;;OAWG;IACI,YAAY;QACjB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAA;QAC9B,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,UAAU,CAAC,OAA0B;;YACzC,IAAI,CAAC;gBACH,sBAAsB;gBACtB,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;oBAC/D,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAA;gBACtE,CAAC;gBAED,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,aAAa,EAAE,OAAO,EAAE;oBACrE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC1C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,UAAU,CAAC,OAA0B;;YACzC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,aAAa,EAAE,OAAO,EAAE;oBACrE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC9B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACG,WAAW,CAAC,OAA2B;;YAC3C,IAAI,CAAC;gBACH,iCAAiC;gBACjC,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;oBACvC,IAAI,OAAO,CAAC,YAAY,GAAG,CAAC,IAAI,OAAO,CAAC,YAAY,GAAG,EAAE,EAAE,CAAC;wBAC1D,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;oBAC1D,CAAC;oBACD,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;wBACvC,IAAI,OAAO,CAAC,YAAY,GAAG,CAAC,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;4BAC7E,MAAM,IAAI,KAAK,CAAC,sCAAsC,OAAO,CAAC,YAAY,GAAG,CAAC,EAAE,CAAC,CAAA;wBACnF,CAAC;oBACH,CAAC;gBACH,CAAC;gBAED,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,cAAc,EAAE,OAAO,EAAE;oBACtE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC9B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACG,YAAY,CAAC,OAA4B;;YAC7C,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,eAAe,EAAE,OAAO,EAAE;oBACvE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC9B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,aAAa,CAAC,OAA6B;;YAC/C,IAAI,CAAC;gBACH,sBAAsB;gBACtB,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;oBACzD,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;gBACpE,CAAC;gBAED,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,gBAAgB,EAAE,OAAO,EAAE;oBACxE,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB,CAAC,CAAA;gBACF,OAAO,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;YAC1C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBAC5B,MAAM,KAAK,CAAA;gBACb,CAAC;gBACD,IAAI,IAAA,8BAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;gBAC9B,CAAC;gBACD,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;KAAA;CACF;AAhUD,gCAgUC"}

package/dist/main/lib/vectors/VectorIndexApi.d.ts

@@ -0,0 +1,157 @@
+import { Fetch } from './fetch';
+import { ApiResponse, VectorIndex, ListIndexesOptions, ListIndexesResponse, VectorDataType, DistanceMetric, MetadataConfiguration } from './types';
+/**
+ * Options for creating a vector index
+ */
+export interface CreateIndexOptions {
+    vectorBucketName: string;
+    indexName: string;
+    dataType: VectorDataType;
+    dimension: number;
+    distanceMetric: DistanceMetric;
+    metadataConfiguration?: MetadataConfiguration;
+}
+/**
+ * API class for managing Vector Indexes within Vector Buckets
+ * Provides methods for creating, reading, listing, and deleting vector indexes
+ */
+export default class VectorIndexApi {
+    protected url: string;
+    protected headers: {
+        [key: string]: string;
+    };
+    protected fetch: Fetch;
+    protected shouldThrowOnError: boolean;
+    constructor(url: string, headers?: {
+        [key: string]: string;
+    }, fetch?: Fetch);
+    /**
+     * Enable throwing errors instead of returning them in the response
+     * When enabled, failed operations will throw instead of returning { data: null, error }
+     *
+     * @returns This instance for method chaining
+     * @example
+     * ```typescript
+     * const client = new VectorIndexApi(url, headers)
+     * client.throwOnError()
+     * const { data } = await client.createIndex(options) // throws on error
+     * ```
+     */
+    throwOnError(): this;
+    /**
+     * Creates a new vector index within a bucket
+     * Defines the schema for vectors including dimensionality, distance metric, and metadata config
+     *
+     * @param options - Index configuration
+     * @param options.vectorBucketName - Name of the parent vector bucket
+     * @param options.indexName - Unique name for the index within the bucket
+     * @param options.dataType - Data type for vector components (currently only 'float32')
+     * @param options.dimension - Dimensionality of vectors (e.g., 384, 768, 1536)
+     * @param options.distanceMetric - Similarity metric ('cosine', 'euclidean', 'dotproduct')
+     * @param options.metadataConfiguration - Optional config for non-filterable metadata keys
+     * @returns Promise with empty response on success or error
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `S3VectorConflictException` if index already exists (HTTP 409)
+     * - `S3VectorMaxIndexesExceeded` if quota exceeded (HTTP 400)
+     * - `S3VectorNotFoundException` if bucket doesn't exist (HTTP 404)
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * const { data, error } = await client.createIndex({
+     *   vectorBucketName: 'embeddings-prod',
+     *   indexName: 'documents-openai-small',
+     *   dataType: 'float32',
+     *   dimension: 1536,
+     *   distanceMetric: 'cosine',
+     *   metadataConfiguration: {
+     *     nonFilterableMetadataKeys: ['raw_text', 'internal_id']
+     *   }
+     * })
+     * ```
+     */
+    createIndex(options: CreateIndexOptions): Promise<ApiResponse<undefined>>;
+    /**
+     * Retrieves metadata for a specific vector index
+     * Returns index configuration including dimension, distance metric, and metadata settings
+     *
+     * @param vectorBucketName - Name of the parent vector bucket
+     * @param indexName - Name of the index to retrieve
+     * @returns Promise with index metadata or error
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `S3VectorNotFoundException` if index or bucket doesn't exist (HTTP 404)
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * const { data, error } = await client.getIndex('embeddings-prod', 'documents-openai-small')
+     * if (data) {
+     *   console.log('Index dimension:', data.index.dimension)
+     *   console.log('Distance metric:', data.index.distanceMetric)
+     * }
+     * ```
+     */
+    getIndex(vectorBucketName: string, indexName: string): Promise<ApiResponse<{
+        index: VectorIndex;
+    }>>;
+    /**
+     * Lists vector indexes within a bucket with optional filtering and pagination
+     * Supports prefix-based filtering and paginated results
+     *
+     * @param options - Listing options
+     * @param options.vectorBucketName - Name of the parent vector bucket
+     * @param options.prefix - Filter indexes by name prefix
+     * @param options.maxResults - Maximum results per page (default: 100)
+     * @param options.nextToken - Pagination token from previous response
+     * @returns Promise with list of indexes and pagination token
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `S3VectorNotFoundException` if bucket doesn't exist (HTTP 404)
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * // List all indexes in a bucket
+     * const { data, error } = await client.listIndexes({
+     *   vectorBucketName: 'embeddings-prod',
+     *   prefix: 'documents-'
+     * })
+     * if (data) {
+     *   console.log('Found indexes:', data.indexes.map(i => i.indexName))
+     *   // Fetch next page if available
+     *   if (data.nextToken) {
+     *     const next = await client.listIndexes({
+     *       vectorBucketName: 'embeddings-prod',
+     *       nextToken: data.nextToken
+     *     })
+     *   }
+     * }
+     * ```
+     */
+    listIndexes(options: ListIndexesOptions): Promise<ApiResponse<ListIndexesResponse>>;
+    /**
+     * Deletes a vector index and all its data
+     * This operation removes the index schema and all vectors stored in the index
+     *
+     * @param vectorBucketName - Name of the parent vector bucket
+     * @param indexName - Name of the index to delete
+     * @returns Promise with empty response on success or error
+     *
+     * @throws {StorageVectorsApiError} With code:
+     * - `S3VectorNotFoundException` if index or bucket doesn't exist (HTTP 404)
+     * - `InternalError` for server errors (HTTP 500)
+     *
+     * @example
+     * ```typescript
+     * // Delete an index and all its vectors
+     * const { error } = await client.deleteIndex('embeddings-prod', 'old-index')
+     * if (!error) {
+     *   console.log('Index deleted successfully')
+     * }
+     * ```
+     */
+    deleteIndex(vectorBucketName: string, indexName: string): Promise<ApiResponse<undefined>>;
+}
+//# sourceMappingURL=VectorIndexApi.d.ts.map

package/dist/main/lib/vectors/VectorIndexApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VectorIndexApi.d.ts","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorIndexApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAQ,MAAM,SAAS,CAAA;AAErC,OAAO,EACL,WAAW,EACX,WAAW,EACX,kBAAkB,EAClB,mBAAmB,EACnB,cAAc,EACd,cAAc,EACd,qBAAqB,EACtB,MAAM,SAAS,CAAA;AAEhB;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,gBAAgB,EAAE,MAAM,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,cAAc,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,cAAc,CAAA;IAC9B,qBAAqB,CAAC,EAAE,qBAAqB,CAAA;CAC9C;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,SAAS,CAAC,GAAG,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IAC5C,SAAS,CAAC,KAAK,EAAE,KAAK,CAAA;IACtB,SAAS,CAAC,kBAAkB,UAAQ;gBAExB,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAO,EAAE,KAAK,CAAC,EAAE,KAAK;IAM/E;;;;;;;;;;;OAWG;IACI,YAAY,IAAI,IAAI;IAK3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAiB/E;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,QAAQ,CACZ,gBAAgB,EAAE,MAAM,EACxB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,WAAW,CAAC;QAAE,KAAK,EAAE,WAAW,CAAA;KAAE,CAAC,CAAC;IAoB/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;IAiBzF;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,WAAW,CAAC,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;CAmBhG"}