@supabase/storage-js 2.81.2-canary.2 → 2.82.0

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

@@ -6,10 +6,13 @@ const VectorIndexApi_1 = tslib_1.__importDefault(require("./VectorIndexApi"));
 const VectorDataApi_1 = tslib_1.__importDefault(require("./VectorDataApi"));
 const VectorBucketApi_1 = tslib_1.__importDefault(require("./VectorBucketApi"));
 /**
+ *
+ * @alpha
+ *
  * Main client for interacting with S3 Vectors API
  * Provides access to bucket, index, and vector data operations
  *
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
  *
  * **Usage Patterns:**
  *
@@ -64,23 +67,35 @@ const VectorBucketApi_1 = tslib_1.__importDefault(require("./VectorBucketApi"));
  */
 class StorageVectorsClient extends VectorBucketApi_1.default {
     /**
+     * @alpha
+     *
      * Creates a StorageVectorsClient that can manage buckets, indexes, and vectors.
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @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
+     * ```typescript
+     * const client = new StorageVectorsClient(url, options)
+     * ```
      */
     constructor(url, options = {}) {
         super(url, options.headers || {}, options.fetch);
     }
     /**
+     *
+     * @alpha
+     *
      * Access operations for a specific vector bucket
      * Returns a scoped client for index and vector operations within the bucket
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @param vectorBucketName - Name of the vector bucket
      * @returns Bucket-scoped client with index and vector operations
      *
@@ -106,27 +121,42 @@ class StorageVectorsClient extends VectorBucketApi_1.default {
 }
 exports.StorageVectorsClient = StorageVectorsClient;
 /**
+ *
+ * @alpha
+ *
  * Scoped client for operations within a specific vector bucket
  * Provides index management and access to vector operations
  *
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
  */
 class VectorBucketScope extends VectorIndexApi_1.default {
     /**
+     * @alpha
+     *
      * Creates a helper that automatically scopes all index operations to the provided bucket.
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
+     *
+     * @category Vector Buckets
+     * @example
+     * ```typescript
+     * const bucket = client.bucket('embeddings-prod')
+     * ```
      */
     constructor(url, headers, vectorBucketName, fetch) {
         super(url, headers, fetch);
         this.vectorBucketName = vectorBucketName;
     }
     /**
+     *
+     * @alpha
+     *
      * Creates a new vector index in this bucket
      * Convenience method that automatically includes the bucket name
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @param options - Index configuration (vectorBucketName is automatically set)
      * @returns Promise with empty response on success or error
      *
@@ -153,11 +183,15 @@ class VectorBucketScope extends VectorIndexApi_1.default {
         });
     }
     /**
+     *
+     * @alpha
+     *
      * Lists indexes in this bucket
      * Convenience method that automatically includes the bucket name
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @param options - Listing options (vectorBucketName is automatically set)
      * @returns Promise with list of indexes or error
      *
@@ -176,11 +210,15 @@ class VectorBucketScope extends VectorIndexApi_1.default {
         });
     }
     /**
+     *
+     * @alpha
+     *
      * Retrieves metadata for a specific index in this bucket
      * Convenience method that automatically includes the bucket name
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @param indexName - Name of the index to retrieve
      * @returns Promise with index metadata or error
      *
@@ -200,11 +238,15 @@ class VectorBucketScope extends VectorIndexApi_1.default {
         });
     }
     /**
+     *
+     * @alpha
+     *
      * Deletes an index from this bucket
      * Convenience method that automatically includes the bucket name
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @param indexName - Name of the index to delete
      * @returns Promise with empty response on success or error
      *
@@ -223,11 +265,15 @@ class VectorBucketScope extends VectorIndexApi_1.default {
         });
     }
     /**
+     *
+     * @alpha
+     *
      * Access operations for a specific index within this bucket
      * Returns a scoped client for vector data operations
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @param indexName - Name of the index
      * @returns Index-scoped client with vector data operations
      *
@@ -255,16 +301,28 @@ class VectorBucketScope extends VectorIndexApi_1.default {
 }
 exports.VectorBucketScope = VectorBucketScope;
 /**
+ *
+ * @alpha
+ *
  * Scoped client for operations within a specific vector index
  * Provides vector data operations (put, get, list, query, delete)
  *
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
  */
 class VectorIndexScope extends VectorDataApi_1.default {
     /**
+     *
+     * @alpha
+     *
      * Creates a helper that automatically scopes all vector operations to the provided bucket/index names.
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
+     *
+     * @category Vector Buckets
+     * @example
+     * ```typescript
+     * const index = client.bucket('embeddings-prod').index('documents-openai')
+     * ```
      */
     constructor(url, headers, vectorBucketName, indexName, fetch) {
         super(url, headers, fetch);
@@ -272,11 +330,15 @@ class VectorIndexScope extends VectorDataApi_1.default {
         this.indexName = indexName;
     }
     /**
+     *
+     * @alpha
+     *
      * Inserts or updates vectors in this index
      * Convenience method that automatically includes bucket and index names
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @param options - Vector insertion options (bucket and index names automatically set)
      * @returns Promise with empty response on success or error
      *
@@ -303,11 +365,15 @@ class VectorIndexScope extends VectorDataApi_1.default {
         });
     }
     /**
+     *
+     * @alpha
+     *
      * Retrieves vectors by keys from this index
      * Convenience method that automatically includes bucket and index names
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @param options - Vector retrieval options (bucket and index names automatically set)
      * @returns Promise with array of vectors or error
      *
@@ -329,11 +395,15 @@ class VectorIndexScope extends VectorDataApi_1.default {
         });
     }
     /**
+     *
+     * @alpha
+     *
      * Lists vectors in this index with pagination
      * Convenience method that automatically includes bucket and index names
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @param options - Listing options (bucket and index names automatically set)
      * @returns Promise with array of vectors and pagination token
      *
@@ -355,11 +425,15 @@ class VectorIndexScope extends VectorDataApi_1.default {
         });
     }
     /**
+     *
+     * @alpha
+     *
      * Queries for similar vectors in this index
      * Convenience method that automatically includes bucket and index names
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @param options - Query options (bucket and index names automatically set)
      * @returns Promise with array of similar vectors ordered by distance
      *
@@ -384,11 +458,15 @@ class VectorIndexScope extends VectorDataApi_1.default {
         });
     }
     /**
+     *
+     * @alpha
+     *
      * Deletes vectors by keys from this index
      * Convenience method that automatically includes bucket and index names
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @param options - Deletion options (bucket and index names automatically set)
      * @returns Promise with empty response on success or error
      *

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

@@ -1 +1 @@
-{"version":3,"file":"StorageVectorsClient.js","sourceRoot":"","sources":["../../../../src/lib/vectors/StorageVectorsClient.ts"],"names":[],"mappings":";;;;AAAA,8EAAqE;AACrE,4EAA2C;AAE3C,gFAA+C;AA2B/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,MAAa,oBAAqB,SAAQ,yBAAe;IACvD;;;;;;;;OAQG;IACH,YAAY,GAAW,EAAE,UAAuC,EAAE;QAChE,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;IAClD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,IAAI,CAAC,gBAAwB;QAC3B,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,EAAE,gBAAgB,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;IACpF,CAAC;CACF;AA1CD,oDA0CC;AAED;;;;;GAKG;AACH,MAAa,iBAAkB,SAAQ,wBAAc;IAGnD;;;;OAIG;IACH,YACE,GAAW,EACX,OAAkC,EAClC,gBAAwB,EACxB,KAAa;QAEb,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;QAC1B,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAA;IAC1C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACY,WAAW,CAAC,OAAqD;;;;;YAC9E,OAAO,OAAM,WAAW,4CACnB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,KACvC;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACY,WAAW;;;;qEAAC,UAAwD,EAAE;YACnF,OAAO,OAAM,WAAW,4CACnB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,KACvC;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACY,QAAQ,CAAC,SAAiB;;;;;YACvC,OAAO,OAAM,QAAQ,YAAC,IAAI,CAAC,gBAAgB,EAAE,SAAS,EAAC;QACzD,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACY,WAAW,CAAC,SAAiB;;;;;YAC1C,OAAO,OAAM,WAAW,YAAC,IAAI,CAAC,gBAAgB,EAAE,SAAS,EAAC;QAC5D,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,CAAC,SAAiB;QACrB,OAAO,IAAI,gBAAgB,CACzB,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,gBAAgB,EACrB,SAAS,EACT,IAAI,CAAC,KAAK,CACX,CAAA;IACH,CAAC;CACF;AAjJD,8CAiJC;AAED;;;;;GAKG;AACH,MAAa,gBAAiB,SAAQ,uBAAa;IAIjD;;;;OAIG;IACH,YACE,GAAW,EACX,OAAkC,EAClC,gBAAwB,EACxB,SAAiB,EACjB,KAAa;QAEb,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;QAC1B,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAA;QACxC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACY,UAAU,CAAC,OAAkE;;;;;YAC1F,OAAO,OAAM,UAAU,4CAClB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EACvC,SAAS,EAAE,IAAI,CAAC,SAAS,KACzB;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;OAiBG;IACY,UAAU,CAAC,OAAkE;;;;;YAC1F,OAAO,OAAM,UAAU,4CAClB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EACvC,SAAS,EAAE,IAAI,CAAC,SAAS,KACzB;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;OAiBG;IACY,WAAW;;;;qEACxB,UAAsE,EAAE;YAExE,OAAO,OAAM,WAAW,4CACnB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EACvC,SAAS,EAAE,IAAI,CAAC,SAAS,KACzB;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACY,YAAY,CACzB,OAAoE;;;;;YAEpE,OAAO,OAAM,YAAY,4CACpB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EACvC,SAAS,EAAE,IAAI,CAAC,SAAS,KACzB;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;OAgBG;IACY,aAAa,CAC1B,OAAqE;;;;;YAErE,OAAO,OAAM,aAAa,4CACrB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EACvC,SAAS,EAAE,IAAI,CAAC,SAAS,KACzB;QACJ,CAAC;KAAA;CACF;AAnKD,4CAmKC"}
+{"version":3,"file":"StorageVectorsClient.js","sourceRoot":"","sources":["../../../../src/lib/vectors/StorageVectorsClient.ts"],"names":[],"mappings":";;;;AAAA,8EAAqE;AACrE,4EAA2C;AAE3C,gFAA+C;AA8B/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2DG;AACH,MAAa,oBAAqB,SAAQ,yBAAe;IACvD;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,GAAW,EAAE,UAAuC,EAAE;QAChE,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;IAClD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,IAAI,CAAC,gBAAwB;QAC3B,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,EAAE,gBAAgB,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;IACpF,CAAC;CACF;AAtDD,oDAsDC;AAED;;;;;;;;GAQG;AACH,MAAa,iBAAkB,SAAQ,wBAAc;IAGnD;;;;;;;;;;;;OAYG;IACH,YACE,GAAW,EACX,OAAkC,EAClC,gBAAwB,EACxB,KAAa;QAEb,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;QAC1B,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAA;IAC1C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACY,WAAW,CAAC,OAAqD;;;;;YAC9E,OAAO,OAAM,WAAW,4CACnB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,KACvC;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACY,WAAW;;;;qEAAC,UAAwD,EAAE;YACnF,OAAO,OAAM,WAAW,4CACnB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,KACvC;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACY,QAAQ,CAAC,SAAiB;;;;;YACvC,OAAO,OAAM,QAAQ,YAAC,IAAI,CAAC,gBAAgB,EAAE,SAAS,EAAC;QACzD,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACY,WAAW,CAAC,SAAiB;;;;;YAC1C,OAAO,OAAM,WAAW,YAAC,IAAI,CAAC,gBAAgB,EAAE,SAAS,EAAC;QAC5D,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,KAAK,CAAC,SAAiB;QACrB,OAAO,IAAI,gBAAgB,CACzB,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,gBAAgB,EACrB,SAAS,EACT,IAAI,CAAC,KAAK,CACX,CAAA;IACH,CAAC;CACF;AA7KD,8CA6KC;AAED;;;;;;;;GAQG;AACH,MAAa,gBAAiB,SAAQ,uBAAa;IAIjD;;;;;;;;;;;;;OAaG;IACH,YACE,GAAW,EACX,OAAkC,EAClC,gBAAwB,EACxB,SAAiB,EACjB,KAAa;QAEb,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;QAC1B,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAA;QACxC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACY,UAAU,CAAC,OAAkE;;;;;YAC1F,OAAO,OAAM,UAAU,4CAClB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EACvC,SAAS,EAAE,IAAI,CAAC,SAAS,KACzB;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACY,UAAU,CAAC,OAAkE;;;;;YAC1F,OAAO,OAAM,UAAU,4CAClB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EACvC,SAAS,EAAE,IAAI,CAAC,SAAS,KACzB;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACY,WAAW;;;;qEACxB,UAAsE,EAAE;YAExE,OAAO,OAAM,WAAW,4CACnB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EACvC,SAAS,EAAE,IAAI,CAAC,SAAS,KACzB;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACY,YAAY,CACzB,OAAoE;;;;;YAEpE,OAAO,OAAM,YAAY,4CACpB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EACvC,SAAS,EAAE,IAAI,CAAC,SAAS,KACzB;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACY,aAAa,CAC1B,OAAqE;;;;;YAErE,OAAO,OAAM,aAAa,4CACrB,OAAO,KACV,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,EACvC,SAAS,EAAE,IAAI,CAAC,SAAS,KACzB;QACJ,CAAC;KAAA;CACF;AAhMD,4CAgMC"}

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

@@ -1,10 +1,13 @@
 import { Fetch } from './fetch';
 import { ApiResponse, VectorBucket, ListVectorBucketsOptions, ListVectorBucketsResponse } from './types';
 /**
+ *
+ * @alpha
+ *
  * API class for managing Vector Buckets
  * Provides methods for creating, reading, listing, and deleting vector buckets
  *
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
  */
 export default class VectorBucketApi {
     protected url: string;
@@ -14,9 +17,14 @@ export default class VectorBucketApi {
     protected fetch: Fetch;
     protected shouldThrowOnError: boolean;
     /**
+     *
+     * @alpha
+     *
      * Creates a new VectorBucketApi instance
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
+     *
+     * @category Vector Buckets
      * @param url - The base URL for the storage vectors API
      * @param headers - HTTP headers to include in requests
      * @param fetch - Optional custom fetch implementation
@@ -30,11 +38,15 @@ export default class VectorBucketApi {
         [key: string]: string;
     }, fetch?: Fetch);
     /**
+     *
+     * @alpha
+     *
      * Enable throwing errors instead of returning them in the response
      * When enabled, failed operations will throw instead of returning { data: null, error }
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @returns This instance for method chaining
      * @example
      * ```typescript
@@ -45,11 +57,15 @@ export default class VectorBucketApi {
      */
     throwOnError(): this;
     /**
+     *
+     * @alpha
+     *
      * Creates a new vector bucket
      * Vector buckets are containers for vector indexes and their data
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @param vectorBucketName - Unique name for the vector bucket
      * @returns Promise with empty response on success or error
      *
@@ -68,11 +84,15 @@ export default class VectorBucketApi {
      */
     createBucket(vectorBucketName: string): Promise<ApiResponse<undefined>>;
     /**
+     *
+     * @alpha
+     *
      * Retrieves metadata for a specific vector bucket
      * Returns bucket configuration including encryption settings and creation time
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @param vectorBucketName - Name of the vector bucket to retrieve
      * @returns Promise with bucket metadata or error
      *
@@ -92,11 +112,15 @@ export default class VectorBucketApi {
         vectorBucket: VectorBucket;
     }>>;
     /**
+     *
+     * @alpha
+     *
      * Lists vector buckets with optional filtering and pagination
      * Supports prefix-based filtering and paginated results
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @param options - Listing options
      * @param options.prefix - Filter buckets by name prefix
      * @param options.maxResults - Maximum results per page (default: 100)
@@ -121,11 +145,15 @@ export default class VectorBucketApi {
      */
     listBuckets(options?: ListVectorBucketsOptions): Promise<ApiResponse<ListVectorBucketsResponse>>;
     /**
+     *
+     * @alpha
+     *
      * Deletes a vector bucket
      * Bucket must be empty before deletion (all indexes must be removed first)
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @param vectorBucketName - Name of the vector bucket to delete
      * @returns Promise with empty response on success or error
      *

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

@@ -1 +1 @@
-{"version":3,"file":"VectorBucketApi.d.ts","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorBucketApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAQ,MAAM,SAAS,CAAA;AAErC,OAAO,EACL,WAAW,EACX,YAAY,EACZ,wBAAwB,EACxB,yBAAyB,EAC1B,MAAM,SAAS,CAAA;AAEhB;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IAClC,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;IAEpC;;;;;;;;;;;;OAYG;gBACS,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAO,EAAE,KAAK,CAAC,EAAE,KAAK;IAM/E;;;;;;;;;;;;;OAaG;IACI,YAAY,IAAI,IAAI;IAK3B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,YAAY,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAoB7E;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,SAAS,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;QAAE,YAAY,EAAE,YAAY,CAAA;KAAE,CAAC,CAAC;IAoB/F;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,WAAW,CACf,OAAO,GAAE,wBAA6B,GACrC,OAAO,CAAC,WAAW,CAAC,yBAAyB,CAAC,CAAC;IAiBlD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,YAAY,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;CAmB9E"}
+{"version":3,"file":"VectorBucketApi.d.ts","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorBucketApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAQ,MAAM,SAAS,CAAA;AAErC,OAAO,EACL,WAAW,EACX,YAAY,EACZ,wBAAwB,EACxB,yBAAyB,EAC1B,MAAM,SAAS,CAAA;AAEhB;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IAClC,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;IAEpC;;;;;;;;;;;;;;;;;OAiBG;gBACS,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAO,EAAE,KAAK,CAAC,EAAE,KAAK;IAM/E;;;;;;;;;;;;;;;;;OAiBG;IACI,YAAY,IAAI,IAAI;IAK3B;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,YAAY,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAoB7E;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,SAAS,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;QAAE,YAAY,EAAE,YAAY,CAAA;KAAE,CAAC,CAAC;IAoB/F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,WAAW,CACf,OAAO,GAAE,wBAA6B,GACrC,OAAO,CAAC,WAAW,CAAC,yBAAyB,CAAC,CAAC;IAiBlD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,YAAY,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;CAmB9E"}

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

@@ -6,16 +6,24 @@ const errors_1 = require("./errors");
 const fetch_1 = require("./fetch");
 const helpers_1 = require("./helpers");
 /**
+ *
+ * @alpha
+ *
  * API class for managing Vector Buckets
  * Provides methods for creating, reading, listing, and deleting vector buckets
  *
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
  */
 class VectorBucketApi {
     /**
+     *
+     * @alpha
+     *
      * Creates a new VectorBucketApi instance
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
+     *
+     * @category Vector Buckets
      * @param url - The base URL for the storage vectors API
      * @param headers - HTTP headers to include in requests
      * @param fetch - Optional custom fetch implementation
@@ -32,11 +40,15 @@ class VectorBucketApi {
         this.fetch = (0, helpers_1.resolveFetch)(fetch);
     }
     /**
+     *
+     * @alpha
+     *
      * Enable throwing errors instead of returning them in the response
      * When enabled, failed operations will throw instead of returning { data: null, error }
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @returns This instance for method chaining
      * @example
      * ```typescript
@@ -50,11 +62,15 @@ class VectorBucketApi {
         return this;
     }
     /**
+     *
+     * @alpha
+     *
      * Creates a new vector bucket
      * Vector buckets are containers for vector indexes and their data
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @param vectorBucketName - Unique name for the vector bucket
      * @returns Promise with empty response on success or error
      *
@@ -89,11 +105,15 @@ class VectorBucketApi {
         });
     }
     /**
+     *
+     * @alpha
+     *
      * Retrieves metadata for a specific vector bucket
      * Returns bucket configuration including encryption settings and creation time
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @param vectorBucketName - Name of the vector bucket to retrieve
      * @returns Promise with bucket metadata or error
      *
@@ -127,11 +147,15 @@ class VectorBucketApi {
         });
     }
     /**
+     *
+     * @alpha
+     *
      * Lists vector buckets with optional filtering and pagination
      * Supports prefix-based filtering and paginated results
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @param options - Listing options
      * @param options.prefix - Filter buckets by name prefix
      * @param options.maxResults - Maximum results per page (default: 100)
@@ -174,11 +198,15 @@ class VectorBucketApi {
         });
     }
     /**
+     *
+     * @alpha
+     *
      * Deletes a vector bucket
      * Bucket must be empty before deletion (all indexes must be removed first)
      *
-     * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
+     * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
      *
+     * @category Vector Buckets
      * @param vectorBucketName - Name of the vector bucket to delete
      * @returns Promise with empty response on success or error
      *

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

@@ -1 +1 @@
-{"version":3,"file":"VectorBucketApi.js","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorBucketApi.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAC7C,qCAAgD;AAChD,mCAAqC;AACrC,uCAAwC;AAQxC;;;;;GAKG;AACH,MAAqB,eAAe;IAMlC;;;;;;;;;;;;OAYG;IACH,YAAY,GAAW,EAAE,UAAqC,EAAE,EAAE,KAAa;QAfrE,uBAAkB,GAAG,KAAK,CAAA;QAgBlC,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;;;;;;;;;;;;;OAaG;IACI,YAAY;QACjB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAA;QAC9B,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,YAAY,CAAC,gBAAwB;;YACzC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EACrB,IAAI,CAAC,KAAK,EACV,GAAG,IAAI,CAAC,GAAG,qBAAqB,EAChC,EAAE,gBAAgB,EAAE,EACpB,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAC1B,CAAA;gBACD,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;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,SAAS,CAAC,gBAAwB;;YACtC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EACrB,IAAI,CAAC,KAAK,EACV,GAAG,IAAI,CAAC,GAAG,kBAAkB,EAC7B,EAAE,gBAAgB,EAAE,EACpB,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAC1B,CAAA;gBACD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,WAAW;qEACf,UAAoC,EAAE;YAEtC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,oBAAoB,EAAE,OAAO,EAAE;oBAC5E,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;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,YAAY,CAAC,gBAAwB;;YACzC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EACrB,IAAI,CAAC,KAAK,EACV,GAAG,IAAI,CAAC,GAAG,qBAAqB,EAChC,EAAE,gBAAgB,EAAE,EACpB,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAC1B,CAAA;gBACD,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;AAxND,kCAwNC"}
+{"version":3,"file":"VectorBucketApi.js","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorBucketApi.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAC7C,qCAAgD;AAChD,mCAAqC;AACrC,uCAAwC;AAQxC;;;;;;;;GAQG;AACH,MAAqB,eAAe;IAMlC;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,GAAW,EAAE,UAAqC,EAAE,EAAE,KAAa;QApBrE,uBAAkB,GAAG,KAAK,CAAA;QAqBlC,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;;;;;;;;;;;;;;;;;OAiBG;IACI,YAAY;QACjB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAA;QAC9B,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,YAAY,CAAC,gBAAwB;;YACzC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EACrB,IAAI,CAAC,KAAK,EACV,GAAG,IAAI,CAAC,GAAG,qBAAqB,EAChC,EAAE,gBAAgB,EAAE,EACpB,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAC1B,CAAA;gBACD,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;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,SAAS,CAAC,gBAAwB;;YACtC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EACrB,IAAI,CAAC,KAAK,EACV,GAAG,IAAI,CAAC,GAAG,kBAAkB,EAC7B,EAAE,gBAAgB,EAAE,EACpB,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAC1B,CAAA;gBACD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,WAAW;qEACf,UAAoC,EAAE;YAEtC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,oBAAoB,EAAE,OAAO,EAAE;oBAC5E,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;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,YAAY,CAAC,gBAAwB;;YACzC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAA,YAAI,EACrB,IAAI,CAAC,KAAK,EACV,GAAG,IAAI,CAAC,GAAG,qBAAqB,EAChC,EAAE,gBAAgB,EAAE,EACpB,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAC1B,CAAA;gBACD,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;AAjPD,kCAiPC"}