@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.
- 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/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 +77 -26
- package/dist/main/packages/StorageAnalyticsApi.d.ts.map +1 -1
- package/dist/main/packages/StorageAnalyticsApi.js +77 -26
- 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/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 +77 -26
- package/dist/module/packages/StorageAnalyticsApi.d.ts.map +1 -1
- package/dist/module/packages/StorageAnalyticsApi.js +77 -26
- 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/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 +77 -26
- package/src/packages/StorageBucketApi.ts +143 -1
- package/src/packages/StorageFileApi.ts +410 -2
package/README.md
CHANGED
|
@@ -209,7 +209,17 @@ await storageClient.analytics.deleteBucket('analytics-data')
|
|
|
209
209
|
- Retrieve the details of all Storage buckets within an existing project:
|
|
210
210
|
|
|
211
211
|
```js
|
|
212
|
+
// List all buckets
|
|
212
213
|
const { data, error } = await storageClient.listBuckets()
|
|
214
|
+
|
|
215
|
+
// List buckets with options (pagination, sorting, search)
|
|
216
|
+
const { data, error } = await storageClient.listBuckets({
|
|
217
|
+
limit: 10,
|
|
218
|
+
offset: 0,
|
|
219
|
+
sortColumn: 'created_at',
|
|
220
|
+
sortOrder: 'desc',
|
|
221
|
+
search: 'prod',
|
|
222
|
+
})
|
|
213
223
|
```
|
|
214
224
|
|
|
215
225
|
#### Handling Files
|
|
@@ -10,6 +10,7 @@ export declare class StorageClient extends StorageBucketApi {
|
|
|
10
10
|
/**
|
|
11
11
|
* Creates a client for Storage buckets, files, analytics, and vectors.
|
|
12
12
|
*
|
|
13
|
+
* @category File Buckets
|
|
13
14
|
* @example
|
|
14
15
|
* ```ts
|
|
15
16
|
* import { StorageClient } from '@supabase/storage-js'
|
|
@@ -26,20 +27,33 @@ export declare class StorageClient extends StorageBucketApi {
|
|
|
26
27
|
/**
|
|
27
28
|
* Perform file operation in a bucket.
|
|
28
29
|
*
|
|
30
|
+
* @category File Buckets
|
|
29
31
|
* @param id The bucket id to operate on.
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```typescript
|
|
35
|
+
* const avatars = storage.from('avatars')
|
|
36
|
+
* ```
|
|
30
37
|
*/
|
|
31
38
|
from(id: string): StorageFileApi;
|
|
32
39
|
/**
|
|
40
|
+
*
|
|
41
|
+
* @alpha
|
|
42
|
+
*
|
|
33
43
|
* Access vector storage operations.
|
|
34
44
|
*
|
|
35
|
-
* **
|
|
45
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
36
46
|
*
|
|
47
|
+
* @category Vector Buckets
|
|
37
48
|
* @returns A StorageVectorsClient instance configured with the current storage settings.
|
|
38
49
|
*/
|
|
39
50
|
get vectors(): StorageVectorsClient;
|
|
40
51
|
/**
|
|
41
52
|
* Access analytics storage operations using Iceberg tables.
|
|
42
53
|
*
|
|
54
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
55
|
+
*
|
|
56
|
+
* @category Analytics Buckets
|
|
43
57
|
* @returns A StorageAnalyticsApi instance configured with the current storage settings.
|
|
44
58
|
* @example
|
|
45
59
|
* ```typescript
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"StorageClient.d.ts","sourceRoot":"","sources":["../../src/StorageClient.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,2BAA2B,CAAA;AACtD,OAAO,gBAAgB,MAAM,6BAA6B,CAAA;AAC1D,OAAO,mBAAmB,MAAM,gCAAgC,CAAA;AAChE,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACnC,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAA;AAEpD,MAAM,WAAW,oBAAoB;IACnC,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,qBAAa,aAAc,SAAQ,gBAAgB;IACjD
|
|
1
|
+
{"version":3,"file":"StorageClient.d.ts","sourceRoot":"","sources":["../../src/StorageClient.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,2BAA2B,CAAA;AACtD,OAAO,gBAAgB,MAAM,6BAA6B,CAAA;AAC1D,OAAO,mBAAmB,MAAM,gCAAgC,CAAA;AAChE,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACnC,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAA;AAEpD,MAAM,WAAW,oBAAoB;IACnC,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,qBAAa,aAAc,SAAQ,gBAAgB;IACjD;;;;;;;;;;;;;OAaG;gBAED,GAAG,EAAE,MAAM,EACX,OAAO,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAO,EACvC,KAAK,CAAC,EAAE,KAAK,EACb,IAAI,CAAC,EAAE,oBAAoB;IAK7B;;;;;;;;;;OAUG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc;IAIhC;;;;;;;;;;OAUG;IACH,IAAI,OAAO,IAAI,oBAAoB,CAKlC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,IAAI,SAAS,IAAI,mBAAmB,CAEnC;CACF"}
|
|
@@ -10,6 +10,7 @@ class StorageClient extends StorageBucketApi_1.default {
|
|
|
10
10
|
/**
|
|
11
11
|
* Creates a client for Storage buckets, files, analytics, and vectors.
|
|
12
12
|
*
|
|
13
|
+
* @category File Buckets
|
|
13
14
|
* @example
|
|
14
15
|
* ```ts
|
|
15
16
|
* import { StorageClient } from '@supabase/storage-js'
|
|
@@ -26,16 +27,26 @@ class StorageClient extends StorageBucketApi_1.default {
|
|
|
26
27
|
/**
|
|
27
28
|
* Perform file operation in a bucket.
|
|
28
29
|
*
|
|
30
|
+
* @category File Buckets
|
|
29
31
|
* @param id The bucket id to operate on.
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```typescript
|
|
35
|
+
* const avatars = storage.from('avatars')
|
|
36
|
+
* ```
|
|
30
37
|
*/
|
|
31
38
|
from(id) {
|
|
32
39
|
return new StorageFileApi_1.default(this.url, this.headers, id, this.fetch);
|
|
33
40
|
}
|
|
34
41
|
/**
|
|
42
|
+
*
|
|
43
|
+
* @alpha
|
|
44
|
+
*
|
|
35
45
|
* Access vector storage operations.
|
|
36
46
|
*
|
|
37
|
-
* **
|
|
47
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
38
48
|
*
|
|
49
|
+
* @category Vector Buckets
|
|
39
50
|
* @returns A StorageVectorsClient instance configured with the current storage settings.
|
|
40
51
|
*/
|
|
41
52
|
get vectors() {
|
|
@@ -47,6 +58,9 @@ class StorageClient extends StorageBucketApi_1.default {
|
|
|
47
58
|
/**
|
|
48
59
|
* Access analytics storage operations using Iceberg tables.
|
|
49
60
|
*
|
|
61
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
62
|
+
*
|
|
63
|
+
* @category Analytics Buckets
|
|
50
64
|
* @returns A StorageAnalyticsApi instance configured with the current storage settings.
|
|
51
65
|
* @example
|
|
52
66
|
* ```typescript
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"StorageClient.js","sourceRoot":"","sources":["../../src/StorageClient.ts"],"names":[],"mappings":";;;;AAAA,uFAAsD;AACtD,2FAA0D;AAC1D,iGAAgE;AAEhE,2CAAoD;AAMpD,MAAa,aAAc,SAAQ,0BAAgB;IACjD
|
|
1
|
+
{"version":3,"file":"StorageClient.js","sourceRoot":"","sources":["../../src/StorageClient.ts"],"names":[],"mappings":";;;;AAAA,uFAAsD;AACtD,2FAA0D;AAC1D,iGAAgE;AAEhE,2CAAoD;AAMpD,MAAa,aAAc,SAAQ,0BAAgB;IACjD;;;;;;;;;;;;;OAaG;IACH,YACE,GAAW,EACX,UAAqC,EAAE,EACvC,KAAa,EACb,IAA2B;QAE3B,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;IAClC,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CAAC,EAAU;QACb,OAAO,IAAI,wBAAc,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;IACnE,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,8BAAoB,CAAC,IAAI,CAAC,GAAG,GAAG,SAAS,EAAE;YACpD,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,6BAAmB,CAAC,IAAI,CAAC,GAAG,GAAG,UAAU,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;IACjF,CAAC;CACF;AAlFD,sCAkFC"}
|
|
@@ -4,9 +4,12 @@ import { Fetch } from './fetch';
|
|
|
4
4
|
import VectorBucketApi from './VectorBucketApi';
|
|
5
5
|
import { DeleteVectorsOptions, GetVectorsOptions, ListIndexesOptions, ListVectorsOptions, PutVectorsOptions, QueryVectorsOptions } from './types';
|
|
6
6
|
/**
|
|
7
|
+
*
|
|
8
|
+
* @alpha
|
|
9
|
+
*
|
|
7
10
|
* Configuration options for the Storage Vectors client
|
|
8
11
|
*
|
|
9
|
-
* **
|
|
12
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
10
13
|
*/
|
|
11
14
|
export interface StorageVectorsClientOptions {
|
|
12
15
|
/**
|
|
@@ -22,10 +25,13 @@ export interface StorageVectorsClientOptions {
|
|
|
22
25
|
fetch?: Fetch;
|
|
23
26
|
}
|
|
24
27
|
/**
|
|
28
|
+
*
|
|
29
|
+
* @alpha
|
|
30
|
+
*
|
|
25
31
|
* Main client for interacting with S3 Vectors API
|
|
26
32
|
* Provides access to bucket, index, and vector data operations
|
|
27
33
|
*
|
|
28
|
-
* **
|
|
34
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
29
35
|
*
|
|
30
36
|
* **Usage Patterns:**
|
|
31
37
|
*
|
|
@@ -80,21 +86,33 @@ export interface StorageVectorsClientOptions {
|
|
|
80
86
|
*/
|
|
81
87
|
export declare class StorageVectorsClient extends VectorBucketApi {
|
|
82
88
|
/**
|
|
89
|
+
* @alpha
|
|
90
|
+
*
|
|
83
91
|
* Creates a StorageVectorsClient that can manage buckets, indexes, and vectors.
|
|
84
92
|
*
|
|
85
|
-
* **
|
|
93
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
86
94
|
*
|
|
95
|
+
* @category Vector Buckets
|
|
87
96
|
* @param url - Base URL of the Storage Vectors REST API.
|
|
88
97
|
* @param options.headers - Optional headers (for example `Authorization`) applied to every request.
|
|
89
98
|
* @param options.fetch - Optional custom `fetch` implementation for non-browser runtimes.
|
|
99
|
+
*
|
|
100
|
+
* @example
|
|
101
|
+
* ```typescript
|
|
102
|
+
* const client = new StorageVectorsClient(url, options)
|
|
103
|
+
* ```
|
|
90
104
|
*/
|
|
91
105
|
constructor(url: string, options?: StorageVectorsClientOptions);
|
|
92
106
|
/**
|
|
107
|
+
*
|
|
108
|
+
* @alpha
|
|
109
|
+
*
|
|
93
110
|
* Access operations for a specific vector bucket
|
|
94
111
|
* Returns a scoped client for index and vector operations within the bucket
|
|
95
112
|
*
|
|
96
|
-
* **
|
|
113
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
97
114
|
*
|
|
115
|
+
* @category Vector Buckets
|
|
98
116
|
* @param vectorBucketName - Name of the vector bucket
|
|
99
117
|
* @returns Bucket-scoped client with index and vector operations
|
|
100
118
|
*
|
|
@@ -117,27 +135,42 @@ export declare class StorageVectorsClient extends VectorBucketApi {
|
|
|
117
135
|
from(vectorBucketName: string): VectorBucketScope;
|
|
118
136
|
}
|
|
119
137
|
/**
|
|
138
|
+
*
|
|
139
|
+
* @alpha
|
|
140
|
+
*
|
|
120
141
|
* Scoped client for operations within a specific vector bucket
|
|
121
142
|
* Provides index management and access to vector operations
|
|
122
143
|
*
|
|
123
|
-
* **
|
|
144
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
124
145
|
*/
|
|
125
146
|
export declare class VectorBucketScope extends VectorIndexApi {
|
|
126
147
|
private vectorBucketName;
|
|
127
148
|
/**
|
|
149
|
+
* @alpha
|
|
150
|
+
*
|
|
128
151
|
* Creates a helper that automatically scopes all index operations to the provided bucket.
|
|
129
152
|
*
|
|
130
|
-
* **
|
|
153
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
154
|
+
*
|
|
155
|
+
* @category Vector Buckets
|
|
156
|
+
* @example
|
|
157
|
+
* ```typescript
|
|
158
|
+
* const bucket = client.bucket('embeddings-prod')
|
|
159
|
+
* ```
|
|
131
160
|
*/
|
|
132
161
|
constructor(url: string, headers: {
|
|
133
162
|
[key: string]: string;
|
|
134
163
|
}, vectorBucketName: string, fetch?: Fetch);
|
|
135
164
|
/**
|
|
165
|
+
*
|
|
166
|
+
* @alpha
|
|
167
|
+
*
|
|
136
168
|
* Creates a new vector index in this bucket
|
|
137
169
|
* Convenience method that automatically includes the bucket name
|
|
138
170
|
*
|
|
139
|
-
* **
|
|
171
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
140
172
|
*
|
|
173
|
+
* @category Vector Buckets
|
|
141
174
|
* @param options - Index configuration (vectorBucketName is automatically set)
|
|
142
175
|
* @returns Promise with empty response on success or error
|
|
143
176
|
*
|
|
@@ -157,11 +190,15 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
157
190
|
*/
|
|
158
191
|
createIndex(options: Omit<CreateIndexOptions, 'vectorBucketName'>): Promise<import("./types").ApiResponse<undefined>>;
|
|
159
192
|
/**
|
|
193
|
+
*
|
|
194
|
+
* @alpha
|
|
195
|
+
*
|
|
160
196
|
* Lists indexes in this bucket
|
|
161
197
|
* Convenience method that automatically includes the bucket name
|
|
162
198
|
*
|
|
163
|
-
* **
|
|
199
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
164
200
|
*
|
|
201
|
+
* @category Vector Buckets
|
|
165
202
|
* @param options - Listing options (vectorBucketName is automatically set)
|
|
166
203
|
* @returns Promise with list of indexes or error
|
|
167
204
|
*
|
|
@@ -173,11 +210,15 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
173
210
|
*/
|
|
174
211
|
listIndexes(options?: Omit<ListIndexesOptions, 'vectorBucketName'>): Promise<import("./types").ApiResponse<import("./types").ListIndexesResponse>>;
|
|
175
212
|
/**
|
|
213
|
+
*
|
|
214
|
+
* @alpha
|
|
215
|
+
*
|
|
176
216
|
* Retrieves metadata for a specific index in this bucket
|
|
177
217
|
* Convenience method that automatically includes the bucket name
|
|
178
218
|
*
|
|
179
|
-
* **
|
|
219
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
180
220
|
*
|
|
221
|
+
* @category Vector Buckets
|
|
181
222
|
* @param indexName - Name of the index to retrieve
|
|
182
223
|
* @returns Promise with index metadata or error
|
|
183
224
|
*
|
|
@@ -192,11 +233,15 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
192
233
|
index: import("./types").VectorIndex;
|
|
193
234
|
}>>;
|
|
194
235
|
/**
|
|
236
|
+
*
|
|
237
|
+
* @alpha
|
|
238
|
+
*
|
|
195
239
|
* Deletes an index from this bucket
|
|
196
240
|
* Convenience method that automatically includes the bucket name
|
|
197
241
|
*
|
|
198
|
-
* **
|
|
242
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
199
243
|
*
|
|
244
|
+
* @category Vector Buckets
|
|
200
245
|
* @param indexName - Name of the index to delete
|
|
201
246
|
* @returns Promise with empty response on success or error
|
|
202
247
|
*
|
|
@@ -208,11 +253,15 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
208
253
|
*/
|
|
209
254
|
deleteIndex(indexName: string): Promise<import("./types").ApiResponse<undefined>>;
|
|
210
255
|
/**
|
|
256
|
+
*
|
|
257
|
+
* @alpha
|
|
258
|
+
*
|
|
211
259
|
* Access operations for a specific index within this bucket
|
|
212
260
|
* Returns a scoped client for vector data operations
|
|
213
261
|
*
|
|
214
|
-
* **
|
|
262
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
215
263
|
*
|
|
264
|
+
* @category Vector Buckets
|
|
216
265
|
* @param indexName - Name of the index
|
|
217
266
|
* @returns Index-scoped client with vector data operations
|
|
218
267
|
*
|
|
@@ -237,28 +286,44 @@ export declare class VectorBucketScope extends VectorIndexApi {
|
|
|
237
286
|
index(indexName: string): VectorIndexScope;
|
|
238
287
|
}
|
|
239
288
|
/**
|
|
289
|
+
*
|
|
290
|
+
* @alpha
|
|
291
|
+
*
|
|
240
292
|
* Scoped client for operations within a specific vector index
|
|
241
293
|
* Provides vector data operations (put, get, list, query, delete)
|
|
242
294
|
*
|
|
243
|
-
* **
|
|
295
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
244
296
|
*/
|
|
245
297
|
export declare class VectorIndexScope extends VectorDataApi {
|
|
246
298
|
private vectorBucketName;
|
|
247
299
|
private indexName;
|
|
248
300
|
/**
|
|
301
|
+
*
|
|
302
|
+
* @alpha
|
|
303
|
+
*
|
|
249
304
|
* Creates a helper that automatically scopes all vector operations to the provided bucket/index names.
|
|
250
305
|
*
|
|
251
|
-
* **
|
|
306
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
307
|
+
*
|
|
308
|
+
* @category Vector Buckets
|
|
309
|
+
* @example
|
|
310
|
+
* ```typescript
|
|
311
|
+
* const index = client.bucket('embeddings-prod').index('documents-openai')
|
|
312
|
+
* ```
|
|
252
313
|
*/
|
|
253
314
|
constructor(url: string, headers: {
|
|
254
315
|
[key: string]: string;
|
|
255
316
|
}, vectorBucketName: string, indexName: string, fetch?: Fetch);
|
|
256
317
|
/**
|
|
318
|
+
*
|
|
319
|
+
* @alpha
|
|
320
|
+
*
|
|
257
321
|
* Inserts or updates vectors in this index
|
|
258
322
|
* Convenience method that automatically includes bucket and index names
|
|
259
323
|
*
|
|
260
|
-
* **
|
|
324
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
261
325
|
*
|
|
326
|
+
* @category Vector Buckets
|
|
262
327
|
* @param options - Vector insertion options (bucket and index names automatically set)
|
|
263
328
|
* @returns Promise with empty response on success or error
|
|
264
329
|
*
|
|
@@ -278,11 +343,15 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
278
343
|
*/
|
|
279
344
|
putVectors(options: Omit<PutVectorsOptions, 'vectorBucketName' | 'indexName'>): Promise<import("./types").ApiResponse<undefined>>;
|
|
280
345
|
/**
|
|
346
|
+
*
|
|
347
|
+
* @alpha
|
|
348
|
+
*
|
|
281
349
|
* Retrieves vectors by keys from this index
|
|
282
350
|
* Convenience method that automatically includes bucket and index names
|
|
283
351
|
*
|
|
284
|
-
* **
|
|
352
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
285
353
|
*
|
|
354
|
+
* @category Vector Buckets
|
|
286
355
|
* @param options - Vector retrieval options (bucket and index names automatically set)
|
|
287
356
|
* @returns Promise with array of vectors or error
|
|
288
357
|
*
|
|
@@ -297,11 +366,15 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
297
366
|
*/
|
|
298
367
|
getVectors(options: Omit<GetVectorsOptions, 'vectorBucketName' | 'indexName'>): Promise<import("./types").ApiResponse<import("./types").GetVectorsResponse>>;
|
|
299
368
|
/**
|
|
369
|
+
*
|
|
370
|
+
* @alpha
|
|
371
|
+
*
|
|
300
372
|
* Lists vectors in this index with pagination
|
|
301
373
|
* Convenience method that automatically includes bucket and index names
|
|
302
374
|
*
|
|
303
|
-
* **
|
|
375
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
304
376
|
*
|
|
377
|
+
* @category Vector Buckets
|
|
305
378
|
* @param options - Listing options (bucket and index names automatically set)
|
|
306
379
|
* @returns Promise with array of vectors and pagination token
|
|
307
380
|
*
|
|
@@ -316,11 +389,15 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
316
389
|
*/
|
|
317
390
|
listVectors(options?: Omit<ListVectorsOptions, 'vectorBucketName' | 'indexName'>): Promise<import("./types").ApiResponse<import("./types").ListVectorsResponse>>;
|
|
318
391
|
/**
|
|
392
|
+
*
|
|
393
|
+
* @alpha
|
|
394
|
+
*
|
|
319
395
|
* Queries for similar vectors in this index
|
|
320
396
|
* Convenience method that automatically includes bucket and index names
|
|
321
397
|
*
|
|
322
|
-
* **
|
|
398
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
323
399
|
*
|
|
400
|
+
* @category Vector Buckets
|
|
324
401
|
* @param options - Query options (bucket and index names automatically set)
|
|
325
402
|
* @returns Promise with array of similar vectors ordered by distance
|
|
326
403
|
*
|
|
@@ -338,11 +415,15 @@ export declare class VectorIndexScope extends VectorDataApi {
|
|
|
338
415
|
*/
|
|
339
416
|
queryVectors(options: Omit<QueryVectorsOptions, 'vectorBucketName' | 'indexName'>): Promise<import("./types").ApiResponse<import("./types").QueryVectorsResponse>>;
|
|
340
417
|
/**
|
|
418
|
+
*
|
|
419
|
+
* @alpha
|
|
420
|
+
*
|
|
341
421
|
* Deletes vectors by keys from this index
|
|
342
422
|
* Convenience method that automatically includes bucket and index names
|
|
343
423
|
*
|
|
344
|
-
* **
|
|
424
|
+
* **Public alpha:** This API is part of a public alpha release and may not be available to your account type.
|
|
345
425
|
*
|
|
426
|
+
* @category Vector Buckets
|
|
346
427
|
* @param options - Deletion options (bucket and index names automatically set)
|
|
347
428
|
* @returns Promise with empty response on success or error
|
|
348
429
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"StorageVectorsClient.d.ts","sourceRoot":"","sources":["../../../../src/lib/vectors/StorageVectorsClient.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,EAAE,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAA;AACrE,OAAO,aAAa,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAC/B,OAAO,eAAe,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,SAAS,CAAA;AAEhB
|
|
1
|
+
{"version":3,"file":"StorageVectorsClient.d.ts","sourceRoot":"","sources":["../../../../src/lib/vectors/StorageVectorsClient.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,EAAE,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAA;AACrE,OAAO,aAAa,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAC/B,OAAO,eAAe,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,SAAS,CAAA;AAEhB;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACnC;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;CACd;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2DG;AACH,qBAAa,oBAAqB,SAAQ,eAAe;IACvD;;;;;;;;;;;;;;;;OAgBG;gBACS,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,2BAAgC;IAIlE;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,IAAI,CAAC,gBAAgB,EAAE,MAAM,GAAG,iBAAiB;CAGlD;AAED;;;;;;;;GAQG;AACH,qBAAa,iBAAkB,SAAQ,cAAc;IACnD,OAAO,CAAC,gBAAgB,CAAQ;IAEhC;;;;;;;;;;;;OAYG;gBAED,GAAG,EAAE,MAAM,EACX,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,EAClC,gBAAgB,EAAE,MAAM,EACxB,KAAK,CAAC,EAAE,KAAK;IAMf;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACY,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAOhF;;;;;;;;;;;;;;;;;;OAkBG;IACY,WAAW,CAAC,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,kBAAkB,CAAM;IAOrF;;;;;;;;;;;;;;;;;;;OAmBG;IACY,QAAQ,CAAC,SAAS,EAAE,MAAM;;;IAIzC;;;;;;;;;;;;;;;;;;OAkBG;IACY,WAAW,CAAC,SAAS,EAAE,MAAM;IAI5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB;CAS3C;AAED;;;;;;;;GAQG;AACH,qBAAa,gBAAiB,SAAQ,aAAa;IACjD,OAAO,CAAC,gBAAgB,CAAQ;IAChC,OAAO,CAAC,SAAS,CAAQ;IAEzB;;;;;;;;;;;;;OAaG;gBAED,GAAG,EAAE,MAAM,EACX,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,EAClC,gBAAgB,EAAE,MAAM,EACxB,SAAS,EAAE,MAAM,EACjB,KAAK,CAAC,EAAE,KAAK;IAOf;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACY,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,kBAAkB,GAAG,WAAW,CAAC;IAQ5F;;;;;;;;;;;;;;;;;;;;;OAqBG;IACY,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,kBAAkB,GAAG,WAAW,CAAC;IAQ5F;;;;;;;;;;;;;;;;;;;;;OAqBG;IACY,WAAW,CACxB,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,WAAW,CAAM;IAS1E;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACY,YAAY,CACzB,OAAO,EAAE,IAAI,CAAC,mBAAmB,EAAE,kBAAkB,GAAG,WAAW,CAAC;IAStE;;;;;;;;;;;;;;;;;;;;OAoBG;IACY,aAAa,CAC1B,OAAO,EAAE,IAAI,CAAC,oBAAoB,EAAE,kBAAkB,GAAG,WAAW,CAAC;CAQxE"}
|