edge-impulse-api 1.60.5 → 1.60.7

package/build/library/sdk/api/rawDataApi.d.ts

@@ -21,6 +21,7 @@ import { EditSampleLabelRequest } from '../model/editSampleLabelRequest';
 import { FindSegmentSampleRequest } from '../model/findSegmentSampleRequest';
 import { FindSegmentSampleResponse } from '../model/findSegmentSampleResponse';
 import { GenericApiResponse } from '../model/genericApiResponse';
+import { GetAIActionsProposedChangesResponse } from '../model/getAIActionsProposedChangesResponse';
 import { GetAllImportedFromResponse } from '../model/getAllImportedFromResponse';
 import { GetAutoLabelerResponse } from '../model/getAutoLabelerResponse';
 import { GetAutoLabelerSegmentInfoResponse } from '../model/getAutoLabelerSegmentInfoResponse';
@@ -45,6 +46,7 @@ import { SaveAutoLabelerClustersRequest } from '../model/saveAutoLabelerClusters
 import { SaveAutoLabelerClustersResponse } from '../model/saveAutoLabelerClustersResponse';
 import { SegmentSampleRequest } from '../model/segmentSampleRequest';
 import { SetSampleMetadataRequest } from '../model/setSampleMetadataRequest';
+import { SetSampleProposedChangesRequest } from '../model/setSampleProposedChangesRequest';
 import { SetSampleStructuredLabelsRequest } from '../model/setSampleStructuredLabelsRequest';
 import { SplitSampleInFramesRequest } from '../model/splitSampleInFramesRequest';
 import { StartJobResponse } from '../model/startJobResponse';
@@ -589,6 +591,17 @@ export declare class RawDataApi {
             [name: string]: string;
         };
     }): Promise<FindSegmentSampleResponse>;
+    /**
+     * Get proposed changes from an AI Actions job.
+     * @summary Get AI Actions proposed changes
+     * @param projectId Project ID
+     * @param jobId Job ID
+     */
+    getAIActionsProposedChanges(projectId: number, jobId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetAIActionsProposedChangesResponse>;
     /**
      * Lists all data with an \'imported from\' metadata key. Used to check in a data source which items are already in a project.
      * @summary List data with \"imported from\" metadata key
@@ -989,6 +1002,18 @@ export declare class RawDataApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Queue up changes to an object as part of the AI Actions flow. This overwrites any previous proposed changes.
+     * @summary Propose changes
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param setSampleProposedChangesRequest
+     */
+    setSampleProposedChanges(projectId: number, sampleId: number, setSampleProposedChangesRequest: SetSampleProposedChangesRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Set structured labels for a sample. If a sample has structured labels the `label` column is ignored, and the sample is allowed to have multiple labels. An array of { startIndex, endIndex, label } needs to be passed in with labels for the complete sample (see `valuesCount` to get the upper bound). endIndex is _inclusive_. If you pass in an incorrect array (e.g. missing values) you\'ll get an error back.
      * @summary Update structured labels

package/build/library/sdk/api/rawDataApi.js

@@ -2090,6 +2090,85 @@ class RawDataApi {
             });
         });
     }
+    /**
+     * Get proposed changes from an AI Actions job.
+     * @summary Get AI Actions proposed changes
+     * @param projectId Project ID
+     * @param jobId Job ID
+     */
+    async getAIActionsProposedChanges(projectId, jobId, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/raw-data/ai-actions-preview/{jobId}/proposed-changes'
+            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)))
+            .replace('{' + 'jobId' + '}', encodeURIComponent(String(jobId)));
+        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 getAIActionsProposedChanges.');
+        }
+        // verify required parameter 'jobId' is not null or undefined
+        if (jobId === null || jobId === undefined) {
+            throw new Error('Required parameter jobId was null or undefined when calling getAIActionsProposedChanges.');
+        }
+        Object.assign(localVarHeaderParams, options.headers);
+        Object.assign(localVarHeaderParams, this.opts.extraHeaders);
+        let localVarUseFormData = false;
+        let localVarRequestOptions = {
+            method: 'GET',
+            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, "GetAIActionsProposedChangesResponse");
+                        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);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * Lists all data with an \'imported from\' metadata key. Used to check in a data source which items are already in a project.
      * @summary List data with \"imported from\" metadata key
@@ -4878,6 +4957,91 @@ class RawDataApi {
             });
         });
     }
+    /**
+     * Queue up changes to an object as part of the AI Actions flow. This overwrites any previous proposed changes.
+     * @summary Propose changes
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param setSampleProposedChangesRequest
+     */
+    async setSampleProposedChanges(projectId, sampleId, setSampleProposedChangesRequest, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/raw-data/{sampleId}/propose-changes'
+            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)))
+            .replace('{' + 'sampleId' + '}', encodeURIComponent(String(sampleId)));
+        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 setSampleProposedChanges.');
+        }
+        // verify required parameter 'sampleId' is not null or undefined
+        if (sampleId === null || sampleId === undefined) {
+            throw new Error('Required parameter sampleId was null or undefined when calling setSampleProposedChanges.');
+        }
+        // verify required parameter 'setSampleProposedChangesRequest' is not null or undefined
+        if (setSampleProposedChangesRequest === null || setSampleProposedChangesRequest === undefined) {
+            throw new Error('Required parameter setSampleProposedChangesRequest was null or undefined when calling setSampleProposedChanges.');
+        }
+        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(setSampleProposedChangesRequest, "SetSampleProposedChangesRequest")
+        };
+        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, "GenericApiResponse");
+                        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);
+                        }
+                    }
+                });
+            });
+        });
+    }
     /**
      * Set structured labels for a sample. If a sample has structured labels the `label` column is ignored, and the sample is allowed to have multiple labels. An array of { startIndex, endIndex, label } needs to be passed in with labels for the complete sample (see `valuesCount` to get the upper bound). endIndex is _inclusive_. If you pass in an incorrect array (e.g. missing values) you\'ll get an error back.
      * @summary Update structured labels