edge-impulse-api 1.93.22 → 1.93.24

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
@@ -11866,30 +11876,11 @@ export const ActorOAuthClientTypeEnumValues: string[];
 
 
 export type ActorProjectApiKey = {
-    id: number;
-    apiKey: string;
-    isDevelopmentKey: boolean;
+    type: ActorProjectApiKeyTypeEnum;
     name: string;
     created: Date;
-    role: ActorProjectApiKeyRoleEnum;
     createdByUser?: CreatedUpdatedByUser;
-    /**
-    * When this API key was last used.
-    */
-    lastUsed?: ProjectApiKeyLastUsed;
-    /**
-    * If the key has a ttl set, when the key will expire
-    */
-    expires?: Date;
-    /**
-    * OAuth client_id that created this API key through an OAuth-scoped key endpoint.
-    */
-    createdViaOAuthClientId?: string;
-    createdForExtension?: ApiKeyExtension;
-    type: ActorProjectApiKeyTypeEnum;
 };
-export type ActorProjectApiKeyRoleEnum = 'admin' | 'readonly' | 'ingestiononly' | 'ingestion_deployment' | 'wladmin';
-export const ActorProjectApiKeyRoleEnumValues: string[];
 export type ActorProjectApiKeyTypeEnum = 'projectApiKey';
 export const ActorProjectApiKeyTypeEnumValues: string[];
 
@@ -14393,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
@@ -16168,7 +16185,7 @@ export type DatasetVersionSummary = {
 };
 
 
-export type DatasetVersionType = 'auto_save' | 'restore';
+export type DatasetVersionType = 'auto_save' | 'restore' | 'manual';
 export const DatasetVersionTypeValues: string[];
 
 
@@ -28774,8 +28791,16 @@ export type VlmCandidateLabelItem = {
 
 export type VlmCandidateLabelMap = {
     version: number;
+    data: VlmCandidateLabelsSingle;
+};
+
+
+export type VlmCandidateLabelsSingle = {
+    type: VlmCandidateLabelsSingleTypeEnum;
     candidateLabels: VlmCandidateLabelItem[];
 };
+export type VlmCandidateLabelsSingleTypeEnum = 'single';
+export const VlmCandidateLabelsSingleTypeEnumValues: string[];
 
 
 export type VlmConfigResponse = {
@@ -28797,6 +28822,7 @@ export type VlmConfiguration = {
     candidateLabelsMap?: VlmCandidateLabelMap;
     promptComponents?: VlmPromptComponentConfig;
     parameters?: VlmPromptConfigParameters;
+    labelingMethod: ProjectLabelingMethod;
     /**
     * Unique configuration ID, updated each time the config is changed
     */
@@ -28810,6 +28836,7 @@ export type VlmConfigurationBase = {
     candidateLabelsMap?: VlmCandidateLabelMap;
     promptComponents?: VlmPromptComponentConfig;
     parameters?: VlmPromptConfigParameters;
+    labelingMethod: ProjectLabelingMethod;
 };
 
 
@@ -28873,12 +28900,7 @@ export type VlmInferenceResults = {
 
 export type VlmInferenceResultsResults = {
     sample: Sample;
-    /**
-    * Classification results for the sample, or null for pending results.
-    */
-    result: {
-        [key: string]: number;
-    } | null;
+    result: VlmResult | null;
 };
 
 
@@ -28901,11 +28923,6 @@ export type VlmModel = {
     * If true, the warmup endpoint may be called to prepare the model for inference
     */
     requiresWarmup?: boolean;
-    /**
-    * List of example prompt templates available for insertion. Each template is an array of components defining the
-    * prompt text and whether the component is user-editable.
-    */
-    availablePromptComponents?: VlmPromptComponent[][];
     defaultParameters: DSPGroup[];
 };
 
@@ -28919,15 +28936,12 @@ export type VlmPromptComponent = {
     * The text content of the prompt.
     */
     text: string;
-    /**
-    * Indicates whether the prompt component can be edited by the user.
-    */
-    userEditable: boolean;
 };
 
 
 export type VlmPromptComponentConfig = {
     version: number;
+    promptMode: VlmPromptMode;
     promptComponents: VlmPromptComponent[];
 };
 
@@ -28944,6 +28958,37 @@ export type VlmPromptConfigParameters = {
 };
 
 
+export type VlmPromptMode = 'single' | 'multi';
+export const VlmPromptModeValues: string[];
+
+
+/**
+* Classification results for the sample
+*/
+export type VlmResult = {
+    type: VlmResultType;
+    version: number;
+    result: {
+        /**
+        * Group key for multi-label classification
+        */
+        name?: string;
+        /**
+        * VLM zero-shot models have a single key with the value 1; CLIP models will show each candidate label's
+        * similarity
+        * score
+        */
+        scores: {
+            [key: string]: number;
+        };
+    }[];
+};
+
+
+export type VlmResultType = 'classification';
+export const VlmResultTypeValues: string[];
+
+
 export type VlmSetConfigResponse = GenericApiResponse;
 
 

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
@@ -58201,8 +58263,7 @@ define("library/sdk/model/actorProjectApiKey", ["require", "exports"], function
 "use strict";
 // Generated by studio/openapi/generate-models/convert.ts
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ActorProjectApiKeyTypeEnumValues = exports.ActorProjectApiKeyRoleEnumValues = void 0;
-exports.ActorProjectApiKeyRoleEnumValues = ['admin', 'readonly', 'ingestiononly', 'ingestion_deployment', 'wladmin'];
+exports.ActorProjectApiKeyTypeEnumValues = void 0;
 exports.ActorProjectApiKeyTypeEnumValues = ['projectApiKey'];
 });
 
@@ -59164,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
@@ -59725,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'];
 });
 
 
@@ -62056,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);
@@ -62754,6 +62823,7 @@ __exportStar(require("./verifyResetPasswordRequest"), exports);
 __exportStar(require("./verifySignupApprovalResponse"), exports);
 __exportStar(require("./vlmCandidateLabelItem"), exports);
 __exportStar(require("./vlmCandidateLabelMap"), exports);
