@relevanceai/sdk 1.54.0 → 1.55.0

package/dist-cjs/generated/DiscoveryApi.js

@@ -46,6 +46,22 @@ class DiscoveryApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
+    async CreateDeployableInvite(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/deployables/{deployable_id}/invite',
+            options
+        });
+    }
+    async UpdateUsersDeployablePermissions(input, options) {
+        return this.SendRequest({
+            input,
+            method: 'post',
+            path: '/deployables/{deployable_id}/users/{user_id}/update',
+            options
+        });
+    }
     async DeleteDeployableKey(input, options) {
         return this.SendRequest({
             input,
@@ -710,11 +726,11 @@ class DiscoveryApiClient extends BaseClient_1._GenericClient {
             options
         });
     }
-    async FastSearch(input, options) {
+    async Search(input, options) {
         return this.SendRequest({
             input,
             method: 'post',
-            path: '/datasets/{dataset_id}/fast_search',
+            path: '/datasets/{dataset_id}/search',
             options
         });
     }

package/dist-es/generated/DiscoveryApi.js

@@ -126,6 +126,30 @@ var DiscoveryApiClient = /** @class */ (function (_super) {
             });
         });
     };
+    DiscoveryApiClient.prototype.CreateDeployableInvite = function (input, options) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.SendRequest({
+                        input: input,
+                        method: 'post',
+                        path: '/deployables/{deployable_id}/invite',
+                        options: options
+                    })];
+            });
+        });
+    };
+    DiscoveryApiClient.prototype.UpdateUsersDeployablePermissions = function (input, options) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.SendRequest({
+                        input: input,
+                        method: 'post',
+                        path: '/deployables/{deployable_id}/users/{user_id}/update',
+                        options: options
+                    })];
+            });
+        });
+    };
     DiscoveryApiClient.prototype.DeleteDeployableKey = function (input, options) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -1122,13 +1146,13 @@ var DiscoveryApiClient = /** @class */ (function (_super) {
             });
         });
     };
-    DiscoveryApiClient.prototype.FastSearch = function (input, options) {
+    DiscoveryApiClient.prototype.Search = function (input, options) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
                 return [2 /*return*/, this.SendRequest({
                         input: input,
                         method: 'post',
-                        path: '/datasets/{dataset_id}/fast_search',
+                        path: '/datasets/{dataset_id}/search',
                         options: options
                     })];
             });

package/dist-types/generated/DiscoveryApi.d.ts

