edge-impulse-api 1.93.23 → 1.93.25

package/build/browser/edge-impulse-api.d.ts

@@ -2158,6 +2158,16 @@ export class DatasetVersionsApi {
     setDefaultAuthentication(auth: Authentication): void;
     setApiKey(key: DatasetVersionsApiApiKeys, value: string | undefined): void;
     set accessToken(token: string);
+    /**
+     * Trigger a manual snapshot of the current dataset. Snapshots are usually created automatically when dataset changes are detected, but this endpoint lets you control when one is created (for example, before a large update). The request returns immediately, and a background process typically creates the new dataset version within a few seconds. If a manual snapshot is already in progress, a null window is returned.
+     * @summary Create a new snapshot of the dataset
+     * @param projectId Project ID
+     */
+    createDatasetVersion(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<CreateDatasetVersionResponse>;
     /**
      * Get details of a specific dataset version for this project.
      * @summary Get dataset version
@@ -14374,6 +14384,32 @@ export type CreateCustomBlockUploadLinkResponse = {
 };
 
 
+export type CreateDatasetVersionResponse = {
+    /**
+    * Whether the operation succeeded
+    */
+    success: boolean;
+    /**
+    * Optional error description (set if 'success' was false)
+    */
+    error?: string;
+    window?: {
+        /**
+        * Temporary window ID that cannot be used for retrieval. The window is deleted after a successful commit.
+        */
+        windowId: number;
+        /**
+        * Date and time when this dataset version window closed.
+        */
+        closed: Date;
+        /**
+        * Date and time when this dataset version window opened.
+        */
+        opened: Date;
+    } | null;
+};
+
+
 export type CreateDeveloperProfileResponse = {
     /**
     * Whether the operation succeeded
@@ -16149,7 +16185,7 @@ export type DatasetVersionSummary = {
 };
 
 
-export type DatasetVersionType = 'auto_save' | 'restore';
+export type DatasetVersionType = 'auto_save' | 'restore' | 'manual';
 export const DatasetVersionTypeValues: string[];
 
 
@@ -26588,7 +26624,10 @@ export type StartVlmInferenceJobResponse = {
     * Optional error description (set if 'success' was false)
     */
     error?: string;
-    jobId: number;
+    /**
+    * Job identifier. Status updates will include this identifier.
+    */
+    id: number;
     configId: number;
 };
 

package/build/browser/edge-impulse-api.js

@@ -10813,6 +10813,68 @@ class DatasetVersionsApi {
     set accessToken(token) {
         this.authentications.OAuth2.accessToken = token;
     }
+    /**
+     * Trigger a manual snapshot of the current dataset. Snapshots are usually created automatically when dataset changes are detected, but this endpoint lets you control when one is created (for example, before a large update). The request returns immediately, and a background process typically creates the new dataset version within a few seconds. If a manual snapshot is already in progress, a null window is returned.
+     * @summary Create a new snapshot of the dataset
+     * @param projectId Project ID
+     */
+    async createDatasetVersion(projectId, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/api/{projectId}/dataset-versions/create'
+            .replace('{' + 'projectId' + '}', encodeURIComponent(String(projectId)));
+        let queryParameters = {};
+        let localVarHeaderParams = {
+            ...(typeof window === "undefined" ? { "User-Agent": "edgeimpulse-api nodejs" } : {}),
+            'Content-Type': 'application/json',
+            ...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 createDatasetVersion.');
+        }
+        localVarHeaderParams = {
+            ...localVarHeaderParams,
+            ...options.headers,
+            ...this.opts.extraHeaders,
+        };
+        const queryString = Object.entries(queryParameters)
+            .filter(([, value]) => value !== undefined)
+            .map(([key, value]) => `${key}=${encodeURIComponent(String(value))}`)
+            .join('&');
+        let localVarUrl = localVarPath + (queryString ? `?${queryString}` : '');
+        let localVarRequestOptions = {
+            method: 'POST',
+            headers: { ...localVarHeaderParams },
+        };
+        let requestOptions = localVarRequestOptions;
+        let url = localVarUrl;
+        const auth_ApiKeyAuthentication = await this.authentications.ApiKeyAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_ApiKeyAuthentication.requestOptions;
+        url = auth_ApiKeyAuthentication.url;
+        const auth_JWTAuthentication = await this.authentications.JWTAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTAuthentication.requestOptions;
+        url = auth_JWTAuthentication.url;
+        const auth_JWTHttpHeaderAuthentication = await this.authentications.JWTHttpHeaderAuthentication.applyToRequest(requestOptions, url);
+        requestOptions = auth_JWTHttpHeaderAuthentication.requestOptions;
+        url = auth_JWTHttpHeaderAuthentication.url;
+        const auth_OAuth2 = await this.authentications.OAuth2.applyToRequest(requestOptions, url);
+        requestOptions = auth_OAuth2.requestOptions;
+        url = auth_OAuth2.url;
+        const authDefault = await this.authentications.default.applyToRequest(requestOptions, url);
+        requestOptions = authDefault.requestOptions;
+        url = authDefault.url;
+        (0, models_1.applyFormParams)(requestOptions, localVarFormParams);
+        const response = await fetch(url, requestOptions);
+        return this.handleResponse(response, 'CreateDatasetVersionResponse');
+    }
     /**
      * Get details of a specific dataset version for this project.
      * @summary Get dataset version
@@ -59163,6 +59225,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 });
 
 
+define("library/sdk/model/createDatasetVersionResponse", ["require", "exports"], function (require, exports) {
+"use strict";
+// Generated by studio/openapi/generate-models/convert.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+});
+
+
 define("library/sdk/model/createDeveloperProfileResponse", ["require", "exports"], function (require, exports) {
 "use strict";
 // Generated by studio/openapi/generate-models/convert.ts
@@ -59724,7 +59793,7 @@ define("library/sdk/model/datasetVersionType", ["require", "exports"], function
 // Generated by studio/openapi/generate-models/convert.ts
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DatasetVersionTypeValues = void 0;
-exports.DatasetVersionTypeValues = ['auto_save', 'restore'];
+exports.DatasetVersionTypeValues = ['auto_save', 'restore', 'manual'];
 });
 
 
@@ -62055,6 +62124,7 @@ __exportStar(require("./cosineSimilarityIssue"), exports);
 __exportStar(require("./countSamplesResponse"), exports);
 __exportStar(require("./createCustomBlockUploadLinkRequest"), exports);
 __exportStar(require("./createCustomBlockUploadLinkResponse"), exports);
+__exportStar(require("./createDatasetVersionResponse"), exports);
 __exportStar(require("./createDeveloperProfileResponse"), exports);
 __exportStar(require("./createDeviceRequest"), exports);
 __exportStar(require("./createEnterpriseTrialResponse"), exports);