@supabase/storage-js 2.81.2-canary.2 → 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.
- package/README.md +10 -0
- package/dist/main/StorageClient.d.ts +15 -1
- package/dist/main/StorageClient.d.ts.map +1 -1
- package/dist/main/StorageClient.js +15 -1
- package/dist/main/StorageClient.js.map +1 -1
- package/dist/main/lib/types.d.ts +1 -1
- package/dist/main/lib/types.d.ts.map +1 -1
- package/dist/main/lib/vectors/StorageVectorsClient.d.ts +99 -18
- package/dist/main/lib/vectors/StorageVectorsClient.d.ts.map +1 -1
- package/dist/main/lib/vectors/StorageVectorsClient.js +95 -17
- package/dist/main/lib/vectors/StorageVectorsClient.js.map +1 -1
- package/dist/main/lib/vectors/VectorBucketApi.d.ts +35 -7
- package/dist/main/lib/vectors/VectorBucketApi.d.ts.map +1 -1
- package/dist/main/lib/vectors/VectorBucketApi.js +35 -7
- package/dist/main/lib/vectors/VectorBucketApi.js.map +1 -1
- package/dist/main/lib/vectors/VectorDataApi.d.ts +44 -8
- package/dist/main/lib/vectors/VectorDataApi.d.ts.map +1 -1
- package/dist/main/lib/vectors/VectorDataApi.js +44 -8
- package/dist/main/lib/vectors/VectorDataApi.js.map +1 -1
- package/dist/main/lib/vectors/VectorIndexApi.d.ts +43 -8
- package/dist/main/lib/vectors/VectorIndexApi.d.ts.map +1 -1
- package/dist/main/lib/vectors/VectorIndexApi.js +39 -7
- 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/main/packages/StorageAnalyticsApi.d.ts +79 -28
- package/dist/main/packages/StorageAnalyticsApi.d.ts.map +1 -1
- package/dist/main/packages/StorageAnalyticsApi.js +80 -29
- package/dist/main/packages/StorageAnalyticsApi.js.map +1 -1
- package/dist/main/packages/StorageBucketApi.d.ts +143 -1
- package/dist/main/packages/StorageBucketApi.d.ts.map +1 -1
- package/dist/main/packages/StorageBucketApi.js +143 -1
- package/dist/main/packages/StorageBucketApi.js.map +1 -1
- package/dist/main/packages/StorageFileApi.d.ts +410 -2
- package/dist/main/packages/StorageFileApi.d.ts.map +1 -1
- package/dist/main/packages/StorageFileApi.js +410 -2
- package/dist/main/packages/StorageFileApi.js.map +1 -1
- package/dist/module/StorageClient.d.ts +15 -1
- package/dist/module/StorageClient.d.ts.map +1 -1
- package/dist/module/StorageClient.js +15 -1
- package/dist/module/StorageClient.js.map +1 -1
- package/dist/module/lib/types.d.ts +1 -1
- package/dist/module/lib/types.d.ts.map +1 -1
- package/dist/module/lib/vectors/StorageVectorsClient.d.ts +99 -18
- package/dist/module/lib/vectors/StorageVectorsClient.d.ts.map +1 -1
- package/dist/module/lib/vectors/StorageVectorsClient.js +95 -17
- package/dist/module/lib/vectors/StorageVectorsClient.js.map +1 -1
- package/dist/module/lib/vectors/VectorBucketApi.d.ts +35 -7
- package/dist/module/lib/vectors/VectorBucketApi.d.ts.map +1 -1
- package/dist/module/lib/vectors/VectorBucketApi.js +35 -7
- package/dist/module/lib/vectors/VectorBucketApi.js.map +1 -1
- package/dist/module/lib/vectors/VectorDataApi.d.ts +44 -8
- package/dist/module/lib/vectors/VectorDataApi.d.ts.map +1 -1
- package/dist/module/lib/vectors/VectorDataApi.js +44 -8
- package/dist/module/lib/vectors/VectorDataApi.js.map +1 -1
- package/dist/module/lib/vectors/VectorIndexApi.d.ts +43 -8
- package/dist/module/lib/vectors/VectorIndexApi.d.ts.map +1 -1
- package/dist/module/lib/vectors/VectorIndexApi.js +39 -7
- 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/module/packages/StorageAnalyticsApi.d.ts +79 -28
- package/dist/module/packages/StorageAnalyticsApi.d.ts.map +1 -1
- package/dist/module/packages/StorageAnalyticsApi.js +80 -29
- package/dist/module/packages/StorageAnalyticsApi.js.map +1 -1
- package/dist/module/packages/StorageBucketApi.d.ts +143 -1
- package/dist/module/packages/StorageBucketApi.d.ts.map +1 -1
- package/dist/module/packages/StorageBucketApi.js +143 -1
- package/dist/module/packages/StorageBucketApi.js.map +1 -1
- package/dist/module/packages/StorageFileApi.d.ts +410 -2
- package/dist/module/packages/StorageFileApi.d.ts.map +1 -1
- package/dist/module/packages/StorageFileApi.js +410 -2
- package/dist/module/packages/StorageFileApi.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 -1
- package/src/lib/types.ts +1 -1
- package/src/lib/vectors/StorageVectorsClient.ts +99 -18
- package/src/lib/vectors/VectorBucketApi.ts +35 -7
- package/src/lib/vectors/VectorDataApi.ts +44 -8
- package/src/lib/vectors/VectorIndexApi.ts +43 -8
- package/src/lib/version.ts +1 -1
- package/src/packages/StorageAnalyticsApi.ts +81 -30
- package/src/packages/StorageBucketApi.ts +143 -1
- package/src/packages/StorageFileApi.ts +410 -2
|
@@ -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
|
-
* **
|
|
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
|
-
* **
|
|
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
|
-
* **
|
|
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
|
-
* **
|
|
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
|
-
* **
|
|
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
|
-
* **
|
|
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
|
-
* **
|
|
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
|
-
* **
|
|
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
|
|
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
|
-
* **
|
|
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
|
-
* **
|
|
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
|
-
* **
|
|
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
|
-
* **
|
|
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
|
-
* **
|
|
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
|
-
* **
|
|
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
|
-
* **
|
|
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
|
-
* **
|
|
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
|
|
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"}
|
|
@@ -1,9 +1,12 @@
|
|
|
1
1
|
import { Fetch } from './fetch';
|
|
2
2
|
import { ApiResponse, VectorIndex, ListIndexesOptions, ListIndexesResponse, VectorDataType, DistanceMetric, MetadataConfiguration } from './types';
|
|
3
3
|
/**
|
|
4
|
+
*
|
|
5
|
+
* @alpha
|
|
6
|
+
*
|
|
4
7
|
* Options for creating a vector index
|
|
5
8
|
*
|
|
6
|
-
* **
|
|
9
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
7
10
|
*/
|
|
8
11
|
export interface CreateIndexOptions {
|
|
9
12
|
vectorBucketName: string;
|
|
@@ -14,10 +17,13 @@ export interface CreateIndexOptions {
|
|
|
14
17
|
metadataConfiguration?: MetadataConfiguration;
|
|
15
18
|
}
|
|
16
19
|
/**
|
|
20
|
+
*
|
|
21
|
+
* @alpha
|
|
22
|
+
*
|
|
17
23
|
* API class for managing Vector Indexes within Vector Buckets
|
|
18
24
|
* Provides methods for creating, reading, listing, and deleting vector indexes
|
|
19
25
|
*
|
|
20
|
-
* **
|
|
26
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
21
27
|
*/
|
|
22
28
|
export default class VectorIndexApi {
|
|
23
29
|
protected url: string;
|
|
@@ -27,23 +33,36 @@ export default class VectorIndexApi {
|
|
|
27
33
|
protected fetch: Fetch;
|
|
28
34
|
protected shouldThrowOnError: boolean;
|
|
29
35
|
/**
|
|
36
|
+
*
|
|
37
|
+
* @alpha
|
|
38
|
+
*
|
|
30
39
|
* Creates an API client for managing vector indexes.
|
|
31
40
|
*
|
|
32
|
-
* **
|
|
41
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
33
42
|
*
|
|
43
|
+
* @category Vector Buckets
|
|
34
44
|
* @param url - Base URL for the Storage Vectors API.
|
|
35
45
|
* @param headers - Default headers sent with each request.
|
|
36
46
|
* @param fetch - Optional custom `fetch` implementation for non-browser runtimes.
|
|
47
|
+
*
|
|
48
|
+
* @example
|
|
49
|
+
* ```typescript
|
|
50
|
+
* const client = new VectorIndexApi(url, headers)
|
|
51
|
+
* ```
|
|
37
52
|
*/
|
|
38
53
|
constructor(url: string, headers?: {
|
|
39
54
|
[key: string]: string;
|
|
40
55
|
}, fetch?: Fetch);
|
|
41
56
|
/**
|
|
57
|
+
*
|
|
58
|
+
* @alpha
|
|
59
|
+
*
|
|
42
60
|
* Enable throwing errors instead of returning them in the response
|
|
43
61
|
* When enabled, failed operations will throw instead of returning { data: null, error }
|
|
44
62
|
*
|
|
45
|
-
* **
|
|
63
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
46
64
|
*
|
|
65
|
+
* @category Vector Buckets
|
|
47
66
|
* @returns This instance for method chaining
|
|
48
67
|
* @example
|
|
49
68
|
* ```typescript
|
|
@@ -54,11 +73,15 @@ export default class VectorIndexApi {
|
|
|
54
73
|
*/
|
|
55
74
|
throwOnError(): this;
|
|
56
75
|
/**
|
|
76
|
+
*
|
|
77
|
+
* @alpha
|
|
78
|
+
*
|
|
57
79
|
* Creates a new vector index within a bucket
|
|
58
80
|
* Defines the schema for vectors including dimensionality, distance metric, and metadata config
|
|
59
81
|
*
|
|
60
|
-
* **
|
|
82
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
61
83
|
*
|
|
84
|
+
* @category Vector Buckets
|
|
62
85
|
* @param options - Index configuration
|
|
63
86
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
64
87
|
* @param options.indexName - Unique name for the index within the bucket
|
|
@@ -90,11 +113,15 @@ export default class VectorIndexApi {
|
|
|
90
113
|
*/
|
|
91
114
|
createIndex(options: CreateIndexOptions): Promise<ApiResponse<undefined>>;
|
|
92
115
|
/**
|
|
116
|
+
*
|
|
117
|
+
* @alpha
|
|
118
|
+
*
|
|
93
119
|
* Retrieves metadata for a specific vector index
|
|
94
120
|
* Returns index configuration including dimension, distance metric, and metadata settings
|
|
95
121
|
*
|
|
96
|
-
* **
|
|
122
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
97
123
|
*
|
|
124
|
+
* @category Vector Buckets
|
|
98
125
|
* @param vectorBucketName - Name of the parent vector bucket
|
|
99
126
|
* @param indexName - Name of the index to retrieve
|
|
100
127
|
* @returns Promise with index metadata or error
|
|
@@ -116,11 +143,15 @@ export default class VectorIndexApi {
|
|
|
116
143
|
index: VectorIndex;
|
|
117
144
|
}>>;
|
|
118
145
|
/**
|
|
146
|
+
*
|
|
147
|
+
* @alpha
|
|
148
|
+
*
|
|
119
149
|
* Lists vector indexes within a bucket with optional filtering and pagination
|
|
120
150
|
* Supports prefix-based filtering and paginated results
|
|
121
151
|
*
|
|
122
|
-
* **
|
|
152
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
123
153
|
*
|
|
154
|
+
* @category Vector Buckets
|
|
124
155
|
* @param options - Listing options
|
|
125
156
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
126
157
|
* @param options.prefix - Filter indexes by name prefix
|
|
@@ -153,11 +184,15 @@ export default class VectorIndexApi {
|
|
|
153
184
|
*/
|
|
154
185
|
listIndexes(options: ListIndexesOptions): Promise<ApiResponse<ListIndexesResponse>>;
|
|
155
186
|
/**
|
|
187
|
+
*
|
|
188
|
+
* @alpha
|
|
189
|
+
*
|
|
156
190
|
* Deletes a vector index and all its data
|
|
157
191
|
* This operation removes the index schema and all vectors stored in the index
|
|
158
192
|
*
|
|
159
|
-
* **
|
|
193
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
160
194
|
*
|
|
195
|
+
* @category Vector Buckets
|
|
161
196
|
* @param vectorBucketName - Name of the parent vector bucket
|
|
162
197
|
* @param indexName - Name of the index to delete
|
|
163
198
|
* @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;;;;;;;GAOG;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;;;;;;;;GAQG;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;;;;;;;;;;;;;;;;;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACG,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAiB/E;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACG,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;IAiBzF;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,WAAW,CAAC,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;CAmBhG"}
|
|
@@ -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 Indexes within Vector Buckets
|
|
8
11
|
* Provides methods for creating, reading, listing, and deleting vector indexes
|
|
9
12
|
*
|
|
10
|
-
* **
|
|
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 VectorIndexApi {
|
|
13
16
|
/**
|
|
17
|
+
*
|
|
18
|
+
* @alpha
|
|
19
|
+
*
|
|
14
20
|
* Creates an API client for managing vector indexes.
|
|
15
21
|
*
|
|
16
|
-
* **
|
|
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 sent with each request.
|
|
20
27
|
* @param fetch - Optional custom `fetch` implementation for non-browser runtimes.
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* ```typescript
|
|
31
|
+
* const client = new VectorIndexApi(url, headers)
|
|
32
|
+
* ```
|
|
21
33
|
*/
|
|
22
34
|
constructor(url, headers = {}, fetch) {
|
|
23
35
|
this.shouldThrowOnError = false;
|
|
@@ -26,11 +38,15 @@ export default class VectorIndexApi {
|
|
|
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
|
-
* **
|
|
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 VectorIndexApi {
|
|
|
44
60
|
return this;
|
|
45
61
|
}
|
|
46
62
|
/**
|
|
63
|
+
*
|
|
64
|
+
* @alpha
|
|
65
|
+
*
|
|
47
66
|
* Creates a new vector index within a bucket
|
|
48
67
|
* Defines the schema for vectors including dimensionality, distance metric, and metadata config
|
|
49
68
|
*
|
|
50
|
-
* **
|
|
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 - Index configuration
|
|
53
73
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
54
74
|
* @param options.indexName - Unique name for the index within the bucket
|
|
@@ -98,11 +118,15 @@ export default class VectorIndexApi {
|
|
|
98
118
|
});
|
|
99
119
|
}
|
|
100
120
|
/**
|
|
121
|
+
*
|
|
122
|
+
* @alpha
|
|
123
|
+
*
|
|
101
124
|
* Retrieves metadata for a specific vector index
|
|
102
125
|
* Returns index configuration including dimension, distance metric, and metadata settings
|
|
103
126
|
*
|
|
104
|
-
* **
|
|
127
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
105
128
|
*
|
|
129
|
+
* @category Vector Buckets
|
|
106
130
|
* @param vectorBucketName - Name of the parent vector bucket
|
|
107
131
|
* @param indexName - Name of the index to retrieve
|
|
108
132
|
* @returns Promise with index metadata or error
|
|
@@ -138,11 +162,15 @@ export default class VectorIndexApi {
|
|
|
138
162
|
});
|
|
139
163
|
}
|
|
140
164
|
/**
|
|
165
|
+
*
|
|
166
|
+
* @alpha
|
|
167
|
+
*
|
|
141
168
|
* Lists vector indexes within a bucket with optional filtering and pagination
|
|
142
169
|
* Supports prefix-based filtering and paginated results
|
|
143
170
|
*
|
|
144
|
-
* **
|
|
171
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
145
172
|
*
|
|
173
|
+
* @category Vector Buckets
|
|
146
174
|
* @param options - Listing options
|
|
147
175
|
* @param options.vectorBucketName - Name of the parent vector bucket
|
|
148
176
|
* @param options.prefix - Filter indexes by name prefix
|
|
@@ -193,11 +221,15 @@ export default class VectorIndexApi {
|
|
|
193
221
|
});
|
|
194
222
|
}
|
|
195
223
|
/**
|
|
224
|
+
*
|
|
225
|
+
* @alpha
|
|
226
|
+
*
|
|
196
227
|
* Deletes a vector index and all its data
|
|
197
228
|
* This operation removes the index schema and all vectors stored in the index
|
|
198
229
|
*
|
|
199
|
-
* **
|
|
230
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
200
231
|
*
|
|
232
|
+
* @category Vector Buckets
|
|
201
233
|
* @param vectorBucketName - Name of the parent vector bucket
|
|
202
234
|
* @param indexName - Name of the index to delete
|
|
203
235
|
* @returns Promise with empty response on success or error
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"VectorIndexApi.js","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorIndexApi.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;
|
|
1
|
+
{"version":3,"file":"VectorIndexApi.js","sourceRoot":"","sources":["../../../../src/lib/vectors/VectorIndexApi.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;AA4BxC;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,OAAO,cAAc;IAMjC;;;;;;;;;;;;;;;;;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACG,WAAW,CAAC,OAA2B;;YAC3C,IAAI,CAAC;gBACH,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,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;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,QAAQ,CACZ,gBAAwB,EACxB,SAAiB;;YAEjB,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAI,CACrB,IAAI,CAAC,KAAK,EACV,GAAG,IAAI,CAAC,GAAG,WAAW,EACtB,EAAE,gBAAgB,EAAE,SAAS,EAAE,EAC/B,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACG,WAAW,CAAC,OAA2B;;YAC3C,IAAI,CAAC;gBACH,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;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,WAAW,CAAC,gBAAwB,EAAE,SAAiB;;YAC3D,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,IAAI,CACrB,IAAI,CAAC,KAAK,EACV,GAAG,IAAI,CAAC,GAAG,cAAc,EACzB,EAAE,gBAAgB,EAAE,SAAS,EAAE,EAC/B,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,2 +1,2 @@
|
|
|
1
|
-
export declare const version = "2.
|
|
1
|
+
export declare const version = "2.82.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../src/lib/version.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,OAAO,
|
|
1
|
+
{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../src/lib/version.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,OAAO,WAAW,CAAA"}
|
|
@@ -4,5 +4,5 @@
|
|
|
4
4
|
// - Debugging and support (identifying which version is running)
|
|
5
5
|
// - Telemetry and logging (version reporting in errors/analytics)
|
|
6
6
|
// - Ensuring build artifacts match the published package version
|
|
7
|
-
export const version = '2.
|
|
7
|
+
export const version = '2.82.0';
|
|
8
8
|
//# sourceMappingURL=version.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"version.js","sourceRoot":"","sources":["../../../src/lib/version.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,gEAAgE;AAChE,uEAAuE;AACvE,iEAAiE;AACjE,kEAAkE;AAClE,iEAAiE;AACjE,MAAM,CAAC,MAAM,OAAO,GAAG,
|
|
1
|
+
{"version":3,"file":"version.js","sourceRoot":"","sources":["../../../src/lib/version.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,gEAAgE;AAChE,uEAAuE;AACvE,iEAAiE;AACjE,kEAAkE;AAClE,iEAAiE;AACjE,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAA"}
|