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

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.
Files changed (86) hide show
  1. package/README.md +10 -0
  2. package/dist/main/StorageClient.d.ts +15 -1
  3. package/dist/main/StorageClient.d.ts.map +1 -1
  4. package/dist/main/StorageClient.js +15 -1
  5. package/dist/main/StorageClient.js.map +1 -1
  6. package/dist/main/lib/vectors/StorageVectorsClient.d.ts +99 -18
  7. package/dist/main/lib/vectors/StorageVectorsClient.d.ts.map +1 -1
  8. package/dist/main/lib/vectors/StorageVectorsClient.js +95 -17
  9. package/dist/main/lib/vectors/StorageVectorsClient.js.map +1 -1
  10. package/dist/main/lib/vectors/VectorBucketApi.d.ts +35 -7
  11. package/dist/main/lib/vectors/VectorBucketApi.d.ts.map +1 -1
  12. package/dist/main/lib/vectors/VectorBucketApi.js +35 -7
  13. package/dist/main/lib/vectors/VectorBucketApi.js.map +1 -1
  14. package/dist/main/lib/vectors/VectorDataApi.d.ts +44 -8
  15. package/dist/main/lib/vectors/VectorDataApi.d.ts.map +1 -1
  16. package/dist/main/lib/vectors/VectorDataApi.js +44 -8
  17. package/dist/main/lib/vectors/VectorDataApi.js.map +1 -1
  18. package/dist/main/lib/vectors/VectorIndexApi.d.ts +43 -8
  19. package/dist/main/lib/vectors/VectorIndexApi.d.ts.map +1 -1
  20. package/dist/main/lib/vectors/VectorIndexApi.js +39 -7
  21. package/dist/main/lib/vectors/VectorIndexApi.js.map +1 -1
  22. package/dist/main/lib/version.d.ts +1 -1
  23. package/dist/main/lib/version.d.ts.map +1 -1
  24. package/dist/main/lib/version.js +1 -1
  25. package/dist/main/lib/version.js.map +1 -1
  26. package/dist/main/packages/StorageAnalyticsApi.d.ts +77 -26
  27. package/dist/main/packages/StorageAnalyticsApi.d.ts.map +1 -1
  28. package/dist/main/packages/StorageAnalyticsApi.js +77 -26
  29. package/dist/main/packages/StorageAnalyticsApi.js.map +1 -1
  30. package/dist/main/packages/StorageBucketApi.d.ts +143 -1
  31. package/dist/main/packages/StorageBucketApi.d.ts.map +1 -1
  32. package/dist/main/packages/StorageBucketApi.js +143 -1
  33. package/dist/main/packages/StorageBucketApi.js.map +1 -1
  34. package/dist/main/packages/StorageFileApi.d.ts +410 -2
  35. package/dist/main/packages/StorageFileApi.d.ts.map +1 -1
  36. package/dist/main/packages/StorageFileApi.js +410 -2
  37. package/dist/main/packages/StorageFileApi.js.map +1 -1
  38. package/dist/module/StorageClient.d.ts +15 -1
  39. package/dist/module/StorageClient.d.ts.map +1 -1
  40. package/dist/module/StorageClient.js +15 -1
  41. package/dist/module/StorageClient.js.map +1 -1
  42. package/dist/module/lib/vectors/StorageVectorsClient.d.ts +99 -18
  43. package/dist/module/lib/vectors/StorageVectorsClient.d.ts.map +1 -1
  44. package/dist/module/lib/vectors/StorageVectorsClient.js +95 -17
  45. package/dist/module/lib/vectors/StorageVectorsClient.js.map +1 -1
  46. package/dist/module/lib/vectors/VectorBucketApi.d.ts +35 -7
  47. package/dist/module/lib/vectors/VectorBucketApi.d.ts.map +1 -1
  48. package/dist/module/lib/vectors/VectorBucketApi.js +35 -7
  49. package/dist/module/lib/vectors/VectorBucketApi.js.map +1 -1
  50. package/dist/module/lib/vectors/VectorDataApi.d.ts +44 -8
  51. package/dist/module/lib/vectors/VectorDataApi.d.ts.map +1 -1
  52. package/dist/module/lib/vectors/VectorDataApi.js +44 -8
  53. package/dist/module/lib/vectors/VectorDataApi.js.map +1 -1
  54. package/dist/module/lib/vectors/VectorIndexApi.d.ts +43 -8
  55. package/dist/module/lib/vectors/VectorIndexApi.d.ts.map +1 -1
  56. package/dist/module/lib/vectors/VectorIndexApi.js +39 -7
  57. package/dist/module/lib/vectors/VectorIndexApi.js.map +1 -1
  58. package/dist/module/lib/version.d.ts +1 -1
  59. package/dist/module/lib/version.d.ts.map +1 -1
  60. package/dist/module/lib/version.js +1 -1
  61. package/dist/module/lib/version.js.map +1 -1
  62. package/dist/module/packages/StorageAnalyticsApi.d.ts +77 -26
  63. package/dist/module/packages/StorageAnalyticsApi.d.ts.map +1 -1
  64. package/dist/module/packages/StorageAnalyticsApi.js +77 -26
  65. package/dist/module/packages/StorageAnalyticsApi.js.map +1 -1
  66. package/dist/module/packages/StorageBucketApi.d.ts +143 -1
  67. package/dist/module/packages/StorageBucketApi.d.ts.map +1 -1
  68. package/dist/module/packages/StorageBucketApi.js +143 -1
  69. package/dist/module/packages/StorageBucketApi.js.map +1 -1
  70. package/dist/module/packages/StorageFileApi.d.ts +410 -2
  71. package/dist/module/packages/StorageFileApi.d.ts.map +1 -1
  72. package/dist/module/packages/StorageFileApi.js +410 -2
  73. package/dist/module/packages/StorageFileApi.js.map +1 -1
  74. package/dist/tsconfig.module.tsbuildinfo +1 -1
  75. package/dist/tsconfig.tsbuildinfo +1 -1
  76. package/dist/umd/supabase.js +1 -1
  77. package/package.json +1 -1
  78. package/src/StorageClient.ts +15 -1
  79. package/src/lib/vectors/StorageVectorsClient.ts +99 -18
  80. package/src/lib/vectors/VectorBucketApi.ts +35 -7
  81. package/src/lib/vectors/VectorDataApi.ts +44 -8
  82. package/src/lib/vectors/VectorIndexApi.ts +43 -8
  83. package/src/lib/version.ts +1 -1
  84. package/src/packages/StorageAnalyticsApi.ts +77 -26
  85. package/src/packages/StorageBucketApi.ts +143 -1
  86. package/src/packages/StorageFileApi.ts +410 -2