+__exportStar(require("./vlmCandidateLabelsSingle"), exports);
 __exportStar(require("./vlmConfigResponse"), exports);
 __exportStar(require("./vlmConfiguration"), exports);
 __exportStar(require("./vlmConfigurationBase"), exports);
@@ -62770,6 +62840,9 @@ __exportStar(require("./vlmPromptComponent"), exports);
 __exportStar(require("./vlmPromptComponentConfig"), exports);
 __exportStar(require("./vlmPromptConfigParamItem"), exports);
 __exportStar(require("./vlmPromptConfigParameters"), exports);
+__exportStar(require("./vlmPromptMode"), exports);
+__exportStar(require("./vlmResult"), exports);
+__exportStar(require("./vlmResultType"), exports);
 __exportStar(require("./vlmSetConfigResponse"), exports);
 __exportStar(require("./webhookDestination"), exports);
 __exportStar(require("./whitelabel"), exports);
@@ -65446,6 +65519,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 });
 
 
+define("library/sdk/model/vlmCandidateLabelsSingle", ["require", "exports"], function (require, exports) {
+"use strict";
+// Generated by studio/openapi/generate-models/convert.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VlmCandidateLabelsSingleTypeEnumValues = void 0;
+exports.VlmCandidateLabelsSingleTypeEnumValues = ['single'];
+});
+
+
 define("library/sdk/model/vlmConfigResponse", ["require", "exports"], function (require, exports) {
 "use strict";
 // Generated by studio/openapi/generate-models/convert.ts
@@ -65560,6 +65642,31 @@ Object.defineProperty(exports, "__esModule", { value: true });
 });
 
 
+define("library/sdk/model/vlmPromptMode", ["require", "exports"], function (require, exports) {
+"use strict";
+// Generated by studio/openapi/generate-models/convert.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VlmPromptModeValues = void 0;
+exports.VlmPromptModeValues = ['single', 'multi'];
+});
+
+
+define("library/sdk/model/vlmResult", ["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/vlmResultType", ["require", "exports"], function (require, exports) {
+"use strict";
+// Generated by studio/openapi/generate-models/convert.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VlmResultTypeValues = void 0;
+exports.VlmResultTypeValues = ['classification'];
+});
+
+
 define("library/sdk/model/vlmSetConfigResponse", ["require", "exports"], function (require, exports) {
 "use strict";
 // Generated by studio/openapi/generate-models/convert.ts