@relevanceai/sdk 1.16.0 → 1.19.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.
@@ -134,6 +134,22 @@ class DiscoveryApiClient extends BaseClient_1._GenericClient {
134
134
  options
135
135
  });
136
136
  }
137
+ async DeleteProjectInvite(input, options) {
138
+ return this.SendRequest({
139
+ input,
140
+ method: 'post',
141
+ path: '/auth/invite/delete',
142
+ options
143
+ });
144
+ }
145
+ async ResendProjectInvite(input, options) {
146
+ return this.SendRequest({
147
+ input,
148
+ method: 'post',
149
+ path: '/auth/invite/resend',
150
+ options
151
+ });
152
+ }
137
153
  async GetUser(input, options) {
138
154
  return this.SendRequest({
139
155
  input,
@@ -326,6 +342,14 @@ class DiscoveryApiClient extends BaseClient_1._GenericClient {
326
342
  options
327
343
  });
328
344
  }
345
+ async ListFileUploadsForDataset(input, options) {
346
+ return this.SendRequest({
347
+ input,
348
+ method: 'get',
349
+ path: '/datasets/{dataset_id}/list_file_uploads',
350
+ options
351
+ });
352
+ }
329
353
  async ParseBlob(input, options) {
330
354
  return this.SendRequest({
331
355
  input,
@@ -258,6 +258,30 @@ var DiscoveryApiClient = /** @class */ (function (_super) {
258
258
  });
259
259
  });
260
260
  };
261
+ DiscoveryApiClient.prototype.DeleteProjectInvite = function (input, options) {
262
+ return __awaiter(this, void 0, void 0, function () {
263
+ return __generator(this, function (_a) {
264
+ return [2 /*return*/, this.SendRequest({
265
+ input: input,
266
+ method: 'post',
267
+ path: '/auth/invite/delete',
268
+ options: options
269
+ })];
270
+ });
271
+ });
272
+ };
273
+ DiscoveryApiClient.prototype.ResendProjectInvite = function (input, options) {
274
+ return __awaiter(this, void 0, void 0, function () {
275
+ return __generator(this, function (_a) {
276
+ return [2 /*return*/, this.SendRequest({
277
+ input: input,
278
+ method: 'post',
279
+ path: '/auth/invite/resend',
280
+ options: options
281
+ })];
282
+ });
283
+ });
284
+ };
261
285
  DiscoveryApiClient.prototype.GetUser = function (input, options) {
262
286
  return __awaiter(this, void 0, void 0, function () {
263
287
  return __generator(this, function (_a) {
@@ -546,6 +570,18 @@ var DiscoveryApiClient = /** @class */ (function (_super) {
546
570
  });
547
571
  });
548
572
  };
573
+ DiscoveryApiClient.prototype.ListFileUploadsForDataset = function (input, options) {
574
+ return __awaiter(this, void 0, void 0, function () {
575
+ return __generator(this, function (_a) {
576
+ return [2 /*return*/, this.SendRequest({
577
+ input: input,
578
+ method: 'get',
579
+ path: '/datasets/{dataset_id}/list_file_uploads',
580
+ options: options
581
+ })];
582
+ });
583
+ });
584
+ };
549
585
  DiscoveryApiClient.prototype.ParseBlob = function (input, options) {
550
586
  return __awaiter(this, void 0, void 0, function () {
551
587
  return __generator(this, function (_a) {
@@ -32,6 +32,10 @@ export declare type ListProjectInvitesInput = operations['ListProjectInvites']['
32
32
  export declare type ListProjectInvitesOutput = operations['ListProjectInvites']['responses']['200']['content']['application/json'];
33
33
  export declare type AcceptProjectInviteInput = operations['AcceptProjectInvite']['requestBody']['content']['application/json'];
34
34
  export declare type AcceptProjectInviteOutput = operations['AcceptProjectInvite']['responses']['200']['content']['application/json'];
35
+ export declare type DeleteProjectInviteInput = operations['DeleteProjectInvite']['requestBody']['content']['application/json'];
36
+ export declare type DeleteProjectInviteOutput = operations['DeleteProjectInvite']['responses']['200']['content']['application/json'];
37
+ export declare type ResendProjectInviteInput = operations['ResendProjectInvite']['requestBody']['content']['application/json'];
38
+ export declare type ResendProjectInviteOutput = operations['ResendProjectInvite']['responses']['200']['content']['application/json'];
35
39
  export declare type GetUserInput = {};
36
40
  export declare type GetUserOutput = operations['GetUser']['responses']['200']['content']['application/json'];
37
41
  export declare type UpdateUserInput = operations['UpdateUser']['requestBody']['content']['application/json'];
@@ -80,6 +84,8 @@ export declare type BulkInsertInput = operations['BulkInsert']['requestBody']['c
80
84
  export declare type BulkInsertOutput = operations['BulkInsert']['responses']['200']['content']['application/json'];
81
85
  export declare type GetFileUploadUrlsForDatasetInput = operations['GetFileUploadUrlsForDataset']['requestBody']['content']['application/json'];
82
86
  export declare type GetFileUploadUrlsForDatasetOutput = operations['GetFileUploadUrlsForDataset']['responses']['200']['content']['application/json'];
87
+ export declare type ListFileUploadsForDatasetInput = {};
88
+ export declare type ListFileUploadsForDatasetOutput = operations['ListFileUploadsForDataset']['responses']['200']['content']['application/json'];
83
89
  export declare type ParseBlobInput = operations['ParseBlob']['requestBody']['content']['application/json'];
84
90
  export declare type ParseBlobOutput = operations['ParseBlob']['responses']['200']['content']['application/json'];
85
91
  export declare type CopyForeignDatasetInput = operations['CopyForeignDataset']['requestBody']['content']['application/json'];
@@ -190,6 +196,8 @@ export declare class DiscoveryApiClient extends _GenericClient {
190
196
  CreateProjectInvite(input: CommandInput<CreateProjectInviteInput>, options?: _GenericMethodOptions): Promise<CommandOutput<CreateProjectInviteOutput>>;
191
197
  ListProjectInvites(input: CommandInput<ListProjectInvitesInput>, options?: _GenericMethodOptions): Promise<CommandOutput<ListProjectInvitesOutput>>;
192
198
  AcceptProjectInvite(input: CommandInput<AcceptProjectInviteInput>, options?: _GenericMethodOptions): Promise<CommandOutput<AcceptProjectInviteOutput>>;
199
+ DeleteProjectInvite(input: CommandInput<DeleteProjectInviteInput>, options?: _GenericMethodOptions): Promise<CommandOutput<DeleteProjectInviteOutput>>;
200
+ ResendProjectInvite(input: CommandInput<ResendProjectInviteInput>, options?: _GenericMethodOptions): Promise<CommandOutput<ResendProjectInviteOutput>>;
193
201
  GetUser(input: CommandInput<GetUserInput>, options?: _GenericMethodOptions): Promise<CommandOutput<GetUserOutput>>;
194
202
  UpdateUser(input: CommandInput<UpdateUserInput>, options?: _GenericMethodOptions): Promise<CommandOutput<UpdateUserOutput>>;
195
203
  DeleteUser(input: CommandInput<DeleteUserInput>, options?: _GenericMethodOptions): Promise<CommandOutput<DeleteUserOutput>>;
@@ -214,6 +222,7 @@ export declare class DiscoveryApiClient extends _GenericClient {
214
222
  Insert(input: CommandInput<InsertInput>, options?: _GenericMethodOptions): Promise<CommandOutput<InsertOutput>>;
215
223
  BulkInsert(input: CommandInput<BulkInsertInput>, options?: _GenericMethodOptions): Promise<CommandOutput<BulkInsertOutput>>;
216
224
  GetFileUploadUrlsForDataset(input: CommandInput<GetFileUploadUrlsForDatasetInput>, options?: _GenericMethodOptions): Promise<CommandOutput<GetFileUploadUrlsForDatasetOutput>>;
225
+ ListFileUploadsForDataset(input: CommandInput<ListFileUploadsForDatasetInput>, options?: _GenericMethodOptions): Promise<CommandOutput<ListFileUploadsForDatasetOutput>>;
217
226
  ParseBlob(input: CommandInput<ParseBlobInput>, options?: _GenericMethodOptions): Promise<CommandOutput<ParseBlobOutput>>;
218
227
  CopyForeignDataset(input: CommandInput<CopyForeignDatasetInput>, options?: _GenericMethodOptions): Promise<CommandOutput<CopyForeignDatasetOutput>>;
219
228
  CreateProjectReadKey(input: CommandInput<CreateProjectReadKeyInput>, options?: _GenericMethodOptions): Promise<CommandOutput<CreateProjectReadKeyOutput>>;
@@ -64,6 +64,12 @@ export interface paths {
64
64
  "/auth/invite/accept": {
65
65
  post: operations["AcceptProjectInvite"];
66
66
  };
67
+ "/auth/invite/delete": {
68
+ post: operations["DeleteProjectInvite"];
69
+ };
70
+ "/auth/invite/resend": {
71
+ post: operations["ResendProjectInvite"];
72
+ };
67
73
  "/auth/users/{user_id}": {
68
74
  get: operations["GetUser"];
69
75
  };
@@ -227,6 +233,10 @@ export interface paths {
227
233
  /** specify a list of file paths. For each file path, a url upload_url is returned. files can be POSTed on upload_url to upload them. They can then be accessed on url. Upon dataset deletion, these files will be deleted. */
228
234
  post: operations["GetFileUploadUrlsForDataset"];
229
235
  };
236
+ "/datasets/{dataset_id}/list_file_uploads": {
237
+ /** Return up to 1000 files uploaded for a dataset. */
238
+ get: operations["ListFileUploadsForDataset"];
239
+ };
230
240
  "/datasets/{dataset_id}/parse_blob": {
231
241
  /** Bulk insert a large number of documents by downloading a file using "download url". This bypasses the need to directly send documents to the api, as happens in BulkInsert. */
232
242
  post: operations["ParseBlob"];
@@ -664,6 +674,7 @@ export interface components {
664
674
  type: "user" | "machine";
665
675
  _id: string;
666
676
  email?: string;
677
+ creator_user_id?: string;
667
678
  }[];
668
679
  };
669
680
  IsUserAuthorizedInput: {
@@ -776,6 +787,41 @@ export interface components {
776
787
  AcceptProjectInviteOutput: {
777
788
  [key: string]: unknown;
778
789
  };
790
+ DeleteProjectInviteInput: {
791
+ invite_code: string;
792
+ };
793
+ DeleteProjectInviteOutput: {
794
+ [key: string]: unknown;
795
+ };
796
+ ResendProjectInviteInput: {
797
+ invite_code: string;
798
+ permissions?: {
799
+ items: {
800
+ [key: string]: {
801
+ resources?: {
802
+ datasets?: {
803
+ [key: string]: boolean;
804
+ };
805
+ deployables?: {
806
+ [key: string]: boolean;
807
+ };
808
+ users?: {
809
+ [key: string]: boolean;
810
+ };
811
+ workflows?: {
812
+ [key: string]: boolean;
813
+ };
814
+ };
815
+ actions?: {
816
+ [key: string]: boolean;
817
+ };
818
+ };
819
+ };
820
+ };
821
+ };
822
+ ResendProjectInviteOutput: {
823
+ [key: string]: unknown;
824
+ };
779
825
  GetUserInput: {
780
826
  [key: string]: unknown;
781
827
  };
@@ -811,6 +857,7 @@ export interface components {
811
857
  type: "user" | "machine";
812
858
  _id: string;
813
859
  email?: string;
860
+ creator_user_id?: string;
814
861
  };
815
862
  UpdateUserInput: {
816
863
  name?: string;
@@ -2140,6 +2187,14 @@ export interface components {
2140
2187
  minimum_cluster_size_filter_type?: "or" | "and";
2141
2188
  cluster_page?: number;
2142
2189
  cluster_page_size?: number;
2190
+ sort_metrics?: {
2191
+ field?: string;
2192
+ fields?: string[];
2193
+ agg?: "avg" | "average" | "cardinality" | "max" | "mean" | "min" | "sum" | "percentiles" | "sum_of_squares" | "variance" | "std_deviation" | "std_deviation_bounds" | "kurtosis" | "covariance" | "skewness" | "character_count" | "count" | "correlation" | "missing";
2194
+ name?: string;
2195
+ }[];
2196
+ /** @description Whether to sort results by ascending or descending order. */
2197
+ asc?: boolean;
2143
2198
  };
2144
2199
  };
2145
2200
  AggregateClustersOutput: {
@@ -2652,6 +2707,14 @@ export interface components {
2652
2707
  minimum_cluster_size_filter_type?: "or" | "and";
2653
2708
  cluster_page?: number;
2654
2709
  cluster_page_size?: number;
2710
+ sort_metrics?: {
2711
+ field?: string;
2712
+ fields?: string[];
2713
+ agg?: "avg" | "average" | "cardinality" | "max" | "mean" | "min" | "sum" | "percentiles" | "sum_of_squares" | "variance" | "std_deviation" | "std_deviation_bounds" | "kurtosis" | "covariance" | "skewness" | "character_count" | "count" | "correlation" | "missing";
2714
+ name?: string;
2715
+ }[];
2716
+ /** @description Whether to sort results by ascending or descending order. */
2717
+ asc?: boolean;
2655
2718
  };
2656
2719
  /** @description Fields to include in the facets, if [] then all */
2657
2720
  facet_fields?: string[];
@@ -2942,6 +3005,14 @@ export interface components {
2942
3005
  minimum_cluster_size_filter_type?: "or" | "and";
2943
3006
  cluster_page?: number;
2944
3007
  cluster_page_size?: number;
3008
+ sort_metrics?: {
3009
+ field?: string;
3010
+ fields?: string[];
3011
+ agg?: "avg" | "average" | "cardinality" | "max" | "mean" | "min" | "sum" | "percentiles" | "sum_of_squares" | "variance" | "std_deviation" | "std_deviation_bounds" | "kurtosis" | "covariance" | "skewness" | "character_count" | "count" | "correlation" | "missing";
3012
+ name?: string;
3013
+ }[];
3014
+ /** @description Whether to sort results by ascending or descending order. */
3015
+ asc?: boolean;
2945
3016
  };
2946
3017
  /** @description Whether to include relevance scores for each item in each cluster. */
2947
3018
  include_relevance?: boolean;
@@ -3210,6 +3281,14 @@ export interface components {
3210
3281
  minimum_cluster_size_filter_type?: "or" | "and";
3211
3282
  cluster_page?: number;
3212
3283
  cluster_page_size?: number;
3284
+ sort_metrics?: {
3285
+ field?: string;
3286
+ fields?: string[];
3287
+ agg?: "avg" | "average" | "cardinality" | "max" | "mean" | "min" | "sum" | "percentiles" | "sum_of_squares" | "variance" | "std_deviation" | "std_deviation_bounds" | "kurtosis" | "covariance" | "skewness" | "character_count" | "count" | "correlation" | "missing";
3288
+ name?: string;
3289
+ }[];
3290
+ /** @description Whether to sort results by ascending or descending order. */
3291
+ asc?: boolean;
3213
3292
  };
3214
3293
  /** @description Whether to include relevance scores for each item in each cluster. */
3215
3294
  include_relevance?: boolean;
@@ -3665,6 +3744,7 @@ export interface components {
3665
3744
  GetFileUploadUrlsForDatasetInput: {
3666
3745
  /** @description files we be accessible under a url that will be returned in the output. */
3667
3746
  files: string[];
3747
+ include_file_path_in_url?: boolean;
3668
3748
  };
3669
3749
  GetFileUploadUrlsForDatasetOutput: {
3670
3750
  files: {
@@ -3672,6 +3752,12 @@ export interface components {
3672
3752
  url: string;
3673
3753
  }[];
3674
3754
  };
3755
+ ListFileUploadsForDatasetInput: unknown;
3756
+ ListFileUploadsForDatasetOutput: {
3757
+ files: {
3758
+ url: string;
3759
+ }[];
3760
+ };
3675
3761
  ParseBlobInput: {
3676
3762
  /** @description Used to download the blob of documents. */
3677
3763
  blob_url: string;
@@ -7318,6 +7404,38 @@ export interface operations {
7318
7404
  };
7319
7405
  };
7320
7406
  };
7407
+ DeleteProjectInvite: {
7408
+ parameters: {};
7409
+ responses: {
7410
+ /** successful operation */
7411
+ 200: {
7412
+ content: {
7413
+ "application/json": components["schemas"]["DeleteProjectInviteOutput"];
7414
+ };
7415
+ };
7416
+ };
7417
+ requestBody: {
7418
+ content: {
7419
+ "application/json": components["schemas"]["DeleteProjectInviteInput"];
7420
+ };
7421
+ };
7422
+ };
7423
+ ResendProjectInvite: {
7424
+ parameters: {};
7425
+ responses: {
7426
+ /** successful operation */
7427
+ 200: {
7428
+ content: {
7429
+ "application/json": components["schemas"]["ResendProjectInviteOutput"];
7430
+ };
7431
+ };
7432
+ };
7433
+ requestBody: {
7434
+ content: {
7435
+ "application/json": components["schemas"]["ResendProjectInviteInput"];
7436
+ };
7437
+ };
7438
+ };
7321
7439
  GetUser: {
7322
7440
  parameters: {
7323
7441
  path: {
@@ -7910,6 +8028,23 @@ export interface operations {
7910
8028
  };
7911
8029
  };
7912
8030
  };
8031
+ /** Return up to 1000 files uploaded for a dataset. */
8032
+ ListFileUploadsForDataset: {
8033
+ parameters: {
8034
+ path: {
8035
+ /** ID of dataset */
8036
+ dataset_id: string;
8037
+ };
8038
+ };
8039
+ responses: {
8040
+ /** successful operation */
8041
+ 200: {
8042
+ content: {
8043
+ "application/json": components["schemas"]["ListFileUploadsForDatasetOutput"];
8044
+ };
8045
+ };
8046
+ };
8047
+ };
7913
8048
  /** Bulk insert a large number of documents by downloading a file using "download url". This bypasses the need to directly send documents to the api, as happens in BulkInsert. */
7914
8049
  ParseBlob: {
7915
8050
  parameters: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@relevanceai/sdk",
3
- "version": "1.16.0",
3
+ "version": "1.19.0",
4
4
  "description": "Javascript client for RelevanceAI APIs. Browser, Node.js and typescript support.",
5
5
  "main": "./dist-cjs/index.js",
6
6
  "types": "./dist-types/index.d.ts",