@@ -10,6 +10,10 @@ export declare type DeleteDeployableInput = operations['DeleteDeployable']['requ
 export declare type DeleteDeployableOutput = operations['DeleteDeployable']['responses']['200']['content']['application/json'];
 export declare type CreateDeployableKeyInput = operations['CreateDeployableKey']['requestBody']['content']['application/json'];
 export declare type CreateDeployableKeyOutput = operations['CreateDeployableKey']['responses']['200']['content']['application/json'];
+export declare type CreateDeployableInviteInput = operations['CreateDeployableInvite']['requestBody']['content']['application/json'];
+export declare type CreateDeployableInviteOutput = operations['CreateDeployableInvite']['responses']['200']['content']['application/json'];
+export declare type UpdateUsersDeployablePermissionsInput = operations['UpdateUsersDeployablePermissions']['requestBody']['content']['application/json'];
+export declare type UpdateUsersDeployablePermissionsOutput = operations['UpdateUsersDeployablePermissions']['responses']['200']['content']['application/json'];
 export declare type DeleteDeployableKeyInput = operations['DeleteDeployableKey']['requestBody']['content']['application/json'];
 export declare type DeleteDeployableKeyOutput = operations['DeleteDeployableKey']['responses']['200']['content']['application/json'];
 export declare type ListDeployablesInput = {};
@@ -176,8 +180,8 @@ export declare type DeleteWhereInput = operations['DeleteWhere']['requestBody'][
 export declare type DeleteWhereOutput = operations['DeleteWhere']['responses']['200']['content']['application/json'];
 export declare type SimpleSearchPostInput = operations['SimpleSearchPost']['requestBody']['content']['application/json'];
 export declare type SimpleSearchPostOutput = operations['SimpleSearchPost']['responses']['200']['content']['application/json'];
-export declare type FastSearchInput = operations['FastSearch']['requestBody']['content']['application/json'];
-export declare type FastSearchOutput = operations['FastSearch']['responses']['200']['content']['application/json'];
+export declare type SearchInput = operations['Search']['requestBody']['content']['application/json'];
+export declare type SearchOutput = operations['Search']['responses']['200']['content']['application/json'];
 export declare type RecommendInput = operations['Recommend']['requestBody']['content']['application/json'];
 export declare type RecommendOutput = operations['Recommend']['responses']['200']['content']['application/json'];
 export declare type CloneDatasetInput = operations['CloneDataset']['requestBody']['content']['application/json'];
@@ -225,6 +229,8 @@ export declare class DiscoveryApiClient extends _GenericClient {
     UpdateDeployable(input: CommandInput<UpdateDeployableInput>, options?: _GenericMethodOptions): Promise<CommandOutput<UpdateDeployableOutput>>;
     DeleteDeployable(input: CommandInput<DeleteDeployableInput>, options?: _GenericMethodOptions): Promise<CommandOutput<DeleteDeployableOutput>>;
     CreateDeployableKey(input: CommandInput<CreateDeployableKeyInput>, options?: _GenericMethodOptions): Promise<CommandOutput<CreateDeployableKeyOutput>>;
+    CreateDeployableInvite(input: CommandInput<CreateDeployableInviteInput>, options?: _GenericMethodOptions): Promise<CommandOutput<CreateDeployableInviteOutput>>;
+    UpdateUsersDeployablePermissions(input: CommandInput<UpdateUsersDeployablePermissionsInput>, options?: _GenericMethodOptions): Promise<CommandOutput<UpdateUsersDeployablePermissionsOutput>>;
     DeleteDeployableKey(input: CommandInput<DeleteDeployableKeyInput>, options?: _GenericMethodOptions): Promise<CommandOutput<DeleteDeployableKeyOutput>>;
     ListDeployables(input: CommandInput<ListDeployablesInput>, options?: _GenericMethodOptions): Promise<CommandOutput<ListDeployablesOutput>>;
     CreateProject(input: CommandInput<CreateProjectInput>, options?: _GenericMethodOptions): Promise<CommandOutput<CreateProjectOutput>>;
@@ -308,7 +314,7 @@ export declare class DiscoveryApiClient extends _GenericClient {
     ListDocuments(input: CommandInput<ListDocumentsInput>, options?: _GenericMethodOptions): Promise<CommandOutput<ListDocumentsOutput>>;
     DeleteWhere(input: CommandInput<DeleteWhereInput>, options?: _GenericMethodOptions): Promise<CommandOutput<DeleteWhereOutput>>;
     SimpleSearchPost(input: CommandInput<SimpleSearchPostInput>, options?: _GenericMethodOptions): Promise<CommandOutput<SimpleSearchPostOutput>>;
-    FastSearch(input: CommandInput<FastSearchInput>, options?: _GenericMethodOptions): Promise<CommandOutput<FastSearchOutput>>;
+    Search(input: CommandInput<SearchInput>, options?: _GenericMethodOptions): Promise<CommandOutput<SearchOutput>>;
     Recommend(input: CommandInput<RecommendInput>, options?: _GenericMethodOptions): Promise<CommandOutput<RecommendOutput>>;
     CloneDataset(input: CommandInput<CloneDatasetInput>, options?: _GenericMethodOptions): Promise<CommandOutput<CloneDatasetOutput>>;
     PredictKNNRegression(input: CommandInput<PredictKNNRegressionInput>, options?: _GenericMethodOptions): Promise<CommandOutput<PredictKNNRegressionOutput>>;

package/dist-types/generated/_DiscoveryApiSchemaTypes.d.ts

@@ -25,6 +25,12 @@ export interface paths {
         /** Share a private deployable. */
         post: operations["CreateDeployableKey"];
     };
+    "/deployables/{deployable_id}/invite": {
+        post: operations["CreateDeployableInvite"];
+    };
+    "/deployables/{deployable_id}/users/{user_id}/update": {
+        post: operations["UpdateUsersDeployablePermissions"];
+    };
     "/deployables/{deployable_id}/private": {
         /** Unshare a shared deployable, making it private. */
         post: operations["DeleteDeployableKey"];
@@ -487,9 +493,9 @@ export interface paths {
         /** SimpleSearch is an easy way to use vector search and traditional text matching to search your dataset. It also supports filtering, sorting and aggregating results. */
         post: operations["SimpleSearchPost"];
     };
-    "/datasets/{dataset_id}/fast_search": {
+    "/datasets/{dataset_id}/search": {
         /** SimpleSearch is an easy way to use vector search and traditional text matching to search your dataset. It also supports filtering, sorting and aggregating results. */
-        post: operations["FastSearch"];
+        post: operations["Search"];
     };
     "/datasets/{dataset_id}/recommend": {
         /** Recommend documents similar to specific documents. Specify which vector field must be used for recommendation using  the documentsToRecommend property. */
@@ -620,6 +626,17 @@ export interface components {
             status: string;
             message: string;
         };
+        CreateDeployableInviteInput: {
+            email: string;
+            type: "read" | "write";
+        };
+        CreateDeployableInviteOutput: {
+            invite_code: string;
+        };
+        UpdateUsersDeployablePermissionsInput: {
+            type: "read" | "write" | "none";
+        };
+        UpdateUsersDeployablePermissionsOutput: unknown;
         DeleteDeployableKeyInput: unknown;
         DeleteDeployableKeyOutput: {
             status: string;
@@ -919,6 +936,7 @@ export interface components {
             };
             email?: string;
             user_id?: string;
+            type?: "deployable" | "project";
         };
         CreateProjectInviteOutput: {
             invite_code: string;
@@ -2417,6 +2435,8 @@ export interface components {
             };
             /** @description For each frequency in results, also return expected_frequency as cluster_size*(count(groupbyattribute)/count(dataset)). Useful for knowing if an attribute is occurring more or less than expected. */
             include_expected_frequency?: boolean;
+            /** @description Return the number of clusters in the dataset in the field "count", and the number of documents belonging to at least one cluster in "document_count". */
+            include_counts?: boolean;
         };
         AggregateClustersOutput: {
             results: {
@@ -2428,6 +2448,10 @@ export interface components {
                     count: number;
                 };
             };
+            /** @description Total number of clusters in the dataset. */
+            count?: number;
+            /** @description Total number of documents that are part of at least one cluster. */
+            document_count?: number;
         };
         ListClusterFacetsInput: {
             filters?: (Partial<{
@@ -6524,7 +6548,7 @@ export interface components {
         } & {
             aggregations: unknown;
         };
-        FastSearchInput: {
+        SearchInput: {
             filters?: (Partial<{
                 /** @description Match where document[field] is in value list. */
                 match?: {
@@ -6945,7 +6969,7 @@ export interface components {
             /** @description Used in future requests to retrieve items after these values in the sort order. */
             afterId?: unknown[];
         };
-        FastSearchOutput: {
+        SearchOutput: {
             /**
              * @description List of documents. List items are affected by page, pageSize, query, filters. Items order is affected by vectorSeachQuery, sort, textSort.
              *
@@ -7429,6 +7453,7 @@ export interface components {
                 job_message: string;
                 creation_time: string;
                 notebook_path?: string;
+                instance_type?: string;
                 dataset_id?: string;
                 status?: string;
                 params?: {
@@ -7448,6 +7473,7 @@ export interface components {
             job_message: string;
             creation_time: string;
             notebook_path?: string;
+            instance_type?: string;
             dataset_id?: string;
             status?: string;
             params?: {
@@ -7480,6 +7506,8 @@ export interface components {
             workflow_name?: string;
             /** @description Additional information of the workflow that is passed into the email. */
             additional_information?: string;
+            /** @description Whether to send an email on workflow completion. */
+            send_email?: boolean;
         };
         UpsertWorkflowStatusOutput: unknown;
         DeleteFieldChildrenInput: unknown;
@@ -7617,6 +7645,50 @@ export interface operations {
             };
         };
     };
+    CreateDeployableInvite: {
+        parameters: {
+            path: {
+                /** ID of deployable */
+                deployable_id: string;
+            };
+        };
+        responses: {
+            /** successful operation */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["CreateDeployableInviteOutput"];
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateDeployableInviteInput"];
+            };
+        };
+    };
+    UpdateUsersDeployablePermissions: {
+        parameters: {
+            path: {
+                /** ID of deployable */
+                deployable_id: string;
+                /** ID of user */
+                user_id: string;
+            };
+        };
+        responses: {
+            /** successful operation */
+            200: {
+                content: {
+                    "application/json": components["schemas"]["UpdateUsersDeployablePermissionsOutput"];
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateUsersDeployablePermissionsInput"];
+            };
+        };
+    };
     /** Unshare a shared deployable, making it private. */
     DeleteDeployableKey: {
         parameters: {
@@ -9635,7 +9707,7 @@ export interface operations {
         };
     };
     /** SimpleSearch is an easy way to use vector search and traditional text matching to search your dataset. It also supports filtering, sorting and aggregating results. */
-    FastSearch: {
+    Search: {
         parameters: {
             path: {
                 /** ID of dataset */
@@ -9646,13 +9718,13 @@ export interface operations {
             /** successful operation */
             200: {
                 content: {
-                    "application/json": components["schemas"]["FastSearchOutput"];
+                    "application/json": components["schemas"]["SearchOutput"];
                 };
             };
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["FastSearchInput"];
+                "application/json": components["schemas"]["SearchInput"];
             };
         };
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@relevanceai/sdk",
-  "version": "1.54.0",
+  "version": "1.55.0",
   "description": "Javascript client for RelevanceAI APIs. Browser, Node.js and typescript support.",
   "main": "./dist-cjs/index.js",
   "types": "./dist-types/index.d.ts",