edge-impulse-linux 1.8.10 → 1.9.1

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

@@ -13,24 +13,28 @@
 import { AddCollaboratorRequest } from '../model/addCollaboratorRequest';
 import { AddHmacKeyRequest } from '../model/addHmacKeyRequest';
 import { AddProjectApiKeyRequest } from '../model/addProjectApiKeyRequest';
+import { CreateAIActionResponse } from '../model/createAIActionResponse';
 import { CreateProjectRequest } from '../model/createProjectRequest';
 import { CreateProjectResponse } from '../model/createProjectResponse';
 import { DevelopmentBoardsResponse } from '../model/developmentBoardsResponse';
 import { DevelopmentKeysResponse } from '../model/developmentKeysResponse';
 import { GenericApiResponse } from '../model/genericApiResponse';
+import { GetAIActionResponse } from '../model/getAIActionResponse';
 import { GetCsvWizardUploadedFileInfo } from '../model/getCsvWizardUploadedFileInfo';
 import { GetModelVariantsResponse } from '../model/getModelVariantsResponse';
-import { GetNotesResponse } from '../model/getNotesResponse';
 import { GetSyntheticDataConfigResponse } from '../model/getSyntheticDataConfigResponse';
 import { GetTargetConstraintsResponse } from '../model/getTargetConstraintsResponse';
 import { LastModificationDateResponse } from '../model/lastModificationDateResponse';
+import { ListAIActionsResponse } from '../model/listAIActionsResponse';
 import { ListApiKeysResponse } from '../model/listApiKeysResponse';
 import { ListEmailResponse } from '../model/listEmailResponse';
 import { ListHmacKeysResponse } from '../model/listHmacKeysResponse';
 import { ListProjectsResponse } from '../model/listProjectsResponse';
 import { ListPublicProjectsResponse } from '../model/listPublicProjectsResponse';
 import { ListPublicVersionsResponse } from '../model/listPublicVersionsResponse';
+import { ListSamplesResponse } from '../model/listSamplesResponse';
 import { ListVersionsResponse } from '../model/listVersionsResponse';
+import { PreviewAIActionsSamplesRequest } from '../model/previewAIActionsSamplesRequest';
 import { ProjectDataAxesSummaryResponse } from '../model/projectDataAxesSummaryResponse';
 import { ProjectDataIntervalResponse } from '../model/projectDataIntervalResponse';
 import { ProjectDismissNotificationRequest } from '../model/projectDismissNotificationRequest';
@@ -39,11 +43,13 @@ import { ProjectInfoResponse } from '../model/projectInfoResponse';
 import { ProjectInfoSummaryResponse } from '../model/projectInfoSummaryResponse';
 import { ProjectTrainingDataSummaryResponse } from '../model/projectTrainingDataSummaryResponse';
 import { RemoveCollaboratorRequest } from '../model/removeCollaboratorRequest';
+import { SetAIActionsOrderRequest } from '../model/setAIActionsOrderRequest';
 import { SetProjectComputeTimeRequest } from '../model/setProjectComputeTimeRequest';
 import { SetProjectDspFileSizeRequest } from '../model/setProjectDspFileSizeRequest';
 import { SocketTokenResponse } from '../model/socketTokenResponse';
 import { TargetConstraints } from '../model/targetConstraints';
 import { TransferOwnershipOrganizationRequest } from '../model/transferOwnershipOrganizationRequest';
+import { UpdateAIActionRequest } from '../model/updateAIActionRequest';
 import { UpdateProjectRequest } from '../model/updateProjectRequest';
 import { UpdateProjectTagsRequest } from '../model/updateProjectTagsRequest';
 import { UpdateVersionRequest } from '../model/updateVersionRequest';
@@ -56,10 +62,16 @@ export declare enum ProjectsApiApiKeys {
     JWTAuthentication = 1,
     JWTHttpHeaderAuthentication = 2
 }
+type getModelVariantsQueryParams = {
+    impulseId?: number;
+};
 type getProjectDataAxesSummaryQueryParams = {
     includeDisabled?: boolean;
     includeNotProcessed?: boolean;
 };
