edge-impulse-linux 1.9.0 → 1.9.2

package/build/sdk/studio/sdk/api/jobsApi.d.ts

@@ -13,6 +13,7 @@ import { AutotuneDspRequest } from '../model/autotuneDspRequest';
 import { BuildOnDeviceModelRequest } from '../model/buildOnDeviceModelRequest';
 import { BuildOrganizationOnDeviceModelRequest } from '../model/buildOrganizationOnDeviceModelRequest';
 import { CalculateDataQualityMetricsRequest } from '../model/calculateDataQualityMetricsRequest';
+import { CreatePreviewAIActionsJobRequest } from '../model/createPreviewAIActionsJobRequest';
 import { CreateSyntheticDataRequest } from '../model/createSyntheticDataRequest';
 import { DeployPretrainedModelRequest } from '../model/deployPretrainedModelRequest';
 import { ExportKerasBlockDataRequest } from '../model/exportKerasBlockDataRequest';
@@ -80,6 +81,7 @@ type listAllJobsQueryParams = {
     offset?: number;
     rootOnly?: boolean;
     key?: string;
+    category?: string;
 };
 type listFinishedJobsQueryParams = {
     startDate?: Date;
@@ -195,6 +197,29 @@ export declare class JobsApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Run an AI Actions job over a subset of data. This will instruct the block to apply the changes directly to your dataset. To preview, use \"createPreviewAIActionsJob\". To set the config use `updateAIAction`.
+     * @summary Create AI Actions job
+     * @param projectId Project ID
+     * @param actionId AI Action ID
+     */
+    createAIActionsJob(projectId: number, actionId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Do a dry-run of an AI Actions job over a subset of data. This will instruct the block to propose changes to data items (via \"setSampleProposedChanges\") rather than apply the changes directly.
+     * @summary Create preview AI Actions job
+     * @param projectId Project ID
+     * @param actionId AI Action ID
+     * @param createPreviewAIActionsJobRequest
+     */
+    createPreviewAIActionsJob(projectId: number, actionId: number, createPreviewAIActionsJobRequest: CreatePreviewAIActionsJobRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
     /**
      * Generate new synthetic data
      * @summary Create synthetic data
@@ -364,6 +389,7 @@ export declare class JobsApi {
      * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
      * @param rootOnly Whether to exclude jobs with a parent ID (so jobs started as part of another job)
      * @param key Job key to filter on
+     * @param category Job category to filter on
      */
     listAllJobs(projectId: number, queryParams?: listAllJobsQueryParams, options?: {
         headers: {

package/build/sdk/studio/sdk/api/jobsApi.js

@@ -489,6 +489,170 @@ class JobsApi {
             });
         });
     }
+    /**
+     * Run an AI Actions job over a subset of data. This will instruct the block to apply the changes directly to your dataset. To preview, use \"createPreviewAIActionsJob\". To set the config use `updateAIAction`.
+     * @summary Create AI Actions job
+     * @param projectId Project ID
+     * @param actionId AI Action ID
+     */
+    async createAIActionsJob(projectId, actionId, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/jobs/ai-actions/{actionId}'
+            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)))
+            .replace('{' + 'actionId' + '}', encodeURIComponent(String(actionId)));
+        let localVarQueryParameters = {};
+        let localVarHeaderParams = Object.assign({
+            'User-Agent': 'edgeimpulse-api nodejs'
+        }, this.defaultHeaders);
+        const produces = ['application/json'];
+        // give precedence to 'application/json'
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams.Accept = 'application/json';
+        }
+        else {
+            localVarHeaderParams.Accept = produces.join(',');
+        }
+        let localVarFormParams = {};
+        // verify required parameter 'projectId' is not null or undefined
+        if (projectId === null || projectId === undefined) {
+            throw new Error('Required parameter projectId was null or undefined when calling createAIActionsJob.');
+        }
+        // verify required parameter 'actionId' is not null or undefined
+        if (actionId === null || actionId === undefined) {
+            throw new Error('Required parameter actionId was null or undefined when calling createAIActionsJob.');
+        }
+        Object.assign(localVarHeaderParams, options.headers);
+        Object.assign(localVarHeaderParams, this.opts.extraHeaders);
+        let localVarUseFormData = false;
+        let localVarRequestOptions = {
+            method: 'POST',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            agentOptions: { keepAlive: false },
+            json: true,
+        };
+        let authenticationPromise = Promise.resolve();
+        authenticationPromise = authenticationPromise.then(() => this.authentications.ApiKeyAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.JWTAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.JWTHttpHeaderAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+        return authenticationPromise.then(() => {
+            if (Object.keys(localVarFormParams).length) {
+                if (localVarUseFormData) {
+                    localVarRequestOptions.formData = localVarFormParams;
+                }
+                else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+            return new Promise((resolve, reject) => {
+                localVarRequest(localVarRequestOptions, (error, response, body) => {
+                    if (error) {
+                        reject(error);
+                    }
+                    else {
+                        body = models_1.ObjectSerializer.deserialize(body, "StartJobResponse");
+                        const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
+                        if (typeof body.success === 'boolean' && !body.success) {
+                            reject(new Error(body.error || errString));
+                        }
+                        else if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                            resolve(body);
+                        }
+                        else {
+                            reject(errString);
+                        }
+                    }
+                });
+            });
+        });
+    }
+    /**
+     * Do a dry-run of an AI Actions job over a subset of data. This will instruct the block to propose changes to data items (via \"setSampleProposedChanges\") rather than apply the changes directly.
+     * @summary Create preview AI Actions job
+     * @param projectId Project ID
+     * @param actionId AI Action ID
+     * @param createPreviewAIActionsJobRequest
+     */
+    async createPreviewAIActionsJob(projectId, actionId, createPreviewAIActionsJobRequest, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/jobs/ai-actions/{actionId}/preview'
+            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)))
+            .replace('{' + 'actionId' + '}', encodeURIComponent(String(actionId)));
+        let localVarQueryParameters = {};
+        let localVarHeaderParams = Object.assign({
+            'User-Agent': 'edgeimpulse-api nodejs'
+        }, this.defaultHeaders);
+        const produces = ['application/json'];
+        // give precedence to 'application/json'
+        if (produces.indexOf('application/json') >= 0) {
+            localVarHeaderParams.Accept = 'application/json';
+        }
+        else {
+            localVarHeaderParams.Accept = produces.join(',');
+        }
+        let localVarFormParams = {};
+        // verify required parameter 'projectId' is not null or undefined
+        if (projectId === null || projectId === undefined) {
+            throw new Error('Required parameter projectId was null or undefined when calling createPreviewAIActionsJob.');
+        }
+        // verify required parameter 'actionId' is not null or undefined
+        if (actionId === null || actionId === undefined) {
+            throw new Error('Required parameter actionId was null or undefined when calling createPreviewAIActionsJob.');
+        }
+        // verify required parameter 'createPreviewAIActionsJobRequest' is not null or undefined
+        if (createPreviewAIActionsJobRequest === null || createPreviewAIActionsJobRequest === undefined) {
+            throw new Error('Required parameter createPreviewAIActionsJobRequest was null or undefined when calling createPreviewAIActionsJob.');
+        }
+        Object.assign(localVarHeaderParams, options.headers);
+        Object.assign(localVarHeaderParams, this.opts.extraHeaders);
+        let localVarUseFormData = false;
+        let localVarRequestOptions = {
+            method: 'POST',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            agentOptions: { keepAlive: false },
+            json: true,
+            body: models_1.ObjectSerializer.serialize(createPreviewAIActionsJobRequest, "CreatePreviewAIActionsJobRequest")
+        };
+        let authenticationPromise = Promise.resolve();
+        authenticationPromise = authenticationPromise.then(() => this.authentications.ApiKeyAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.JWTAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.JWTHttpHeaderAuthentication.applyToRequest(localVarRequestOptions));
+        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
+        return authenticationPromise.then(() => {
+            if (Object.keys(localVarFormParams).length) {
+                if (localVarUseFormData) {
+                    localVarRequestOptions.formData = localVarFormParams;
+                }
+                else {
+                    localVarRequestOptions.form = localVarFormParams;
+                }
+            }
+            return new Promise((resolve, reject) => {
+                localVarRequest(localVarRequestOptions, (error, response, body) => {
+                    if (error) {
+                        reject(error);
+                    }
+                    else {
+                        body = models_1.ObjectSerializer.deserialize(body, "StartJobResponse");
+                        const errString = `Failed to call "${localVarPath}", returned ${response.statusCode}: ` + response.body;
+                        if (typeof body.success === 'boolean' && !body.success) {
+                            reject(new Error(body.error || errString));
+                        }
+                        else if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
+                            resolve(body);
+                        }
+                        else {
+                            reject(errString);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * Generate new synthetic data
      * @summary Create synthetic data
@@ -1625,6 +1789,7 @@ class JobsApi {
      * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
      * @param rootOnly Whether to exclude jobs with a parent ID (so jobs started as part of another job)
      * @param key Job key to filter on
+     * @param category Job category to filter on
      */
     async listAllJobs(projectId, queryParams, options = { headers: {} }) {
         const localVarPath = this.basePath + '/api/{projectId}/jobs/all'
@@ -1664,6 +1829,9 @@ class JobsApi {
         if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.key) !== undefined) {
             localVarQueryParameters['key'] = models_1.ObjectSerializer.serialize(queryParams.key, "string");
         }
+        if ((queryParams === null || queryParams === void 0 ? void 0 : queryParams.category) !== undefined) {
+            localVarQueryParameters['category'] = models_1.ObjectSerializer.serialize(queryParams.category, "string");
+        }
         Object.assign(localVarHeaderParams, options.headers);
         Object.assign(localVarHeaderParams, this.opts.extraHeaders);
         let localVarUseFormData = false;