@supabase/storage-js 2.81.1 → 2.81.2-canary.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/main/StorageClient.d.ts +15 -0
- package/dist/main/StorageClient.d.ts.map +1 -1
- package/dist/main/StorageClient.js +15 -0
- package/dist/main/StorageClient.js.map +1 -1
- package/dist/main/lib/vectors/StorageVectorsClient.d.ts +49 -0
- package/dist/main/lib/vectors/StorageVectorsClient.d.ts.map +1 -1
- package/dist/main/lib/vectors/StorageVectorsClient.js +47 -0
- package/dist/main/lib/vectors/StorageVectorsClient.js.map +1 -1
- package/dist/main/lib/vectors/VectorBucketApi.d.ts +19 -0
- package/dist/main/lib/vectors/VectorBucketApi.d.ts.map +1 -1
- package/dist/main/lib/vectors/VectorBucketApi.js +19 -0
- package/dist/main/lib/vectors/VectorBucketApi.js.map +1 -1
- package/dist/main/lib/vectors/VectorDataApi.d.ts +23 -0
- package/dist/main/lib/vectors/VectorDataApi.d.ts.map +1 -1
- package/dist/main/lib/vectors/VectorDataApi.js +23 -0
- package/dist/main/lib/vectors/VectorDataApi.js.map +1 -1
- package/dist/main/lib/vectors/VectorIndexApi.d.ts +23 -0
- package/dist/main/lib/vectors/VectorIndexApi.d.ts.map +1 -1
- package/dist/main/lib/vectors/VectorIndexApi.js +21 -0
- package/dist/main/lib/vectors/VectorIndexApi.js.map +1 -1
- package/dist/main/lib/version.d.ts +1 -1
- package/dist/main/lib/version.d.ts.map +1 -1
- package/dist/main/lib/version.js +1 -1
- package/dist/main/lib/version.js.map +1 -1
- package/dist/module/StorageClient.d.ts +15 -0
- package/dist/module/StorageClient.d.ts.map +1 -1
- package/dist/module/StorageClient.js +15 -0
- package/dist/module/StorageClient.js.map +1 -1
- package/dist/module/lib/vectors/StorageVectorsClient.d.ts +49 -0
- package/dist/module/lib/vectors/StorageVectorsClient.d.ts.map +1 -1
- package/dist/module/lib/vectors/StorageVectorsClient.js +47 -0
- package/dist/module/lib/vectors/StorageVectorsClient.js.map +1 -1
- package/dist/module/lib/vectors/VectorBucketApi.d.ts +19 -0
- package/dist/module/lib/vectors/VectorBucketApi.d.ts.map +1 -1
- package/dist/module/lib/vectors/VectorBucketApi.js +19 -0
- package/dist/module/lib/vectors/VectorBucketApi.js.map +1 -1
- package/dist/module/lib/vectors/VectorDataApi.d.ts +23 -0
- package/dist/module/lib/vectors/VectorDataApi.d.ts.map +1 -1
- package/dist/module/lib/vectors/VectorDataApi.js +23 -0
- package/dist/module/lib/vectors/VectorDataApi.js.map +1 -1
- package/dist/module/lib/vectors/VectorIndexApi.d.ts +23 -0
- package/dist/module/lib/vectors/VectorIndexApi.d.ts.map +1 -1
- package/dist/module/lib/vectors/VectorIndexApi.js +21 -0
- package/dist/module/lib/vectors/VectorIndexApi.js.map +1 -1
- package/dist/module/lib/version.d.ts +1 -1
- package/dist/module/lib/version.d.ts.map +1 -1
- package/dist/module/lib/version.js +1 -1
- package/dist/module/lib/version.js.map +1 -1
- package/dist/tsconfig.module.tsbuildinfo +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/dist/umd/supabase.js +1 -1
- package/package.json +1 -1
- package/src/StorageClient.ts +15 -0
- package/src/lib/vectors/StorageVectorsClient.ts +49 -0
- package/src/lib/vectors/VectorBucketApi.ts +20 -3
- package/src/lib/vectors/VectorDataApi.ts +23 -0
- package/src/lib/vectors/VectorIndexApi.ts +23 -0
- package/src/lib/version.ts +1 -1
|
@@ -7,6 +7,19 @@ export interface StorageClientOptions {
|
|
|
7
7
|
useNewHostname?: boolean;
|
|
8
8
|
}
|
|
9
9
|
export declare class StorageClient extends StorageBucketApi {
|
|
10
|
+
/**
|
|
11
|
+
* Creates a client for Storage buckets, files, analytics, and vectors.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* import { StorageClient } from '@supabase/storage-js'
|
|
16
|
+
*
|
|
17
|
+
* const storage = new StorageClient('https://xyzcompany.supabase.co/storage/v1', {
|
|
18
|
+
* apikey: 'public-anon-key',
|
|
19
|
+
* })
|
|
20
|
+
* const avatars = storage.from('avatars')
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
10
23
|
constructor(url: string, headers?: {
|
|
11
24
|
[key: string]: string;
|
|
12
25
|
}, fetch?: Fetch, opts?: StorageClientOptions);
|
|
@@ -19,6 +32,8 @@ export declare class StorageClient extends StorageBucketApi {
|
|
|
19
32
|
/**
|
|
20
33
|
* Access vector storage operations.
|
|
21
34
|
*
|
|
35
|
+
* **Private alpha:** This API is part of a private alpha release and may change or be removed without notice.
|
|
36
|
+
*
|
|
22
37
|
* @returns A StorageVectorsClient instance configured with the current storage settings.
|
|
23
38
|
*/
|
|
24
39
|
get vectors(): StorageVectorsClient;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"StorageClient.d.ts","sourceRoot":"","sources":["../../src/StorageClient.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,2BAA2B,CAAA;AACtD,OAAO,gBAAgB,MAAM,6BAA6B,CAAA;AAC1D,OAAO,mBAAmB,MAAM,gCAAgC,CAAA;AAChE,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACnC,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAA;AAEpD,MAAM,WAAW,oBAAoB;IACnC,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,qBAAa,aAAc,SAAQ,gBAAgB;
|
|
1
|
+
{"version":3,"file":"StorageClient.d.ts","sourceRoot":"","sources":["../../src/StorageClient.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,2BAA2B,CAAA;AACtD,OAAO,gBAAgB,MAAM,6BAA6B,CAAA;AAC1D,OAAO,mBAAmB,MAAM,gCAAgC,CAAA;AAChE,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACnC,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAA;AAEpD,MAAM,WAAW,oBAAoB;IACnC,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,qBAAa,aAAc,SAAQ,gBAAgB;IACjD;;;;;;;;;;;;OAYG;gBAED,GAAG,EAAE,MAAM,EACX,OAAO,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAO,EACvC,KAAK,CAAC,EAAE,KAAK,EACb,IAAI,CAAC,EAAE,oBAAoB;IAK7B;;;;OAIG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc;IAIhC;;;;;;OAMG;IACH,IAAI,OAAO,IAAI,oBAAoB,CAKlC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,SAAS,IAAI,mBAAmB,CAEnC;CACF"}
|
|
@@ -7,6 +7,19 @@ const StorageBucketApi_1 = tslib_1.__importDefault(require("./packages/StorageBu
|
|
|
7
7
|
const StorageAnalyticsApi_1 = tslib_1.__importDefault(require("./packages/StorageAnalyticsApi"));
|
|
8
8
|
const vectors_1 = require("./lib/vectors");
|
|
9
9
|
class StorageClient extends StorageBucketApi_1.default {
|
|
10
|
+
/**
|
|
11
|
+
* Creates a client for Storage buckets, files, analytics, and vectors.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* import { StorageClient } from '@supabase/storage-js'
|
|
16
|
+
*
|
|
17
|
+
* const storage = new StorageClient('https://xyzcompany.supabase.co/storage/v1', {
|
|
18
|
+
* apikey: 'public-anon-key',
|
|
19
|
+
* })
|
|
20
|
+
* const avatars = storage.from('avatars')
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
10
23
|
constructor(url, headers = {}, fetch, opts) {
|
|
11
24
|
super(url, headers, fetch, opts);
|
|
12
25
|
}
|
|
@@ -21,6 +34,8 @@ class StorageClient extends StorageBucketApi_1.default {
|
|
|
21
34
|
/**
|
|
22
35
|
* Access vector storage operations.
|
|
23
36
|
*
|
|
37
|
+
* **Private alpha:** This API is part of a private alpha release and may change or be removed without notice.
|
|
38
|
+
*
|
|
24
39
|
* @returns A StorageVectorsClient instance configured with the current storage settings.
|
|
25
40
|
*/
|
|
26
41
|
get vectors() {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"StorageClient.js","sourceRoot":"","sources":["../../src/StorageClient.ts"],"names":[],"mappings":";;;;AAAA,uFAAsD;AACtD,2FAA0D;AAC1D,iGAAgE;AAEhE,2CAAoD;AAMpD,MAAa,aAAc,SAAQ,0BAAgB;IACjD,YACE,GAAW,EACX,UAAqC,EAAE,EACvC,KAAa,EACb,IAA2B;QAE3B,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;IAClC,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,EAAU;QACb,OAAO,IAAI,wBAAc,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;IACnE,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"StorageClient.js","sourceRoot":"","sources":["../../src/StorageClient.ts"],"names":[],"mappings":";;;;AAAA,uFAAsD;AACtD,2FAA0D;AAC1D,iGAAgE;AAEhE,2CAAoD;AAMpD,MAAa,aAAc,SAAQ,0BAAgB;IACjD;;;;;;;;;;;;OAYG;IACH,YACE,GAAW,EACX,UAAqC,EAAE,EACvC,KAAa,EACb,IAA2B;QAE3B,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;IAClC,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,EAAU;QACb,OAAO,IAAI,wBAAc,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;IACnE,CAAC;IAED;;;;;;OAMG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,8BAAoB,CAAC,IAAI,CAAC,GAAG,GAAG,SAAS,EAAE;YACpD,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,6BAAmB,CAAC,IAAI,CAAC,GAAG,GAAG,UAAU,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;IACjF,CAAC;CACF;AApED,sCAoEC"}
|
|
@@ -5,6 +5,8 @@ import VectorBucketApi from './VectorBucketApi';
|
|
|
5
5
|
import { DeleteVectorsOptions, GetVectorsOptions, ListIndexesOptions, ListVectorsOptions, PutVectorsOptions, QueryVectorsOptions } from './types';
|
|
6
6
|
/**
|
|
7
7
|
* Configuration options for the Storage Vectors client
|
|
8
|
+
*
|
|
9
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
8
10
|
*/
|
|
9
11
|
export interface StorageVectorsClientOptions {
|
|
10
12
|
/**
|
|
@@ -23,6 +25,8 @@ export interface StorageVectorsClientOptions {
|
|
|
23
25
|
* Main client for interacting with S3 Vectors API
|
|
24
26
|
* Provides access to bucket, index, and vector data operations
|
|
25
27
|
*
|
|
28
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
29
|
+
*
|
|
26
30
|
* **Usage Patterns:**
|
|
27
31
|
*
|
|
28
32
|
* 1. **Via StorageClient (recommended for most use cases):**
|
|
@@ -75,11 +79,22 @@ export interface StorageVectorsClientOptions {
|
|
|
75
79
|
* ```
|
|
76
80
|
*/
|
|
77
81
|
export declare class StorageVectorsClient extends VectorBucketApi {
|
|
82
|
+
/**
|
|
83
|
+
* Creates a StorageVectorsClient that can manage buckets, indexes, and vectors.
|
|
84
|
+
*
|
|
85
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
86
|
+
*
|
|
87
|
+
* @param url - Base URL of the Storage Vectors REST API.
|
|
88
|
+
* @param options.headers - Optional headers (for example `Authorization`) applied to every request.
|
|
89
|
+
* @param options.fetch - Optional custom `fetch` implementation for non-browser runtimes.
|
|
90
|
+
*/
|
|
78
91
|
constructor(url: string, options?: StorageVectorsClientOptions);
|
|
79
92
|
/**
|
|
80
93
|
* Access operations for a specific vector bucket
|
|
81
94
|
* Returns a scoped client for index and vector operations within the bucket
|
|
82
95
|
*
|
|
96
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
97
|
+
*
|
|
83
98
|
* @param vectorBucketName - Name of the vector bucket
|
|
84
99
|
* @returns Bucket-scoped client with index and vector operations
|
|
85
100
|
*
|
|
@@ -104,9 +119,16 @@ export declare class StorageVectorsClient extends VectorBucketApi {
|
|
|
104
119
|
/**
|
|
105
120
|
* Scoped client for operations within a specific vector bucket
|
|
106
121
|
* Provides index management and access to vector operations
|
|
122
|
+
*
|
|
123
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
107
124
|
*/
|
|
108
125
|
export declare class VectorBucketScope extends VectorIndexApi {
|
|
109
126
|
private vectorBucketName;
|
|
127
|
+
/**
|
|
128
|
+
* Creates a helper that automatically scopes all index operations to the provided bucket.
|
|
129
|
+
*
|
|
130
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
131
|
+
*/
|
|
110
132
|
constructor(url: string, headers: {
|
|
111
133
|
[key: string]: string;
|
|
112
134
|
}, vectorBucketName: string, fetch?: Fetch);
|
|
@@ -114,6 +136,8 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
114
136
|
* Creates a new vector index in this bucket
|
|
115
137
|
* Convenience method that automatically includes the bucket name
|
|
116
138
|
*
|
|
139
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
140
|
+
*
|
|
117
141
|
* @param options - Index configuration (vectorBucketName is automatically set)
|
|
118
142
|
* @returns Promise with empty response on success or error
|
|
119
143
|
*
|
|
@@ -136,6 +160,8 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
136
160
|
* Lists indexes in this bucket
|
|
137
161
|
* Convenience method that automatically includes the bucket name
|
|
138
162
|
*
|
|
163
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
164
|
+
*
|
|
139
165
|
* @param options - Listing options (vectorBucketName is automatically set)
|
|
140
166
|
* @returns Promise with list of indexes or error
|
|
141
167
|
*
|
|
@@ -150,6 +176,8 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
150
176
|
* Retrieves metadata for a specific index in this bucket
|
|
151
177
|
* Convenience method that automatically includes the bucket name
|
|
152
178
|
*
|
|
179
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
180
|
+
*
|
|
153
181
|
* @param indexName - Name of the index to retrieve
|
|
154
182
|
* @returns Promise with index metadata or error
|
|
155
183
|
*
|
|
@@ -167,6 +195,8 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
167
195
|
* Deletes an index from this bucket
|
|
168
196
|
* Convenience method that automatically includes the bucket name
|
|
169
197
|
*
|
|
198
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
199
|
+
*
|
|
170
200
|
* @param indexName - Name of the index to delete
|
|
171
201
|
* @returns Promise with empty response on success or error
|
|
172
202
|
*
|
|
@@ -181,6 +211,8 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
181
211
|
* Access operations for a specific index within this bucket
|
|
182
212
|
* Returns a scoped client for vector data operations
|
|
183
213
|
*
|
|
214
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
215
|
+
*
|
|
184
216
|
* @param indexName - Name of the index
|
|
185
217
|
* @returns Index-scoped client with vector data operations
|
|
186
218
|
*
|
|
@@ -207,10 +239,17 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
207
239
|
/**
|
|
208
240
|
* Scoped client for operations within a specific vector index
|
|
209
241
|
* Provides vector data operations (put, get, list, query, delete)
|
|
242
|
+
*
|
|
243
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
210
244
|
*/
|
|
211
245
|
export declare class VectorIndexScope extends VectorDataApi {
|
|
212
246
|
private vectorBucketName;
|
|
213
247
|
private indexName;
|
|
248
|
+
/**
|
|
249
|
+
* Creates a helper that automatically scopes all vector operations to the provided bucket/index names.
|
|
250
|
+
*
|
|
251
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
252
|
+
*/
|
|
214
253
|
constructor(url: string, headers: {
|
|
215
254
|
[key: string]: string;
|
|
216
255
|
}, vectorBucketName: string, indexName: string, fetch?: Fetch);
|
|
@@ -218,6 +257,8 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
218
257
|
* Inserts or updates vectors in this index
|
|
219
258
|
* Convenience method that automatically includes bucket and index names
|
|
220
259
|
*
|
|
260
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
261
|
+
*
|
|
221
262
|
* @param options - Vector insertion options (bucket and index names automatically set)
|
|
222
263
|
* @returns Promise with empty response on success or error
|
|
223
264
|
*
|
|
@@ -240,6 +281,8 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
240
281
|
* Retrieves vectors by keys from this index
|
|
241
282
|
* Convenience method that automatically includes bucket and index names
|
|
242
283
|
*
|
|
284
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
285
|
+
*
|
|
243
286
|
* @param options - Vector retrieval options (bucket and index names automatically set)
|
|
244
287
|
* @returns Promise with array of vectors or error
|
|
245
288
|
*
|
|
@@ -257,6 +300,8 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
257
300
|
* Lists vectors in this index with pagination
|
|
258
301
|
* Convenience method that automatically includes bucket and index names
|
|
259
302
|
*
|
|
303
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
304
|
+
*
|
|
260
305
|
* @param options - Listing options (bucket and index names automatically set)
|
|
261
306
|
* @returns Promise with array of vectors and pagination token
|
|
262
307
|
*
|
|
@@ -274,6 +319,8 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
274
319
|
* Queries for similar vectors in this index
|
|
275
320
|
* Convenience method that automatically includes bucket and index names
|
|
276
321
|
*
|
|
322
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
323
|
+
*
|
|
277
324
|
* @param options - Query options (bucket and index names automatically set)
|
|
278
325
|
* @returns Promise with array of similar vectors ordered by distance
|
|
279
326
|
*
|
|
@@ -294,6 +341,8 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
294
341
|
* Deletes vectors by keys from this index
|
|
295
342
|
* Convenience method that automatically includes bucket and index names
|
|
296
343
|
*
|
|
344
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
345
|
+
*
|
|
297
346
|
* @param options - Deletion options (bucket and index names automatically set)
|
|
298
347
|
* @returns Promise with empty response on success or error
|
|
299
348
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"StorageVectorsClient.d.ts","sourceRoot":"","sources":["../../../../src/lib/vectors/StorageVectorsClient.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,EAAE,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAA;AACrE,OAAO,aAAa,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAC/B,OAAO,eAAe,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,SAAS,CAAA;AAEhB
|
|
1
|
+
{"version":3,"file":"StorageVectorsClient.d.ts","sourceRoot":"","sources":["../../../../src/lib/vectors/StorageVectorsClient.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,EAAE,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAA;AACrE,OAAO,aAAa,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAC/B,OAAO,eAAe,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,SAAS,CAAA;AAEhB;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACnC;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;CACd;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,qBAAa,oBAAqB,SAAQ,eAAe;IACvD;;;;;;;;OAQG;gBACS,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,2BAAgC;IAIlE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,IAAI,CAAC,gBAAgB,EAAE,MAAM,GAAG,iBAAiB;CAGlD;AAED;;;;;GAKG;AACH,qBAAa,iBAAkB,SAAQ,cAAc;IACnD,OAAO,CAAC,gBAAgB,CAAQ;IAEhC;;;;OAIG;gBAED,GAAG,EAAE,MAAM,EACX,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,EAClC,gBAAgB,EAAE,MAAM,EACxB,KAAK,CAAC,EAAE,KAAK;IAMf;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACY,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAOhF;;;;;;;;;;;;;;OAcG;IACY,WAAW,CAAC,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,kBAAkB,CAAM;IAOrF;;;;;;;;;;;;;;;OAeG;IACY,QAAQ,CAAC,SAAS,EAAE,MAAM;;;IAIzC;;;;;;;;;;;;;;OAcG;IACY,WAAW,CAAC,SAAS,EAAE,MAAM;IAI5C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB;CAS3C;AAED;;;;;GAKG;AACH,qBAAa,gBAAiB,SAAQ,aAAa;IACjD,OAAO,CAAC,gBAAgB,CAAQ;IAChC,OAAO,CAAC,SAAS,CAAQ;IAEzB;;;;OAIG;gBAED,GAAG,EAAE,MAAM,EACX,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,EAClC,gBAAgB,EAAE,MAAM,EACxB,SAAS,EAAE,MAAM,EACjB,KAAK,CAAC,EAAE,KAAK;IAOf;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACY,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,kBAAkB,GAAG,WAAW,CAAC;IAQ5F;;;;;;;;;;;;;;;;;OAiBG;IACY,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,kBAAkB,GAAG,WAAW,CAAC;IAQ5F;;;;;;;;;;;;;;;;;OAiBG;IACY,WAAW,CACxB,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,WAAW,CAAM;IAS1E;;;;;;;;;;;;;;;;;;;;OAoBG;IACY,YAAY,CACzB,OAAO,EAAE,IAAI,CAAC,mBAAmB,EAAE,kBAAkB,GAAG,WAAW,CAAC;IAStE;;;;;;;;;;;;;;;;OAgBG;IACY,aAAa,CAC1B,OAAO,EAAE,IAAI,CAAC,oBAAoB,EAAE,kBAAkB,GAAG,WAAW,CAAC;CAQxE"}
|
|
@@ -9,6 +9,8 @@ const VectorBucketApi_1 = tslib_1.__importDefault(require("./VectorBucketApi"));
|
|
|
9
9
|
* Main client for interacting with S3 Vectors API
|
|
10
10
|
* Provides access to bucket, index, and vector data operations
|
|
11
11
|
*
|
|
12
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
13
|
+
*
|
|
12
14
|
* **Usage Patterns:**
|
|
13
15
|
*
|
|
14
16
|
* 1. **Via StorageClient (recommended for most use cases):**
|
|
@@ -61,6 +63,15 @@ const VectorBucketApi_1 = tslib_1.__importDefault(require("./VectorBucketApi"));
|
|
|
61
63
|
* ```
|
|
62
64
|
*/
|
|
63
65
|
class StorageVectorsClient extends VectorBucketApi_1.default {
|
|
66
|
+
/**
|
|
67
|
+
* Creates a StorageVectorsClient that can manage buckets, indexes, and vectors.
|
|
68
|
+
*
|
|
69
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
70
|
+
*
|
|
71
|
+
* @param url - Base URL of the Storage Vectors REST API.
|
|
72
|
+
* @param options.headers - Optional headers (for example `Authorization`) applied to every request.
|
|
73
|
+
* @param options.fetch - Optional custom `fetch` implementation for non-browser runtimes.
|
|
74
|
+
*/
|
|
64
75
|
constructor(url, options = {}) {
|
|
65
76
|
super(url, options.headers || {}, options.fetch);
|
|
66
77
|
}
|
|
@@ -68,6 +79,8 @@ class StorageVectorsClient extends VectorBucketApi_1.default {
|
|
|
68
79
|
* Access operations for a specific vector bucket
|
|
69
80
|
* Returns a scoped client for index and vector operations within the bucket
|
|
70
81
|
*
|
|
82
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
83
|
+
*
|
|
71
84
|
* @param vectorBucketName - Name of the vector bucket
|
|
72
85
|
* @returns Bucket-scoped client with index and vector operations
|
|
73
86
|
*
|
|
@@ -95,8 +108,15 @@ exports.StorageVectorsClient = StorageVectorsClient;
|
|
|
95
108
|
/**
|
|
96
109
|
* Scoped client for operations within a specific vector bucket
|
|
97
110
|
* Provides index management and access to vector operations
|
|
111
|
+
*
|
|
112
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
98
113
|
*/
|
|
99
114
|
class VectorBucketScope extends VectorIndexApi_1.default {
|
|
115
|
+
/**
|
|
116
|
+
* Creates a helper that automatically scopes all index operations to the provided bucket.
|
|
117
|
+
*
|
|
118
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
119
|
+
*/
|
|
100
120
|
constructor(url, headers, vectorBucketName, fetch) {
|
|
101
121
|
super(url, headers, fetch);
|
|
102
122
|
this.vectorBucketName = vectorBucketName;
|
|
@@ -105,6 +125,8 @@ class VectorBucketScope extends VectorIndexApi_1.default {
|
|
|
105
125
|
* Creates a new vector index in this bucket
|
|
106
126
|
* Convenience method that automatically includes the bucket name
|
|
107
127
|
*
|
|
128
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
129
|
+
*
|
|
108
130
|
* @param options - Index configuration (vectorBucketName is automatically set)
|
|
109
131
|
* @returns Promise with empty response on success or error
|
|
110
132
|
*
|
|
@@ -134,6 +156,8 @@ class VectorBucketScope extends VectorIndexApi_1.default {
|
|
|
134
156
|
* Lists indexes in this bucket
|
|
135
157
|
* Convenience method that automatically includes the bucket name
|
|
136
158
|
*
|
|
159
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
160
|
+
*
|
|
137
161
|
* @param options - Listing options (vectorBucketName is automatically set)
|
|
138
162
|
* @returns Promise with list of indexes or error
|
|
139
163
|
*
|
|
@@ -155,6 +179,8 @@ class VectorBucketScope extends VectorIndexApi_1.default {
|
|
|
155
179
|
* Retrieves metadata for a specific index in this bucket
|
|
156
180
|
* Convenience method that automatically includes the bucket name
|
|
157
181
|
*
|
|
182
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
183
|
+
*
|
|
158
184
|
* @param indexName - Name of the index to retrieve
|
|
159
185
|
* @returns Promise with index metadata or error
|
|
160
186
|
*
|
|
@@ -177,6 +203,8 @@ class VectorBucketScope extends VectorIndexApi_1.default {
|
|
|
177
203
|
* Deletes an index from this bucket
|
|
178
204
|
* Convenience method that automatically includes the bucket name
|
|
179
205
|
*
|
|
206
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
207
|
+
*
|
|
180
208
|
* @param indexName - Name of the index to delete
|
|
181
209
|
* @returns Promise with empty response on success or error
|
|
182
210
|
*
|
|
@@ -198,6 +226,8 @@ class VectorBucketScope extends VectorIndexApi_1.default {
|
|
|
198
226
|
* Access operations for a specific index within this bucket
|
|
199
227
|
* Returns a scoped client for vector data operations
|
|
200
228
|
*
|
|
229
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
230
|
+
*
|
|
201
231
|
* @param indexName - Name of the index
|
|
202
232
|
* @returns Index-scoped client with vector data operations
|
|
203
233
|
*
|
|
@@ -227,8 +257,15 @@ exports.VectorBucketScope = VectorBucketScope;
|
|
|
227
257
|
/**
|
|
228
258
|
* Scoped client for operations within a specific vector index
|
|
229
259
|
* Provides vector data operations (put, get, list, query, delete)
|
|
260
|
+
*
|
|
261
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
230
262
|
*/
|
|
231
263
|
class VectorIndexScope extends VectorDataApi_1.default {
|
|
264
|
+
/**
|
|
265
|
+
* Creates a helper that automatically scopes all vector operations to the provided bucket/index names.
|
|
266
|
+
*
|
|
267
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
268
|
+
*/
|
|
232
269
|
constructor(url, headers, vectorBucketName, indexName, fetch) {
|
|
233
270
|
super(url, headers, fetch);
|
|
234
271
|
this.vectorBucketName = vectorBucketName;
|
|
@@ -238,6 +275,8 @@ class VectorIndexScope extends VectorDataApi_1.default {
|
|
|
238
275
|
* Inserts or updates vectors in this index
|
|
239
276
|
* Convenience method that automatically includes bucket and index names
|
|
240
277
|
*
|
|
278
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
279
|
+
*
|
|
241
280
|
* @param options - Vector insertion options (bucket and index names automatically set)
|
|
242
281
|
* @returns Promise with empty response on success or error
|
|
243
282
|
*
|
|
@@ -267,6 +306,8 @@ class VectorIndexScope extends VectorDataApi_1.default {
|
|
|
267
306
|
* Retrieves vectors by keys from this index
|
|
268
307
|
* Convenience method that automatically includes bucket and index names
|
|
269
308
|
*
|
|
309
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
310
|
+
*
|
|
270
311
|
* @param options - Vector retrieval options (bucket and index names automatically set)
|
|
271
312
|
* @returns Promise with array of vectors or error
|
|
272
313
|
*
|
|
@@ -291,6 +332,8 @@ class VectorIndexScope extends VectorDataApi_1.default {
|
|
|
291
332
|
* Lists vectors in this index with pagination
|
|
292
333
|
* Convenience method that automatically includes bucket and index names
|
|
293
334
|
*
|
|
335
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
336
|
+
*
|
|
294
337
|
* @param options - Listing options (bucket and index names automatically set)
|
|
295
338
|
* @returns Promise with array of vectors and pagination token
|
|
296
339
|
*
|
|
@@ -315,6 +358,8 @@ class VectorIndexScope extends VectorDataApi_1.default {
|
|
|
315
358
|
* Queries for similar vectors in this index
|
|
316
359
|
* Convenience method that automatically includes bucket and index names
|
|
317
360
|
*
|
|
361
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
362
|
+
*
|
|
318
363
|
* @param options - Query options (bucket and index names automatically set)
|
|
319
364
|
* @returns Promise with array of similar vectors ordered by distance
|
|
320
365
|
*
|
|
@@ -342,6 +387,8 @@ class VectorIndexScope extends VectorDataApi_1.default {
|
|
|
342
387
|
* Deletes vectors by keys from this index
|
|
343
388
|
* Convenience method that automatically includes bucket and index names
|
|
344
389
|
*
|
|
390
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
391
|
+
*
|
|
345
392
|
* @param options - Deletion options (bucket and index names automatically set)
|
|
346
393
|
* @returns Promise with empty response on success or error
|
|
347
394
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"StorageVectorsClient.js","sourceRoot":"","sources":["../../../../src/lib/vectors/StorageVectorsClient.ts"],"names":[],"mappings":";;;;AAAA,8EAAqE;AACrE,4EAA2C;AAE3C,gFAA+C;
|
|
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"}
|
|
@@ -3,6 +3,8 @@ import { ApiResponse, VectorBucket, ListVectorBucketsOptions, ListVectorBucketsR
|
|
|
3
3
|
/**
|
|
4
4
|
* API class for managing Vector Buckets
|
|
5
5
|
* Provides methods for creating, reading, listing, and deleting vector buckets
|
|
6
|
+
*
|
|
7
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
6
8
|
*/
|
|
7
9
|
export default class VectorBucketApi {
|
|
8
10
|
protected url: string;
|
|
@@ -13,9 +15,16 @@ export default class VectorBucketApi {
|
|
|
13
15
|
protected shouldThrowOnError: boolean;
|
|
14
16
|
/**
|
|
15
17
|
* Creates a new VectorBucketApi instance
|
|
18
|
+
*
|
|
19
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
16
20
|
* @param url - The base URL for the storage vectors API
|
|
17
21
|
* @param headers - HTTP headers to include in requests
|
|
18
22
|
* @param fetch - Optional custom fetch implementation
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```typescript
|
|
26
|
+
* const client = new VectorBucketApi(url, headers)
|
|
27
|
+
* ```
|
|
19
28
|
*/
|
|
20
29
|
constructor(url: string, headers?: {
|
|
21
30
|
[key: string]: string;
|
|
@@ -24,6 +33,8 @@ export default class VectorBucketApi {
|
|
|
24
33
|
* Enable throwing errors instead of returning them in the response
|
|
25
34
|
* When enabled, failed operations will throw instead of returning { data: null, error }
|
|
26
35
|
*
|
|
36
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
37
|
+
*
|
|
27
38
|
* @returns This instance for method chaining
|
|
28
39
|
* @example
|
|
29
40
|
* ```typescript
|
|
@@ -37,6 +48,8 @@ export default class VectorBucketApi {
|
|
|
37
48
|
* Creates a new vector bucket
|
|
38
49
|
* Vector buckets are containers for vector indexes and their data
|
|
39
50
|
*
|
|
51
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
52
|
+
*
|
|
40
53
|
* @param vectorBucketName - Unique name for the vector bucket
|
|
41
54
|
* @returns Promise with empty response on success or error
|
|
42
55
|
*
|
|
@@ -58,6 +71,8 @@ export default class VectorBucketApi {
|
|
|
58
71
|
* Retrieves metadata for a specific vector bucket
|
|
59
72
|
* Returns bucket configuration including encryption settings and creation time
|
|
60
73
|
*
|
|
74
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
75
|
+
*
|
|
61
76
|
* @param vectorBucketName - Name of the vector bucket to retrieve
|
|
62
77
|
* @returns Promise with bucket metadata or error
|
|
63
78
|
*
|
|
@@ -80,6 +95,8 @@ export default class VectorBucketApi {
|
|
|
80
95
|
* Lists vector buckets with optional filtering and pagination
|
|
81
96
|
* Supports prefix-based filtering and paginated results
|
|
82
97
|
*
|
|
98
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
99
|
+
*
|
|
83
100
|
* @param options - Listing options
|
|
84
101
|
* @param options.prefix - Filter buckets by name prefix
|
|
85
102
|
* @param options.maxResults - Maximum results per page (default: 100)
|
|
@@ -107,6 +124,8 @@ export default class VectorBucketApi {
|
|
|
107
124
|
* Deletes a vector bucket
|
|
108
125
|
* Bucket must be empty before deletion (all indexes must be removed first)
|
|
109
126
|
*
|
|
127
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
128
|
+
*
|
|
110
129
|
* @param vectorBucketName - Name of the vector bucket to delete
|
|
111
130
|
* @returns Promise with empty response on success or error
|
|
112
131
|
*
|
|
@@ -1 +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
|
|
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"}
|
|
@@ -8,13 +8,22 @@ const helpers_1 = require("./helpers");
|
|
|
8
8
|
/**
|
|
9
9
|
* API class for managing Vector Buckets
|
|
10
10
|
* Provides methods for creating, reading, listing, and deleting vector buckets
|
|
11
|
+
*
|
|
12
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
11
13
|
*/
|
|
12
14
|
class VectorBucketApi {
|
|
13
15
|
/**
|
|
14
16
|
* Creates a new VectorBucketApi instance
|
|
17
|
+
*
|
|
18
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
15
19
|
* @param url - The base URL for the storage vectors API
|
|
16
20
|
* @param headers - HTTP headers to include in requests
|
|
17
21
|
* @param fetch - Optional custom fetch implementation
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```typescript
|
|
25
|
+
* const client = new VectorBucketApi(url, headers)
|
|
26
|
+
* ```
|
|
18
27
|
*/
|
|
19
28
|
constructor(url, headers = {}, fetch) {
|
|
20
29
|
this.shouldThrowOnError = false;
|
|
@@ -26,6 +35,8 @@ class VectorBucketApi {
|
|
|
26
35
|
* Enable throwing errors instead of returning them in the response
|
|
27
36
|
* When enabled, failed operations will throw instead of returning { data: null, error }
|
|
28
37
|
*
|
|
38
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
39
|
+
*
|
|
29
40
|
* @returns This instance for method chaining
|
|
30
41
|
* @example
|
|
31
42
|
* ```typescript
|
|
@@ -42,6 +53,8 @@ class VectorBucketApi {
|
|
|
42
53
|
* Creates a new vector bucket
|
|
43
54
|
* Vector buckets are containers for vector indexes and their data
|
|
44
55
|
*
|
|
56
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
57
|
+
*
|
|
45
58
|
* @param vectorBucketName - Unique name for the vector bucket
|
|
46
59
|
* @returns Promise with empty response on success or error
|
|
47
60
|
*
|
|
@@ -79,6 +92,8 @@ class VectorBucketApi {
|
|
|
79
92
|
* Retrieves metadata for a specific vector bucket
|
|
80
93
|
* Returns bucket configuration including encryption settings and creation time
|
|
81
94
|
*
|
|
95
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
96
|
+
*
|
|
82
97
|
* @param vectorBucketName - Name of the vector bucket to retrieve
|
|
83
98
|
* @returns Promise with bucket metadata or error
|
|
84
99
|
*
|
|
@@ -115,6 +130,8 @@ class VectorBucketApi {
|
|
|
115
130
|
* Lists vector buckets with optional filtering and pagination
|
|
116
131
|
* Supports prefix-based filtering and paginated results
|
|
117
132
|
*
|
|
133
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
134
|
+
*
|
|
118
135
|
* @param options - Listing options
|
|
119
136
|
* @param options.prefix - Filter buckets by name prefix
|
|
120
137
|
* @param options.maxResults - Maximum results per page (default: 100)
|
|
@@ -160,6 +177,8 @@ class VectorBucketApi {
|
|
|
160
177
|
* Deletes a vector bucket
|
|
161
178
|
* Bucket must be empty before deletion (all indexes must be removed first)
|
|
162
179
|
*
|
|
180
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
181
|
+
*
|
|
163
182
|
* @param vectorBucketName - Name of the vector bucket to delete
|
|
164
183
|
* @returns Promise with empty response on success or error
|
|
165
184
|
*
|
|
@@ -1 +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
|
|
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"}
|
|
@@ -3,6 +3,8 @@ import { ApiResponse, PutVectorsOptions, GetVectorsOptions, GetVectorsResponse,
|
|
|
3
3
|
/**
|
|
4
4
|
* API class for managing Vector Data within Vector Indexes
|
|
5
5
|
* Provides methods for inserting, querying, listing, and deleting vector embeddings
|
|
6
|
+
*
|
|
7
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
6
8
|
*/
|
|
7
9
|
export default class VectorDataApi {
|
|
8
10
|
protected url: string;
|
|
@@ -11,6 +13,15 @@ export default class VectorDataApi {
|
|
|
11
13
|
};
|
|
12
14
|
protected fetch: Fetch;
|
|
13
15
|
protected shouldThrowOnError: boolean;
|
|
16
|
+
/**
|
|
17
|
+
* Creates a VectorDataApi bound to a Storage Vectors deployment.
|
|
18
|
+
*
|
|
19
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
20
|
+
*
|
|
21
|
+
* @param url - Base URL for the Storage Vectors API.
|
|
22
|
+
* @param headers - Default headers (for example authentication tokens).
|
|
23
|
+
* @param fetch - Optional custom `fetch` implementation for non-browser runtimes.
|
|
24
|
+
*/
|
|
14
25
|
constructor(url: string, headers?: {
|
|
15
26
|
[key: string]: string;
|
|
16
27
|
}, fetch?: Fetch);
|
|
@@ -18,6 +29,8 @@ export default class VectorDataApi {
|
|
|
18
29
|
* Enable throwing errors instead of returning them in the response
|
|
19
30
|
* When enabled, failed operations will throw instead of returning { data: null, error }
|
|
20
31
|
*
|
|
32
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
33
|
+
*
|
|
21
34
|
* @returns This instance for method chaining
|
|
22
35
|
* @example
|
|
23
36
|
* ```typescript
|
|
@@ -31,6 +44,8 @@ export default class VectorDataApi {
|
|
|
31
44
|
* Inserts or updates vectors in batch (upsert operation)
|
|
32
45
|
* Accepts 1-500 vectors per request. Larger batches should be split
|
|
33
46
|
*
|
|
47
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
48
|
+
*
|
|
34
49
|
* @param options - Vector insertion options
|
|
35
50
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
36
51
|
* @param options.indexName - Name of the target index
|
|
@@ -68,6 +83,8 @@ export default class VectorDataApi {
|
|
|
68
83
|
* Optionally includes vector data and/or metadata in response
|
|
69
84
|
* Additional permissions required when returning data or metadata
|
|
70
85
|
*
|
|
86
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
87
|
+
*
|
|
71
88
|
* @param options - Vector retrieval options
|
|
72
89
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
73
90
|
* @param options.indexName - Name of the index
|
|
@@ -100,6 +117,8 @@ export default class VectorDataApi {
|
|
|
100
117
|
* Supports parallel scanning via segment configuration for high-throughput scenarios
|
|
101
118
|
* Additional permissions required when returning data or metadata
|
|
102
119
|
*
|
|
120
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
121
|
+
*
|
|
103
122
|
* @param options - Vector listing options
|
|
104
123
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
105
124
|
* @param options.indexName - Name of the index
|
|
@@ -152,6 +171,8 @@ export default class VectorDataApi {
|
|
|
152
171
|
* Returns top-K most similar vectors based on the configured distance metric
|
|
153
172
|
* Supports optional metadata filtering (requires GetVectors permission)
|
|
154
173
|
*
|
|
174
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
175
|
+
*
|
|
155
176
|
* @param options - Query options
|
|
156
177
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
157
178
|
* @param options.indexName - Name of the index
|
|
@@ -194,6 +215,8 @@ export default class VectorDataApi {
|
|
|
194
215
|
* Deletes vectors by their keys in batch
|
|
195
216
|
* Accepts 1-500 keys per request
|
|
196
217
|
*
|
|
218
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
219
|
+
*
|
|
197
220
|
* @param options - Vector deletion options
|
|
198
221
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
199
222
|
* @param options.indexName - Name of the index
|