+type getProjectInfoQueryParams = {
+    impulseId?: number;
+};
 type getProjectTrainingDataSummaryQueryParams = {
     includeDisabled?: boolean;
     includeNotProcessed?: boolean;
@@ -68,11 +80,12 @@ type listPublicProjectsQueryParams = {
     limit?: number;
     offset?: number;
     project?: string;
+    projectTypes?: string;
 };
-type uploadCsvWizardUploadedFileFormParams = {
+export type uploadCsvWizardUploadedFileFormParams = {
     file: RequestFile;
 };
-type uploadReadmeImageFormParams = {
+export type uploadReadmeImageFormParams = {
     image: RequestFile;
 };
 export type ProjectsApiOpts = {
@@ -132,6 +145,27 @@ export declare class ProjectsApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Remove all proposed changes for an AI Actions job.
+     * @summary Clear AI Actions proposed changes
+     * @param projectId Project ID
+     * @param actionId AI Action ID
+     */
+    clearAIActionsProposedChanges(projectId: number, actionId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Create a new AI Action.
+     * @summary Create AI Action
+     * @param projectId Project ID
+     */
+    createAIAction(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<CreateAIActionResponse>;
     /**
      * Create a new project. This API can only be called using a JWT token.
      * @summary Create new project
@@ -142,6 +176,17 @@ export declare class ProjectsApi {
             [name: string]: string;
         };
     }): Promise<CreateProjectResponse>;
+    /**
+     * Deletes an AI Actions.
+     * @summary Delete AI Actions config
+     * @param projectId Project ID
+     * @param actionId AI Action ID
+     */
+    deleteAIAction(projectId: number, actionId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Remove the current project, and all data associated with it. This is irrevocable!
      * @summary Remove project
@@ -183,6 +228,17 @@ export declare class ProjectsApi {
             [name: string]: string;
         };
     }): Promise<Buffer>;
+    /**
+     * Get an AI Actions config
+     * @summary Get AI Actions config
+     * @param projectId Project ID
+     * @param actionId AI Action ID
+     */
+    getAIAction(projectId: number, actionId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetAIActionResponse>;
     /**
      * Returns whether the file that was uploaded when the CSV wizard was configured is available.
      * @summary Get CSV Wizard uploaded file info
@@ -197,22 +253,23 @@ export declare class ProjectsApi {
      * Get a list of model variants applicable to all trained learn blocks in this project.
      * @summary Get a list of all model variants available for this project
      * @param projectId Project ID
+     * @param impulseId Impulse ID. If this is unset then the default impulse is used.
      */
-    getModelVariants(projectId: number, options?: {
+    getModelVariants(projectId: number, queryParams?: getModelVariantsQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
     }): Promise<GetModelVariantsResponse>;
     /**
-     * Get all notes in project.
-     * @summary Get notes
+     * Get the AI Actions config for a new action
+     * @summary Get new AI Actions config
      * @param projectId Project ID
      */
-    getNotes(projectId: number, options?: {
+    getNewAIAction(projectId: number, options?: {
         headers: {
             [name: string]: string;
         };
-    }): Promise<GetNotesResponse>;
+    }): Promise<GetAIActionResponse>;
     /**
      * Get a list of axes that are present in the training data.
      * @summary Get data axes summary
@@ -220,7 +277,7 @@ export declare class ProjectsApi {
      * @param includeDisabled Whether to include disabled samples. Defaults to true
      * @param includeNotProcessed Whether to include non-processed samples. Defaults to true
      */
-    getProjectDataAxesSummary(projectId: number, queryParams: getProjectDataAxesSummaryQueryParams, options?: {
+    getProjectDataAxesSummary(projectId: number, queryParams?: getProjectDataAxesSummaryQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -229,8 +286,9 @@ export declare class ProjectsApi {
      * List all information about this project.
      * @summary Project information
      * @param projectId Project ID
+     * @param impulseId Impulse ID. If this is unset then the default impulse is used.
      */
-    getProjectInfo(projectId: number, options?: {
+    getProjectInfo(projectId: number, queryParams?: getProjectInfoQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -272,7 +330,7 @@ export declare class ProjectsApi {
      * @param includeDisabled Whether to include disabled samples. Defaults to true
      * @param includeNotProcessed Whether to include non-processed samples. Defaults to true
      */
-    getProjectTrainingDataSummary(projectId: number, queryParams: getProjectTrainingDataSummaryQueryParams, options?: {
+    getProjectTrainingDataSummary(projectId: number, queryParams?: getProjectTrainingDataSummaryQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -317,6 +375,16 @@ export declare class ProjectsApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Get all AI actions.
+     * @summary List AI Actions
+     * @param projectId Project ID
+     */
+    listAIActions(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListAIActionsResponse>;
     /**
      * List all development boards for a project
      * @summary Development boards
@@ -392,8 +460,9 @@ export declare class ProjectsApi {
      * @param limit Maximum number of results
      * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
      * @param project Only include projects that contain this string
+     * @param projectTypes Comma separated list of project types to filter on. Supported values are \&#39;audio\&#39;, \&#39;object-detection\&#39;, \&#39;image\&#39;, \&#39;accelerometer\&#39;, \&#39;other\&#39;.
      */
-    listPublicProjects(queryParams: listPublicProjectsQueryParams, options?: {
+    listPublicProjects(queryParams?: listPublicProjectsQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -429,6 +498,18 @@ export declare class ProjectsApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Get a number of random samples to show in the AI Actions screen. If `saveConfig` is passed in, then a valid actionId is required in the URL. If you don\'t need to save the config (e.g. when creating a new action), you can use -1.
+     * @summary Preview samples for AI Actions
+     * @param projectId Project ID
+     * @param actionId AI Action ID
+     * @param previewAIActionsSamplesRequest
+     */
+    previewAIActionsSamples(projectId: number, actionId: number, previewAIActionsSamplesRequest: PreviewAIActionsSamplesRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListSamplesResponse>;
     /**
      * Dismiss a notification
      * @summary Dismiss a notification
@@ -473,6 +554,17 @@ export declare class ProjectsApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Change the order of AI actions. Post the new order of all AI Actions by ID. You need to specify _all_ AI Actions here. If not, an error will be thrown.
+     * @summary Set AI Actions order
+     * @param projectId Project ID
+     * @param setAIActionsOrderRequest
+     */
+    setAIActionsOrder(projectId: number, setAIActionsOrderRequest: SetAIActionsOrderRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Change the job compute time limit for the project. This function is only available through a JWT token, and is not available to all users.
      * @summary Set compute time limit
@@ -528,6 +620,18 @@ export declare class ProjectsApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Store an AI Actions config. Use `createAIActionsJob` to run the job. Post the full AI Action here w/ all parameters.
+     * @summary Save AI Actions config
+     * @param projectId Project ID
+     * @param actionId AI Action ID
+     * @param updateAIActionRequest
+     */
+    updateAIAction(projectId: number, actionId: number, updateAIActionRequest: UpdateAIActionRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Update project properties such as name and logo.
      * @summary Update project