@@ -1,10 +1,13 @@
1
1
  import { Fetch } from './fetch';
2
2
  import { ApiResponse, VectorBucket, ListVectorBucketsOptions, ListVectorBucketsResponse } from './types';
3
3
  /**
4
+ *
5
+ * @alpha
6
+ *
4
7
  * API class for managing Vector Buckets
5
8
  * Provides methods for creating, reading, listing, and deleting vector buckets
6
9
  *
7
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
10
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
8
11
  */
9
12
  export default class VectorBucketApi {
10
13
  protected url: string;
@@ -14,9 +17,14 @@ export default class VectorBucketApi {
14
17
  protected fetch: Fetch;
15
18
  protected shouldThrowOnError: boolean;
16
19
  /**
20
+ *
21
+ * @alpha
22
+ *
17
23
  * Creates a new VectorBucketApi instance
18
24
  *
19
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
25
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
26
+ *
27
+ * @category Vector Buckets
20
28
  * @param url - The base URL for the storage vectors API
21
29
  * @param headers - HTTP headers to include in requests
22
30
  * @param fetch - Optional custom fetch implementation
@@ -30,11 +38,15 @@ export default class VectorBucketApi {
30
38
  [key: string]: string;
31
39
  }, fetch?: Fetch);
32
40
  /**
41
+ *
42
+ * @alpha
43
+ *
33
44
  * Enable throwing errors instead of returning them in the response
34
45
  * When enabled, failed operations will throw instead of returning { data: null, error }
35
46
  *
36
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
47
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
37
48
  *
49
+ * @category Vector Buckets
38
50
  * @returns This instance for method chaining
39
51
  * @example
40
52
  * ```typescript
@@ -45,11 +57,15 @@ export default class VectorBucketApi {
45
57
  */
46
58
  throwOnError(): this;
47
59
  /**
60
+ *
61
+ * @alpha
62
+ *
48
63
  * Creates a new vector bucket
49
64
  * Vector buckets are containers for vector indexes and their data
50
65
  *
51
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
66
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
52
67
  *
68
+ * @category Vector Buckets
53
69
  * @param vectorBucketName - Unique name for the vector bucket
54
70
  * @returns Promise with empty response on success or error
55
71
  *
@@ -68,11 +84,15 @@ export default class VectorBucketApi {
68
84
  */
69
85
  createBucket(vectorBucketName: string): Promise<ApiResponse<undefined>>;
70
86
  /**
87
+ *
88
+ * @alpha
89
+ *
71
90
  * Retrieves metadata for a specific vector bucket
72
91
  * Returns bucket configuration including encryption settings and creation time
73
92
  *
74
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
93
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
75
94
  *
95
+ * @category Vector Buckets
76
96
  * @param vectorBucketName - Name of the vector bucket to retrieve
77
97
  * @returns Promise with bucket metadata or error
78
98
  *
@@ -92,11 +112,15 @@ export default class VectorBucketApi {
92
112
  vectorBucket: VectorBucket;
93
113
  }>>;
94
114
  /**
115
+ *
116
+ * @alpha
117
+ *
95
118
  * Lists vector buckets with optional filtering and pagination
96
119
  * Supports prefix-based filtering and paginated results
97
120
  *
98
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
121
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
99
122
  *
123
+ * @category Vector Buckets
100
124
  * @param options - Listing options
101
125
  * @param options.prefix - Filter buckets by name prefix
102
126
  * @param options.maxResults - Maximum results per page (default: 100)
@@ -121,11 +145,15 @@ export default class VectorBucketApi {
121
145
  */
122
146
  listBuckets(options?: ListVectorBucketsOptions): Promise<ApiResponse<ListVectorBucketsResponse>>;
123
147
  /**
148
+ *
149
+ * @alpha
150
+ *
124
151
  * Deletes a vector bucket
125
152
  * Bucket must be empty before deletion (all indexes must be removed first)
126
153
  *
127
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
154
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
128
155
  *
156
+ * @category Vector Buckets
129
157
  * @param vectorBucketName - Name of the vector bucket to delete
130
158
  * @returns Promise with empty response on success or error
131
159
  *
@@ -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;;;;;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"}
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;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IAClC,SAAS,CAAC,GAAG,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IAC5C,SAAS,CAAC,KAAK,EAAE,KAAK,CAAA;IACtB,SAAS,CAAC,kBAAkB,UAAQ;IAEpC;;;;;;;;;;;;;;;;;OAiBG;gBACS,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAO,EAAE,KAAK,CAAC,EAAE,KAAK;IAM/E;;;;;;;;;;;;;;;;;OAiBG;IACI,YAAY,IAAI,IAAI;IAK3B;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,YAAY,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAoB7E;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,SAAS,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;QAAE,YAAY,EAAE,YAAY,CAAA;KAAE,CAAC,CAAC;IAoB/F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,WAAW,CACf,OAAO,GAAE,wBAA6B,GACrC,OAAO,CAAC,WAAW,CAAC,yBAAyB,CAAC,CAAC;IAiBlD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,YAAY,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;CAmB9E"}
@@ -4,16 +4,24 @@ import { isStorageVectorsError } from './errors';
4
4
  import { post } from './fetch';
5
5
  import { resolveFetch } from './helpers';
6
6
  /**
7
+ *
8
+ * @alpha
9
+ *
7
10
  * API class for managing Vector Buckets
8
11
  * Provides methods for creating, reading, listing, and deleting vector buckets
9
12
  *
10
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
13
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
11
14
  */
12
15
  export default class VectorBucketApi {
13
16
  /**
17
+ *
18
+ * @alpha
19
+ *
14
20
  * Creates a new VectorBucketApi instance
15
21
  *
16
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
22
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
23
+ *
24
+ * @category Vector Buckets
17
25
  * @param url - The base URL for the storage vectors API
18
26
  * @param headers - HTTP headers to include in requests
19
27
  * @param fetch - Optional custom fetch implementation
@@ -30,11 +38,15 @@ export default class VectorBucketApi {
30
38
  this.fetch = resolveFetch(fetch);
31
39
  }
32
40
  /**
41
+ *
42
+ * @alpha
43
+ *
33
44
  * Enable throwing errors instead of returning them in the response
34
45
  * When enabled, failed operations will throw instead of returning { data: null, error }
35
46
  *
36
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
47
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
37
48
  *
49
+ * @category Vector Buckets
38
50
  * @returns This instance for method chaining
39
51
  * @example
40
52
  * ```typescript
@@ -48,11 +60,15 @@ export default class VectorBucketApi {
48
60
  return this;
49
61
  }
50
62
  /**
63
+ *
64
+ * @alpha
65
+ *
51
66
  * Creates a new vector bucket
52
67
  * Vector buckets are containers for vector indexes and their data
53
68
  *
54
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
69
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
55
70
  *
71
+ * @category Vector Buckets
56
72
  * @param vectorBucketName - Unique name for the vector bucket
57
73
  * @returns Promise with empty response on success or error
58
74
  *
@@ -87,11 +103,15 @@ export default class VectorBucketApi {
87
103
  });
88
104
  }
89
105
  /**
106
+ *
107
+ * @alpha
108
+ *
90
109
  * Retrieves metadata for a specific vector bucket
91
110
  * Returns bucket configuration including encryption settings and creation time
92
111
  *
93
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
112
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
94
113
  *
114
+ * @category Vector Buckets
95
115
  * @param vectorBucketName - Name of the vector bucket to retrieve
96
116
  * @returns Promise with bucket metadata or error
97
117
  *
@@ -125,11 +145,15 @@ export default class VectorBucketApi {
125
145
  });
126
146
  }
127
147
  /**
148
+ *
149
+ * @alpha
150
+ *
128
151
  * Lists vector buckets with optional filtering and pagination
129
152
  * Supports prefix-based filtering and paginated results
130
153
  *
131
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
154
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
132
155
  *
156
+ * @category Vector Buckets
133
157
  * @param options - Listing options
134
158
  * @param options.prefix - Filter buckets by name prefix
135
159
  * @param options.maxResults - Maximum results per page (default: 100)
@@ -172,11 +196,15 @@ export default class VectorBucketApi {
172
196
  });
173
197
  }
174
198
  /**
199
+ *
200
+ * @alpha
201
+ *
175
202
  * Deletes a vector bucket
176
203
  * Bucket must be empty before deletion (all indexes must be removed first)
177
204
  *
178
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
205
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
179
206
  *
207
+ * @category Vector Buckets
180
208
  * @param vectorBucketName - Name of the vector bucket to delete
181
209
  * @returns Promise with empty response on success or error
182
210
  *
@@ -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;;;;;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"}
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;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IAMlC;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,GAAW,EAAE,UAAqC,EAAE,EAAE,KAAa;QApBrE,uBAAkB,GAAG,KAAK,CAAA;QAqBlC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACjC,IAAI,CAAC,OAAO,mCAAQ,eAAe,GAAK,OAAO,CAAE,CAAA;QACjD,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAA;IAClC,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACI,YAAY;QACjB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAA;QAC9B,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,YAAY,CAAC,gBAAwB;;YACzC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,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;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;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;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;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"}
@@ -1,10 +1,13 @@
1
1
  import { Fetch } from './fetch';
2
2
  import { ApiResponse, PutVectorsOptions, GetVectorsOptions, GetVectorsResponse, DeleteVectorsOptions, ListVectorsOptions, ListVectorsResponse, QueryVectorsOptions, QueryVectorsResponse } from './types';
3
3
  /**
4
+ *
5
+ * @alpha
6
+ *
4
7
  * API class for managing Vector Data within Vector Indexes
5
8
  * Provides methods for inserting, querying, listing, and deleting vector embeddings
6
9
  *
7
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
10
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
8
11
  */
9
12
  export default class VectorDataApi {
10
13
  protected url: string;
@@ -14,23 +17,36 @@ export default class VectorDataApi {
14
17
  protected fetch: Fetch;
15
18
  protected shouldThrowOnError: boolean;
16
19
  /**
20
+ *
21
+ * @alpha
22
+ *
17
23
  * Creates a VectorDataApi bound to a Storage Vectors deployment.
18
24
  *
19
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
25
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
20
26
  *
27
+ * @category Vector Buckets
21
28
  * @param url - Base URL for the Storage Vectors API.
22
29
  * @param headers - Default headers (for example authentication tokens).
23
30
  * @param fetch - Optional custom `fetch` implementation for non-browser runtimes.
31
+ *
32
+ * @example
33
+ * ```typescript
34
+ * const client = new VectorDataApi(url, headers)
35
+ * ```
24
36
  */
25
37
  constructor(url: string, headers?: {
26
38
  [key: string]: string;
27
39
  }, fetch?: Fetch);
28
40
  /**
41
+ *
42
+ * @alpha
43
+ *
29
44
  * Enable throwing errors instead of returning them in the response
30
45
  * When enabled, failed operations will throw instead of returning { data: null, error }
31
46
  *
32
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
47
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
33
48
  *
49
+ * @category Vector Buckets
34
50
  * @returns This instance for method chaining
35
51
  * @example
36
52
  * ```typescript
@@ -41,11 +57,15 @@ export default class VectorDataApi {
41
57
  */
42
58
  throwOnError(): this;
43
59
  /**
60
+ *
61
+ * @alpha
62
+ *
44
63
  * Inserts or updates vectors in batch (upsert operation)
45
64
  * Accepts 1-500 vectors per request. Larger batches should be split
46
65
  *
47
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
66
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
48
67
  *
68
+ * @category Vector Buckets
49
69
  * @param options - Vector insertion options
50
70
  * @param options.vectorBucketName - Name of the parent vector bucket
51
71
  * @param options.indexName - Name of the target index
@@ -79,12 +99,16 @@ export default class VectorDataApi {
79
99
  */
80
100
  putVectors(options: PutVectorsOptions): Promise<ApiResponse<undefined>>;
81
101
  /**
102
+ *
103
+ * @alpha
104
+ *
82
105
  * Retrieves vectors by their keys in batch
83
106
  * Optionally includes vector data and/or metadata in response
84
107
  * Additional permissions required when returning data or metadata
85
108
  *
86
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
109
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
87
110
  *
111
+ * @category Vector Buckets
88
112
  * @param options - Vector retrieval options
89
113
  * @param options.vectorBucketName - Name of the parent vector bucket
90
114
  * @param options.indexName - Name of the index
@@ -113,12 +137,16 @@ export default class VectorDataApi {
113
137
  */
114
138
  getVectors(options: GetVectorsOptions): Promise<ApiResponse<GetVectorsResponse>>;
115
139
  /**
140
+ *
141
+ * @alpha
142
+ *
116
143
  * Lists/scans vectors in an index with pagination
117
144
  * Supports parallel scanning via segment configuration for high-throughput scenarios
118
145
  * Additional permissions required when returning data or metadata
119
146
  *
120
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
147
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
121
148
  *
149
+ * @category Vector Buckets
122
150
  * @param options - Vector listing options
123
151
  * @param options.vectorBucketName - Name of the parent vector bucket
124
152
  * @param options.indexName - Name of the index
@@ -167,12 +195,16 @@ export default class VectorDataApi {
167
195
  */
168
196
  listVectors(options: ListVectorsOptions): Promise<ApiResponse<ListVectorsResponse>>;
169
197
  /**
198
+ *
199
+ * @alpha
200
+ *
170
201
  * Queries for similar vectors using approximate nearest neighbor (ANN) search
171
202
  * Returns top-K most similar vectors based on the configured distance metric
172
203
  * Supports optional metadata filtering (requires GetVectors permission)
173
204
  *
174
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
205
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
175
206
  *
207
+ * @category Vector Buckets
176
208
  * @param options - Query options
177
209
  * @param options.vectorBucketName - Name of the parent vector bucket
178
210
  * @param options.indexName - Name of the index
@@ -212,11 +244,15 @@ export default class VectorDataApi {
212
244
  */
213
245
  queryVectors(options: QueryVectorsOptions): Promise<ApiResponse<QueryVectorsResponse>>;
214
246
  /**
247
+ *
248
+ * @alpha
249
+ *
215
250
  * Deletes vectors by their keys in batch
216
251
  * Accepts 1-500 keys per request
217
252
  *
218
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
253
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
219
254
  *
255
+ * @category Vector Buckets
220
256
  * @param options - Vector deletion options
221
257
  * @param options.vectorBucketName - Name of the parent vector bucket
222
258
  * @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;;;;;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"}
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;;;;;;;;GAQG;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;;;;;;;;;;;;;;;;;OAiBG;gBACS,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAO,EAAE,KAAK,CAAC,EAAE,KAAK;IAM/E;;;;;;;;;;;;;;;;;OAiBG;IACI,YAAY,IAAI,IAAI;IAK3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACG,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAsB7E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACG,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;IAiBtF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwDG;IACG,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;IA6BzF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACG,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;IAiB5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;CAqBpF"}
@@ -4,20 +4,32 @@ import { isStorageVectorsError } from './errors';
4
4
  import { post } from './fetch';
5
5
  import { resolveFetch } from './helpers';
6
6
  /**
7
+ *
8
+ * @alpha
9
+ *
7
10
  * API class for managing Vector Data within Vector Indexes
8
11
  * Provides methods for inserting, querying, listing, and deleting vector embeddings
9
12
  *
10
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
13
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
11
14
  */
12
15
  export default class VectorDataApi {
13
16
  /**
17
+ *
18
+ * @alpha
19
+ *
14
20
  * Creates a VectorDataApi bound to a Storage Vectors deployment.
15
21
  *
16
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
22
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
17
23
  *
24
+ * @category Vector Buckets
18
25
  * @param url - Base URL for the Storage Vectors API.
19
26
  * @param headers - Default headers (for example authentication tokens).
20
27
  * @param fetch - Optional custom `fetch` implementation for non-browser runtimes.
28
+ *
29
+ * @example
30
+ * ```typescript
31
+ * const client = new VectorDataApi(url, headers)
32
+ * ```
21
33
  */
22
34
  constructor(url, headers = {}, fetch) {
23
35
  this.shouldThrowOnError = false;
@@ -26,11 +38,15 @@ export default class VectorDataApi {
26
38
  this.fetch = resolveFetch(fetch);
27
39
  }
28
40
  /**
41
+ *
42
+ * @alpha
43
+ *
29
44
  * Enable throwing errors instead of returning them in the response
30
45
  * When enabled, failed operations will throw instead of returning { data: null, error }
31
46
  *
32
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
47
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
33
48
  *
49
+ * @category Vector Buckets
34
50
  * @returns This instance for method chaining
35
51
  * @example
36
52
  * ```typescript
@@ -44,11 +60,15 @@ export default class VectorDataApi {
44
60
  return this;
45
61
  }
46
62
  /**
63
+ *
64
+ * @alpha
65
+ *
47
66
  * Inserts or updates vectors in batch (upsert operation)
48
67
  * Accepts 1-500 vectors per request. Larger batches should be split
49
68
  *
50
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
69
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
51
70
  *
71
+ * @category Vector Buckets
52
72
  * @param options - Vector insertion options
53
73
  * @param options.vectorBucketName - Name of the parent vector bucket
54
74
  * @param options.indexName - Name of the target index
@@ -104,12 +124,16 @@ export default class VectorDataApi {
104
124
  });
105
125
  }
106
126
  /**
127
+ *
128
+ * @alpha
129
+ *
107
130
  * Retrieves vectors by their keys in batch
108
131
  * Optionally includes vector data and/or metadata in response
109
132
  * Additional permissions required when returning data or metadata
110
133
  *
111
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
134
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
112
135
  *
136
+ * @category Vector Buckets
113
137
  * @param options - Vector retrieval options
114
138
  * @param options.vectorBucketName - Name of the parent vector bucket
115
139
  * @param options.indexName - Name of the index
@@ -156,12 +180,16 @@ export default class VectorDataApi {
156
180
  });
157
181
  }
158
182
  /**
183
+ *
184
+ * @alpha
185
+ *
159
186
  * Lists/scans vectors in an index with pagination
160
187
  * Supports parallel scanning via segment configuration for high-throughput scenarios
161
188
  * Additional permissions required when returning data or metadata
162
189
  *
163
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
190
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
164
191
  *
192
+ * @category Vector Buckets
165
193
  * @param options - Vector listing options
166
194
  * @param options.vectorBucketName - Name of the parent vector bucket
167
195
  * @param options.indexName - Name of the index
@@ -239,12 +267,16 @@ export default class VectorDataApi {
239
267
  });
240
268
  }
241
269
  /**
270
+ *
271
+ * @alpha
272
+ *
242
273
  * Queries for similar vectors using approximate nearest neighbor (ANN) search
243
274
  * Returns top-K most similar vectors based on the configured distance metric
244
275
  * Supports optional metadata filtering (requires GetVectors permission)
245
276
  *
246
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
277
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
247
278
  *
279
+ * @category Vector Buckets
248
280
  * @param options - Query options
249
281
  * @param options.vectorBucketName - Name of the parent vector bucket
250
282
  * @param options.indexName - Name of the index
@@ -302,11 +334,15 @@ export default class VectorDataApi {
302
334
  });
303
335
  }
304
336
  /**
337
+ *
338
+ * @alpha
339
+ *
305
340
  * Deletes vectors by their keys in batch
306
341
  * Accepts 1-500 keys per request
307
342
  *
308
- * **Private alpha:** Vector storage APIs are currently in private alpha and may not be accessible.
343
+ * **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
309
344
  *
345
+ * @category Vector Buckets
310
346
  * @param options - Vector deletion options
311
347
  * @param options.vectorBucketName - Name of the parent vector bucket
312
348
  * @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;;;;;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"}
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;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,OAAO,aAAa;IAMhC;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,GAAW,EAAE,UAAqC,EAAE,EAAE,KAAa;QApBrE,uBAAkB,GAAG,KAAK,CAAA;QAqBlC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACjC,IAAI,CAAC,OAAO,mCAAQ,eAAe,GAAK,OAAO,CAAE,CAAA;QACjD,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAA;IAClC,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACI,YAAY;QACjB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAA;QAC9B,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwDG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;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"}