@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
|
@@ -6,6 +6,8 @@ import VectorBucketApi from './VectorBucketApi';
|
|
|
6
6
|
* Main client for interacting with S3 Vectors API
|
|
7
7
|
* Provides access to bucket, index, and vector data operations
|
|
8
8
|
*
|
|
9
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
10
|
+
*
|
|
9
11
|
* **Usage Patterns:**
|
|
10
12
|
*
|
|
11
13
|
* 1. **Via StorageClient (recommended for most use cases):**
|
|
@@ -58,6 +60,15 @@ import VectorBucketApi from './VectorBucketApi';
|
|
|
58
60
|
* ```
|
|
59
61
|
*/
|
|
60
62
|
export class StorageVectorsClient extends VectorBucketApi {
|
|
63
|
+
/**
|
|
64
|
+
* Creates a StorageVectorsClient that can manage buckets, indexes, and vectors.
|
|
65
|
+
*
|
|
66
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
67
|
+
*
|
|
68
|
+
* @param url - Base URL of the Storage Vectors REST API.
|
|
69
|
+
* @param options.headers - Optional headers (for example `Authorization`) applied to every request.
|
|
70
|
+
* @param options.fetch - Optional custom `fetch` implementation for non-browser runtimes.
|
|
71
|
+
*/
|
|
61
72
|
constructor(url, options = {}) {
|
|
62
73
|
super(url, options.headers || {}, options.fetch);
|
|
63
74
|
}
|
|
@@ -65,6 +76,8 @@ export class StorageVectorsClient extends VectorBucketApi {
|
|
|
65
76
|
* Access operations for a specific vector bucket
|
|
66
77
|
* Returns a scoped client for index and vector operations within the bucket
|
|
67
78
|
*
|
|
79
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
80
|
+
*
|
|
68
81
|
* @param vectorBucketName - Name of the vector bucket
|
|
69
82
|
* @returns Bucket-scoped client with index and vector operations
|
|
70
83
|
*
|
|
@@ -91,8 +104,15 @@ export class StorageVectorsClient extends VectorBucketApi {
|
|
|
91
104
|
/**
|
|
92
105
|
* Scoped client for operations within a specific vector bucket
|
|
93
106
|
* Provides index management and access to vector operations
|
|
107
|
+
*
|
|
108
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
94
109
|
*/
|
|
95
110
|
export class VectorBucketScope extends VectorIndexApi {
|
|
111
|
+
/**
|
|
112
|
+
* Creates a helper that automatically scopes all index operations to the provided bucket.
|
|
113
|
+
*
|
|
114
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
115
|
+
*/
|
|
96
116
|
constructor(url, headers, vectorBucketName, fetch) {
|
|
97
117
|
super(url, headers, fetch);
|
|
98
118
|
this.vectorBucketName = vectorBucketName;
|
|
@@ -101,6 +121,8 @@ export class VectorBucketScope extends VectorIndexApi {
|
|
|
101
121
|
* Creates a new vector index in this bucket
|
|
102
122
|
* Convenience method that automatically includes the bucket name
|
|
103
123
|
*
|
|
124
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
125
|
+
*
|
|
104
126
|
* @param options - Index configuration (vectorBucketName is automatically set)
|
|
105
127
|
* @returns Promise with empty response on success or error
|
|
106
128
|
*
|
|
@@ -130,6 +152,8 @@ export class VectorBucketScope extends VectorIndexApi {
|
|
|
130
152
|
* Lists indexes in this bucket
|
|
131
153
|
* Convenience method that automatically includes the bucket name
|
|
132
154
|
*
|
|
155
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
156
|
+
*
|
|
133
157
|
* @param options - Listing options (vectorBucketName is automatically set)
|
|
134
158
|
* @returns Promise with list of indexes or error
|
|
135
159
|
*
|
|
@@ -151,6 +175,8 @@ export class VectorBucketScope extends VectorIndexApi {
|
|
|
151
175
|
* Retrieves metadata for a specific index in this bucket
|
|
152
176
|
* Convenience method that automatically includes the bucket name
|
|
153
177
|
*
|
|
178
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
179
|
+
*
|
|
154
180
|
* @param indexName - Name of the index to retrieve
|
|
155
181
|
* @returns Promise with index metadata or error
|
|
156
182
|
*
|
|
@@ -173,6 +199,8 @@ export class VectorBucketScope extends VectorIndexApi {
|
|
|
173
199
|
* Deletes an index from this bucket
|
|
174
200
|
* Convenience method that automatically includes the bucket name
|
|
175
201
|
*
|
|
202
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
203
|
+
*
|
|
176
204
|
* @param indexName - Name of the index to delete
|
|
177
205
|
* @returns Promise with empty response on success or error
|
|
178
206
|
*
|
|
@@ -194,6 +222,8 @@ export class VectorBucketScope extends VectorIndexApi {
|
|
|
194
222
|
* Access operations for a specific index within this bucket
|
|
195
223
|
* Returns a scoped client for vector data operations
|
|
196
224
|
*
|
|
225
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
226
|
+
*
|
|
197
227
|
* @param indexName - Name of the index
|
|
198
228
|
* @returns Index-scoped client with vector data operations
|
|
199
229
|
*
|
|
@@ -222,8 +252,15 @@ export class VectorBucketScope extends VectorIndexApi {
|
|
|
222
252
|
/**
|
|
223
253
|
* Scoped client for operations within a specific vector index
|
|
224
254
|
* Provides vector data operations (put, get, list, query, delete)
|
|
255
|
+
*
|
|
256
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
225
257
|
*/
|
|
226
258
|
export class VectorIndexScope extends VectorDataApi {
|
|
259
|
+
/**
|
|
260
|
+
* Creates a helper that automatically scopes all vector operations to the provided bucket/index names.
|
|
261
|
+
*
|
|
262
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
263
|
+
*/
|
|
227
264
|
constructor(url, headers, vectorBucketName, indexName, fetch) {
|
|
228
265
|
super(url, headers, fetch);
|
|
229
266
|
this.vectorBucketName = vectorBucketName;
|
|
@@ -233,6 +270,8 @@ export class VectorIndexScope extends VectorDataApi {
|
|
|
233
270
|
* Inserts or updates vectors in this index
|
|
234
271
|
* Convenience method that automatically includes bucket and index names
|
|
235
272
|
*
|
|
273
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
274
|
+
*
|
|
236
275
|
* @param options - Vector insertion options (bucket and index names automatically set)
|
|
237
276
|
* @returns Promise with empty response on success or error
|
|
238
277
|
*
|
|
@@ -262,6 +301,8 @@ export class VectorIndexScope extends VectorDataApi {
|
|
|
262
301
|
* Retrieves vectors by keys from this index
|
|
263
302
|
* Convenience method that automatically includes bucket and index names
|
|
264
303
|
*
|
|
304
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
305
|
+
*
|
|
265
306
|
* @param options - Vector retrieval options (bucket and index names automatically set)
|
|
266
307
|
* @returns Promise with array of vectors or error
|
|
267
308
|
*
|
|
@@ -286,6 +327,8 @@ export class VectorIndexScope extends VectorDataApi {
|
|
|
286
327
|
* Lists vectors in this index with pagination
|
|
287
328
|
* Convenience method that automatically includes bucket and index names
|
|
288
329
|
*
|
|
330
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
331
|
+
*
|
|
289
332
|
* @param options - Listing options (bucket and index names automatically set)
|
|
290
333
|
* @returns Promise with array of vectors and pagination token
|
|
291
334
|
*
|
|
@@ -310,6 +353,8 @@ export class VectorIndexScope extends VectorDataApi {
|
|
|
310
353
|
* Queries for similar vectors in this index
|
|
311
354
|
* Convenience method that automatically includes bucket and index names
|
|
312
355
|
*
|
|
356
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
357
|
+
*
|
|
313
358
|
* @param options - Query options (bucket and index names automatically set)
|
|
314
359
|
* @returns Promise with array of similar vectors ordered by distance
|
|
315
360
|
*
|
|
@@ -337,6 +382,8 @@ export class VectorIndexScope extends VectorDataApi {
|
|
|
337
382
|
* Deletes vectors by keys from this index
|
|
338
383
|
* Convenience method that automatically includes bucket and index names
|
|
339
384
|
*
|
|
385
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
386
|
+
*
|
|
340
387
|
* @param options - Deletion options (bucket and index names automatically set)
|
|
341
388
|
* @returns Promise with empty response on success or error
|
|
342
389
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"StorageVectorsClient.js","sourceRoot":"","sources":["../../../../src/lib/vectors/StorageVectorsClient.ts"],"names":[],"mappings":";AAAA,OAAO,cAAsC,MAAM,kBAAkB,CAAA;AACrE,OAAO,aAAa,MAAM,iBAAiB,CAAA;AAE3C,OAAO,eAAe,MAAM,mBAAmB,CAAA;
|
|
1
|
+
{"version":3,"file":"StorageVectorsClient.js","sourceRoot":"","sources":["../../../../src/lib/vectors/StorageVectorsClient.ts"],"names":[],"mappings":";AAAA,OAAO,cAAsC,MAAM,kBAAkB,CAAA;AACrE,OAAO,aAAa,MAAM,iBAAiB,CAAA;AAE3C,OAAO,eAAe,MAAM,mBAAmB,CAAA;AA2B/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,MAAM,OAAO,oBAAqB,SAAQ,eAAe;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;AAED;;;;;GAKG;AACH,MAAM,OAAO,iBAAkB,SAAQ,cAAc;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;;;;6DAAC,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;AAED;;;;;GAKG;AACH,MAAM,OAAO,gBAAiB,SAAQ,aAAa;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;;;;6DACxB,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"}
|
|
@@ -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"}
|
|
@@ -6,13 +6,22 @@ import { resolveFetch } from './helpers';
|
|
|
6
6
|
/**
|
|
7
7
|
* API class for managing Vector Buckets
|
|
8
8
|
* Provides methods for creating, reading, listing, and deleting vector buckets
|
|
9
|
+
*
|
|
10
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
9
11
|
*/
|
|
10
12
|
export default class VectorBucketApi {
|
|
11
13
|
/**
|
|
12
14
|
* Creates a new VectorBucketApi instance
|
|
15
|
+
*
|
|
16
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
13
17
|
* @param url - The base URL for the storage vectors API
|
|
14
18
|
* @param headers - HTTP headers to include in requests
|
|
15
19
|
* @param fetch - Optional custom fetch implementation
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* ```typescript
|
|
23
|
+
* const client = new VectorBucketApi(url, headers)
|
|
24
|
+
* ```
|
|
16
25
|
*/
|
|
17
26
|
constructor(url, headers = {}, fetch) {
|
|
18
27
|
this.shouldThrowOnError = false;
|
|
@@ -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
|
|
@@ -40,6 +51,8 @@ export default class VectorBucketApi {
|
|
|
40
51
|
* Creates a new vector bucket
|
|
41
52
|
* Vector buckets are containers for vector indexes and their data
|
|
42
53
|
*
|
|
54
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
55
|
+
*
|
|
43
56
|
* @param vectorBucketName - Unique name for the vector bucket
|
|
44
57
|
* @returns Promise with empty response on success or error
|
|
45
58
|
*
|
|
@@ -77,6 +90,8 @@ export default class VectorBucketApi {
|
|
|
77
90
|
* Retrieves metadata for a specific vector bucket
|
|
78
91
|
* Returns bucket configuration including encryption settings and creation time
|
|
79
92
|
*
|
|
93
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
94
|
+
*
|
|
80
95
|
* @param vectorBucketName - Name of the vector bucket to retrieve
|
|
81
96
|
* @returns Promise with bucket metadata or error
|
|
82
97
|
*
|
|
@@ -113,6 +128,8 @@ export default class VectorBucketApi {
|
|
|
113
128
|
* Lists vector buckets with optional filtering and pagination
|
|
114
129
|
* Supports prefix-based filtering and paginated results
|
|
115
130
|
*
|
|
131
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
132
|
+
*
|
|
116
133
|
* @param options - Listing options
|
|
117
134
|
* @param options.prefix - Filter buckets by name prefix
|
|
118
135
|
* @param options.maxResults - Maximum results per page (default: 100)
|
|
@@ -158,6 +175,8 @@ export default class VectorBucketApi {
|
|
|
158
175
|
* Deletes a vector bucket
|
|
159
176
|
* Bucket must be empty before deletion (all indexes must be removed first)
|
|
160
177
|
*
|
|
178
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
179
|
+
*
|
|
161
180
|
* @param vectorBucketName - Name of the vector bucket to delete
|
|
162
181
|
* @returns Promise with empty response on success or error
|
|
163
182
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"VectorBucketApi.js","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorBucketApi.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,EAAS,IAAI,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAQxC
|
|
1
|
+
{"version":3,"file":"VectorBucketApi.js","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorBucketApi.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,EAAS,IAAI,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAQxC;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,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,eAAe,GAAK,OAAO,CAAE,CAAA;QACjD,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,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,IAAI,CACrB,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,qBAAqB,CAAC,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,IAAI,CACrB,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,qBAAqB,CAAC,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;6DACf,UAAoC,EAAE;YAEtC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,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,qBAAqB,CAAC,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,IAAI,CACrB,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,qBAAqB,CAAC,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"}
|
|
@@ -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
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"VectorDataApi.d.ts","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorDataApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAQ,MAAM,SAAS,CAAA;AAErC,OAAO,EACL,WAAW,EACX,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,SAAS,CAAA;AAEhB
|
|
1
|
+
{"version":3,"file":"VectorDataApi.d.ts","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorDataApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAQ,MAAM,SAAS,CAAA;AAErC,OAAO,EACL,WAAW,EACX,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,SAAS,CAAA;AAEhB;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC,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;;;;;;;;OAQG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACG,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAsB7E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;IAiBtF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACG,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;IA6BzF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACG,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;IAiB5F;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;CAqBpF"}
|
|
@@ -6,8 +6,19 @@ import { resolveFetch } from './helpers';
|
|
|
6
6
|
/**
|
|
7
7
|
* API class for managing Vector Data within Vector Indexes
|
|
8
8
|
* Provides methods for inserting, querying, listing, and deleting vector embeddings
|
|
9
|
+
*
|
|
10
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
9
11
|
*/
|
|
10
12
|
export default class VectorDataApi {
|
|
13
|
+
/**
|
|
14
|
+
* Creates a VectorDataApi bound to a Storage Vectors deployment.
|
|
15
|
+
*
|
|
16
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
17
|
+
*
|
|
18
|
+
* @param url - Base URL for the Storage Vectors API.
|
|
19
|
+
* @param headers - Default headers (for example authentication tokens).
|
|
20
|
+
* @param fetch - Optional custom `fetch` implementation for non-browser runtimes.
|
|
21
|
+
*/
|
|
11
22
|
constructor(url, headers = {}, fetch) {
|
|
12
23
|
this.shouldThrowOnError = false;
|
|
13
24
|
this.url = url.replace(/\/$/, '');
|
|
@@ -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
|
|
@@ -34,6 +47,8 @@ export default class VectorDataApi {
|
|
|
34
47
|
* Inserts or updates vectors in batch (upsert operation)
|
|
35
48
|
* Accepts 1-500 vectors per request. Larger batches should be split
|
|
36
49
|
*
|
|
50
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
51
|
+
*
|
|
37
52
|
* @param options - Vector insertion options
|
|
38
53
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
39
54
|
* @param options.indexName - Name of the target index
|
|
@@ -93,6 +108,8 @@ export default class VectorDataApi {
|
|
|
93
108
|
* Optionally includes vector data and/or metadata in response
|
|
94
109
|
* Additional permissions required when returning data or metadata
|
|
95
110
|
*
|
|
111
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
112
|
+
*
|
|
96
113
|
* @param options - Vector retrieval options
|
|
97
114
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
98
115
|
* @param options.indexName - Name of the index
|
|
@@ -143,6 +160,8 @@ export default class VectorDataApi {
|
|
|
143
160
|
* Supports parallel scanning via segment configuration for high-throughput scenarios
|
|
144
161
|
* Additional permissions required when returning data or metadata
|
|
145
162
|
*
|
|
163
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
164
|
+
*
|
|
146
165
|
* @param options - Vector listing options
|
|
147
166
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
148
167
|
* @param options.indexName - Name of the index
|
|
@@ -224,6 +243,8 @@ export default class VectorDataApi {
|
|
|
224
243
|
* Returns top-K most similar vectors based on the configured distance metric
|
|
225
244
|
* Supports optional metadata filtering (requires GetVectors permission)
|
|
226
245
|
*
|
|
246
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
247
|
+
*
|
|
227
248
|
* @param options - Query options
|
|
228
249
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
229
250
|
* @param options.indexName - Name of the index
|
|
@@ -284,6 +305,8 @@ export default class VectorDataApi {
|
|
|
284
305
|
* Deletes vectors by their keys in batch
|
|
285
306
|
* Accepts 1-500 keys per request
|
|
286
307
|
*
|
|
308
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
309
|
+
*
|
|
287
310
|
* @param options - Vector deletion options
|
|
288
311
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
289
312
|
* @param options.indexName - Name of the index
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"VectorDataApi.js","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorDataApi.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,EAAS,IAAI,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAaxC
|
|
1
|
+
{"version":3,"file":"VectorDataApi.js","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorDataApi.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,EAAS,IAAI,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAaxC;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,aAAa;IAMhC;;;;;;;;OAQG;IACH,YAAY,GAAW,EAAE,UAAqC,EAAE,EAAE,KAAa;QAXrE,uBAAkB,GAAG,KAAK,CAAA;QAYlC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACjC,IAAI,CAAC,OAAO,mCAAQ,eAAe,GAAK,OAAO,CAAE,CAAA;QACjD,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAA;IAClC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,YAAY;QACjB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAA;QAC9B,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;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,IAAI,CAAC,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,qBAAqB,CAAC,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,UAAU,CAAC,OAA0B;;YACzC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,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,qBAAqB,CAAC,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;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,IAAI,CAAC,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,qBAAqB,CAAC,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACG,YAAY,CAAC,OAA4B;;YAC7C,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,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,qBAAqB,CAAC,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,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,IAAI,CAAC,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,qBAAqB,CAAC,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"}
|
|
@@ -2,6 +2,8 @@ import { Fetch } from './fetch';
|
|
|
2
2
|
import { ApiResponse, VectorIndex, ListIndexesOptions, ListIndexesResponse, VectorDataType, DistanceMetric, MetadataConfiguration } from './types';
|
|
3
3
|
/**
|
|
4
4
|
* Options for creating a vector index
|
|
5
|
+
*
|
|
6
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
5
7
|
*/
|
|
6
8
|
export interface CreateIndexOptions {
|
|
7
9
|
vectorBucketName: string;
|
|
@@ -14,6 +16,8 @@ export interface CreateIndexOptions {
|
|
|
14
16
|
/**
|
|
15
17
|
* API class for managing Vector Indexes within Vector Buckets
|
|
16
18
|
* Provides methods for creating, reading, listing, and deleting vector indexes
|
|
19
|
+
*
|
|
20
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
17
21
|
*/
|
|
18
22
|
export default class VectorIndexApi {
|
|
19
23
|
protected url: string;
|
|
@@ -22,6 +26,15 @@ export default class VectorIndexApi {
|
|
|
22
26
|
};
|
|
23
27
|
protected fetch: Fetch;
|
|
24
28
|
protected shouldThrowOnError: boolean;
|
|
29
|
+
/**
|
|
30
|
+
* Creates an API client for managing vector indexes.
|
|
31
|
+
*
|
|
32
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
33
|
+
*
|
|
34
|
+
* @param url - Base URL for the Storage Vectors API.
|
|
35
|
+
* @param headers - Default headers sent with each request.
|
|
36
|
+
* @param fetch - Optional custom `fetch` implementation for non-browser runtimes.
|
|
37
|
+
*/
|
|
25
38
|
constructor(url: string, headers?: {
|
|
26
39
|
[key: string]: string;
|
|
27
40
|
}, fetch?: Fetch);
|
|
@@ -29,6 +42,8 @@ export default class VectorIndexApi {
|
|
|
29
42
|
* Enable throwing errors instead of returning them in the response
|
|
30
43
|
* When enabled, failed operations will throw instead of returning { data: null, error }
|
|
31
44
|
*
|
|
45
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
46
|
+
*
|
|
32
47
|
* @returns This instance for method chaining
|
|
33
48
|
* @example
|
|
34
49
|
* ```typescript
|
|
@@ -42,6 +57,8 @@ export default class VectorIndexApi {
|
|
|
42
57
|
* Creates a new vector index within a bucket
|
|
43
58
|
* Defines the schema for vectors including dimensionality, distance metric, and metadata config
|
|
44
59
|
*
|
|
60
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
61
|
+
*
|
|
45
62
|
* @param options - Index configuration
|
|
46
63
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
47
64
|
* @param options.indexName - Unique name for the index within the bucket
|
|
@@ -76,6 +93,8 @@ export default class VectorIndexApi {
|
|
|
76
93
|
* Retrieves metadata for a specific vector index
|
|
77
94
|
* Returns index configuration including dimension, distance metric, and metadata settings
|
|
78
95
|
*
|
|
96
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
97
|
+
*
|
|
79
98
|
* @param vectorBucketName - Name of the parent vector bucket
|
|
80
99
|
* @param indexName - Name of the index to retrieve
|
|
81
100
|
* @returns Promise with index metadata or error
|
|
@@ -100,6 +119,8 @@ export default class VectorIndexApi {
|
|
|
100
119
|
* Lists vector indexes within a bucket with optional filtering and pagination
|
|
101
120
|
* Supports prefix-based filtering and paginated results
|
|
102
121
|
*
|
|
122
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
123
|
+
*
|
|
103
124
|
* @param options - Listing options
|
|
104
125
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
105
126
|
* @param options.prefix - Filter indexes by name prefix
|
|
@@ -135,6 +156,8 @@ export default class VectorIndexApi {
|
|
|
135
156
|
* Deletes a vector index and all its data
|
|
136
157
|
* This operation removes the index schema and all vectors stored in the index
|
|
137
158
|
*
|
|
159
|
+
* **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
|
|
160
|
+
*
|
|
138
161
|
* @param vectorBucketName - Name of the parent vector bucket
|
|
139
162
|
* @param indexName - Name of the index to delete
|
|
140
163
|
* @returns Promise with empty response on success or error
|
|
@@ -1 +1 @@
|
|
|
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
|
|
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;;;;GAIG;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;;;;;GAKG;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;IAEpC;;;;;;;;OAQG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAiB/E;;;;;;;;;;;;;;;;;;;;;;OAsBG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACG,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;IAiBzF;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,WAAW,CAAC,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;CAmBhG"}
|