edge-impulse-api 1.22.1 → 1.22.2

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

@@ -0,0 +1,502 @@
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AutotuneDspRequest } from '../model/autotuneDspRequest';
+import { BuildOnDeviceModelRequest } from '../model/buildOnDeviceModelRequest';
+import { BuildOrganizationOnDeviceModelRequest } from '../model/buildOrganizationOnDeviceModelRequest';
+import { DeployPretrainedModelRequest } from '../model/deployPretrainedModelRequest';
+import { ExportOriginalDataRequest } from '../model/exportOriginalDataRequest';
+import { ExportWavDataRequest } from '../model/exportWavDataRequest';
+import { GenerateFeaturesRequest } from '../model/generateFeaturesRequest';
+import { GenericApiResponse } from '../model/genericApiResponse';
+import { GetJobResponse } from '../model/getJobResponse';
+import { JobSummaryResponse } from '../model/jobSummaryResponse';
+import { ListJobsResponse } from '../model/listJobsResponse';
+import { LogStdoutResponse } from '../model/logStdoutResponse';
+import { ProfileTfLiteRequest } from '../model/profileTfLiteRequest';
+import { ProfileTfLiteResponse } from '../model/profileTfLiteResponse';
+import { ProjectVersionRequest } from '../model/projectVersionRequest';
+import { RestoreProjectFromPublicRequest } from '../model/restoreProjectFromPublicRequest';
+import { RestoreProjectRequest } from '../model/restoreProjectRequest';
+import { SetKerasParameterRequest } from '../model/setKerasParameterRequest';
+import { StartJobResponse } from '../model/startJobResponse';
+import { StartPerformanceCalibrationRequest } from '../model/startPerformanceCalibrationRequest';
+import { StartTrainingRequestAnomaly } from '../model/startTrainingRequestAnomaly';
+import { UpdateJobRequest } from '../model/updateJobRequest';
+import { Authentication } from '../model/models';
+import { ApiKeyAuth } from '../model/models';
+export declare enum JobsApiApiKeys {
+    ApiKeyAuthentication = 0,
+    JWTAuthentication = 1,
+    JWTHttpHeaderAuthentication = 2
+}
+declare type buildOnDeviceModelJobQueryParams = {
+    type: string;
+};
+declare type cancelJobQueryParams = {
+    forceCancel?: string;
+};
+declare type downloadJobsLogsQueryParams = {
+    limit?: number;
+    logLevel?: 'error' | 'warn' | 'info' | 'debug';
+};
+declare type getJobsLogsQueryParams = {
+    limit?: number;
+    logLevel?: 'error' | 'warn' | 'info' | 'debug';
+};
+declare type getJobsSummaryQueryParams = {
+    startDate: Date;
+    endDate: Date;
+};
+declare type listActiveJobsQueryParams = {
+    rootOnly?: boolean;
+};
+declare type listAllJobsQueryParams = {
+    startDate?: Date;
+    endDate?: Date;
+    limit?: number;
+    offset?: number;
+    rootOnly?: boolean;
+};
+declare type listFinishedJobsQueryParams = {
+    startDate?: Date;
+    endDate?: Date;
+    limit?: number;
+    offset?: number;
+    rootOnly?: boolean;
+};
+declare type setTunerPrimaryJobQueryParams = {
+    trialId: string;
+};
+export declare type JobsApiOpts = {
+    extraHeaders?: {
+        [name: string]: string;
+    };
+};
+export declare class JobsApi {
+    protected _basePath: string;
+    protected defaultHeaders: any;
+    protected _useQuerystring: boolean;
+    protected _opts: JobsApiOpts;
+    protected authentications: {
+        default: Authentication;
+        ApiKeyAuthentication: ApiKeyAuth;
+        JWTAuthentication: ApiKeyAuth;
+        JWTHttpHeaderAuthentication: ApiKeyAuth;
+    };
+    constructor(basePath?: string, opts?: JobsApiOpts);
+    set useQuerystring(value: boolean);
+    set basePath(basePath: string);
+    get basePath(): string;
+    set opts(opts: JobsApiOpts);
+    get opts(): JobsApiOpts;
+    setDefaultAuthentication(auth: Authentication): void;
+    setApiKey(key: JobsApiApiKeys, value: string | undefined): void;
+    /**
+     * Autotune DSP block parameters. Updates are streamed over the websocket API.
+     * @summary Autotune DSP parameters
+     * @param projectId Project ID
+     * @param autotuneDspRequest
+     */
+    autotuneDspJob(projectId: number, autotuneDspRequest: AutotuneDspRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Generate code to run the impulse on an embedded device. When this step is complete use `downloadBuild` to download the artefacts.  Updates are streamed over the websocket API.
+     * @summary Build on-device model
+     * @param projectId Project ID
+     * @param type The name of the built target. You can find this by listing all deployment targets through &#x60;listDeploymentTargetsForProject&#x60; (via &#x60;GET /v1/api/{projectId}/deployment/targets&#x60;) and see the &#x60;format&#x60; type.
+     * @param buildOnDeviceModelRequest
+     */
+    buildOnDeviceModelJob(projectId: number, buildOnDeviceModelRequest: BuildOnDeviceModelRequest, queryParams: buildOnDeviceModelJobQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Generate code to run the impulse on an embedded device using an organizational deployment block. When this step is complete use `downloadBuild` to download the artefacts.  Updates are streamed over the websocket API.
+     * @summary Build organizational on-device model
+     * @param projectId Project ID
+     * @param buildOrganizationOnDeviceModelRequest
+     */
+    buildOrganizationOnDeviceModelJob(projectId: number, buildOrganizationOnDeviceModelRequest: BuildOrganizationOnDeviceModelRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Cancel a running job.
+     * @summary Cancel job
+     * @param projectId Project ID
+     * @param jobId Job ID
+     * @param forceCancel If set to \&#39;true\&#39;, we won\&#39;t wait for the job cluster to cancel the job, and will mark the job as finished.
+     */
+    cancelJob(projectId: number, jobId: number, queryParams: cancelJobQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Download the logs for a job (as a text file).
+     * @summary Download logs
+     * @param projectId Project ID
+     * @param jobId Job ID
+     * @param limit Maximum number of results
+     * @param logLevel Log level (error, warn, info, debug)
+     */
+    downloadJobsLogs(projectId: number, jobId: number, queryParams: downloadJobsLogsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<string>;
+    /**
+     * Export the training pipeline of a Keras block. Updates are streamed over the websocket API.
+     * @summary Export Keras block
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     */
+    exportKerasBlock(projectId: number, learnId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Export the data of a Keras block (already split in train/validate data). Updates are streamed over the websocket API.
+     * @summary Export Keras block data
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     */
+    exportKerasBlockData(projectId: number, learnId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Generate features for the data explorer
+     * @summary Generate data explorer features
+     * @param projectId Project ID
+     */
+    generateDataExplorerFeatures(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Take the raw training set and generate features from them. Updates are streamed over the websocket API.
+     * @summary Generate features
+     * @param projectId Project ID
+     * @param generateFeaturesRequest
+     */
+    generateFeaturesJob(projectId: number, generateFeaturesRequest: GenerateFeaturesRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Get the status for a job.
+     * @summary Get job status
+     * @param projectId Project ID
+     * @param jobId Job ID
+     */
+    getJobStatus(projectId: number, jobId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetJobResponse>;
+    /**
+     * Get the logs for a job.
+     * @summary Get logs
+     * @param projectId Project ID
+     * @param jobId Job ID
+     * @param limit Maximum number of results
+     * @param logLevel Log level (error, warn, info, debug)
+     */
+    getJobsLogs(projectId: number, jobId: number, queryParams: getJobsLogsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<LogStdoutResponse>;
+    /**
+     * Get a summary of jobs, grouped by key. Used to report to users how much compute they\'ve used.
+     * @summary Job summary
+     * @param projectId Project ID
+     * @param startDate Start date
+     * @param endDate End date
+     */
+    getJobsSummary(projectId: number, queryParams: getJobsSummaryQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<JobSummaryResponse>;
+    /**
+     * Get the results from a job started from startProfileTfliteJob (via a GET request).
+     * @summary Get TFLite profile result (GET)
+     * @param projectId Project ID
+     * @param jobId Job ID
+     */
+    getProfileTfliteJobResult(projectId: number, jobId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ProfileTfLiteResponse>;
+    /**
+     * Get the results from a job started from startProfileTfliteJob (via a POST request).
+     * @summary Get TFLite profile result (POST)
+     * @param projectId Project ID
+     * @param jobId Job ID
+     */
+    getProfileTfliteJobResultViaPostRequest(projectId: number, jobId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ProfileTfLiteResponse>;
+    /**
+     * Get all active jobs for this project
+     * @summary List active jobs
+     * @param projectId Project ID
+     * @param rootOnly Whether to exclude jobs with a parent ID (so jobs started as part of another job)
+     */
+    listActiveJobs(projectId: number, queryParams: listActiveJobsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListJobsResponse>;
+    /**
+     * Get all jobs for this project
+     * @summary List all jobs
+     * @param projectId Project ID
+     * @param startDate Start date
+     * @param endDate End date
+     * @param limit Maximum number of results
+     * @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)
+     */
+    listAllJobs(projectId: number, queryParams: listAllJobsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListJobsResponse>;
+    /**
+     * Get all finished jobs for this project
+     * @summary List finished jobs
+     * @param projectId Project ID
+     * @param startDate Start date
+     * @param endDate End date
+     * @param limit Maximum number of results
+     * @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)
+     */
+    listFinishedJobs(projectId: number, queryParams: listFinishedJobsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListJobsResponse>;
+    /**
+     * Evaluates optimal model architecture
+     * @summary Optimize model
+     * @param projectId Project ID
+     * @param setKerasParameterRequest
+     */
+    optimizeJob(projectId: number, setKerasParameterRequest: SetKerasParameterRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Sets EON tuner primary model
+     * @summary Sets EON tuner primary model
+     * @param projectId Project ID
+     * @param trialId trial ID
+     */
+    setTunerPrimaryJob(projectId: number, queryParams: setTunerPrimaryJobQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Classifies all items in the testing dataset against the current impulse. Updates are streamed over the websocket API.
+     * @summary Classify
+     * @param projectId Project ID
+     */
+    startClassifyJob(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Takes in a TFLite file and builds the model and SDK. Updates are streamed over the websocket API (or can be retrieved through the /stdout endpoint). Use getProfileTfliteJobResult to get the results when the job is completed.
+     * @summary Deploy pretrained model
+     * @param projectId Project ID
+     * @param deployPretrainedModelRequest
+     */
+    startDeployPretrainedModelJob(projectId: number, deployPretrainedModelRequest: DeployPretrainedModelRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Evaluates every variant of the current impulse. Updates are streamed over the websocket API.
+     * @summary Evaluate
+     * @param projectId Project ID
+     */
+    startEvaluateJob(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Add keywords and noise data to a project (for getting started guide)
+     * @summary Add keywords and noise
+     * @param projectId Project ID
+     */
+    startKeywordsNoiseJob(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Make a version of a project public. This makes all data and state available (read-only) on a public URL, and allows users to clone this project.
+     * @summary Make a version public
+     * @param projectId Project ID
+     * @param versionId Version ID
+     */
+    startMakeVersionPublicJob(projectId: number, versionId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Export all the data in the project as it was uploaded to Edge Impulse.  Updates are streamed over the websocket API.
+     * @summary Export original data
+     * @param projectId Project ID
+     * @param exportOriginalDataRequest
+     */
+    startOriginalExportJob(projectId: number, exportOriginalDataRequest: ExportOriginalDataRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Simulates real world usage and returns performance metrics.
+     * @summary Performance Calibration
+     * @param projectId Project ID
+     * @param startPerformanceCalibrationRequest
+     */
+    startPerformanceCalibrationJob(projectId: number, startPerformanceCalibrationRequest: StartPerformanceCalibrationRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Takes in a TFLite model and returns the latency, RAM and ROM used for this model. Updates are streamed over the websocket API (or can be retrieved through the /stdout endpoint). Use getProfileTfliteJobResult to get the results when the job is completed.
+     * @summary Profile TFLite model
+     * @param projectId Project ID
+     * @param profileTfLiteRequest
+     */
+    startProfileTfliteJob(projectId: number, profileTfLiteRequest: ProfileTfLiteRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Restore a project to a certain version. This can only applied to a project without data, and will overwrite your impulse and all settings.
+     * @summary Restore project to version
+     * @param projectId Project ID
+     * @param restoreProjectRequest
+     */
+    startRestoreJob(projectId: number, restoreProjectRequest: RestoreProjectRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Restore a project to a certain public version. This can only applied to a project without data, and will overwrite your impulse and all settings.
+     * @summary Restore project to public version
+     * @param projectId Project ID
+     * @param restoreProjectFromPublicRequest
+     */
+    startRestoreJobFromPublic(projectId: number, restoreProjectFromPublicRequest: RestoreProjectFromPublicRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Retrains the current impulse with the last known parameters. Updates are streamed over the websocket API.
+     * @summary Retrain
+     * @param projectId Project ID
+     */
+    startRetrainJob(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Create a new version of the project. This stores all data and configuration offsite. If you have access to the enterprise version of Edge Impulse you can store your data in your own storage buckets (only through JWT token authentication).
+     * @summary Version project
+     * @param projectId Project ID
+     * @param projectVersionRequest
+     */
+    startVersionJob(projectId: number, projectVersionRequest: ProjectVersionRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Export all the data in the project in WAV format.  Updates are streamed over the websocket API.
+     * @summary Export data as WAV
+     * @param projectId Project ID
+     * @param exportWavDataRequest
+     */
+    startWavExportJob(projectId: number, exportWavDataRequest: ExportWavDataRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Take the output from a DSP block and train an anomaly detection model using K-means or GMM. Updates are streamed over the websocket API.
+     * @summary Train model (Anomaly)
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     * @param startTrainingRequestAnomaly
+     */
+    trainAnomalyJob(projectId: number, learnId: number, startTrainingRequestAnomaly: StartTrainingRequestAnomaly, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Take the output from a DSP block and train a neural network using Keras. Updates are streamed over the websocket API.
+     * @summary Train model (Keras)
+     * @param projectId Project ID
+     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
+     * @param setKerasParameterRequest
+     */
+    trainKerasJob(projectId: number, learnId: number, setKerasParameterRequest: SetKerasParameterRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<StartJobResponse>;
+    /**
+     * Update a job.
+     * @summary Update job
+     * @param projectId Project ID
+     * @param jobId Job ID
+     * @param updateJobRequest
+     */
+    updateJob(projectId: number, jobId: number, updateJobRequest: UpdateJobRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+}
+export {};