edge-impulse-linux 1.4.2 → 1.4.4

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

@@ -13,6 +13,7 @@
 import { AnomalyModelMetadataResponse } from '../model/anomalyModelMetadataResponse';
 import { AnomalyTrainedFeaturesResponse } from '../model/anomalyTrainedFeaturesResponse';
 import { ClassifyJobResponse } from '../model/classifyJobResponse';
+import { ClassifyJobResponsePage } from '../model/classifyJobResponsePage';
 import { ClassifySampleResponse } from '../model/classifySampleResponse';
 import { CountSamplesResponse } from '../model/countSamplesResponse';
 import { DSPMetadataResponse } from '../model/dSPMetadataResponse';
@@ -33,8 +34,11 @@ import { GetSampleResponse } from '../model/getSampleResponse';
 import { HasDataExplorerFeaturesResponse } from '../model/hasDataExplorerFeaturesResponse';
 import { KerasModelMetadata } from '../model/kerasModelMetadata';
 import { KerasModelTypeEnum } from '../model/kerasModelTypeEnum';
-import { ListProjectsResponse } from '../model/listProjectsResponse';
 import { ListSamplesResponse } from '../model/listSamplesResponse';
+import { ProjectDeploymentTargetsResponse } from '../model/projectDeploymentTargetsResponse';
+import { ProjectInfoSummaryResponse } from '../model/projectInfoSummaryResponse';
+import { TestPretrainedModelRequest } from '../model/testPretrainedModelRequest';
+import { TestPretrainedModelResponse } from '../model/testPretrainedModelResponse';
 import { Authentication } from '../model/models';
 import { ApiKeyAuth } from '../model/models';
 export declare enum AllowsReadOnlyApiApiKeys {
@@ -42,20 +46,109 @@ export declare enum AllowsReadOnlyApiApiKeys {
     JWTAuthentication = 1,
     JWTHttpHeaderAuthentication = 2
 }
+declare type anomalyTrainedFeaturesQueryParams = {
+    featureAx1: number;
+    featureAx2: number;
+};
+declare type classifySampleQueryParams = {
+    includeDebugInfo?: boolean;
+};
+declare type countSamplesQueryParams = {
+    category: 'training' | 'testing' | 'anomaly';
+    labels?: string;
+    filename?: string;
+    maxLength?: number;
+    minLength?: number;
+    minFrequency?: number;
+    maxFrequency?: number;
+    signatureValidity?: 'both' | 'valid' | 'invalid';
+    includeDisabled?: 'both' | 'enabled' | 'disabled';
+};
+declare type downloadBuildQueryParams = {
+    type: string;
+    modelType?: KerasModelTypeEnum;
+    engine?: DeploymentTargetEngine;
+};
+declare type downloadDspDataQueryParams = {
+    raw?: boolean;
+};
+declare type dspSampleTrainedFeaturesQueryParams = {
+    featureAx1: number;
+    featureAx2: number;
+    featureAx3: number;
+};
+declare type getClassifyJobResultQueryParams = {
+    featureExplorerOnly?: boolean;
+};
+declare type getClassifyJobResultPageQueryParams = {
+    limit?: number;
+    offset?: number;
+};
+declare type getDspRawSampleQueryParams = {
+    limitPayloadValues?: number;
+};
+declare type getDspSampleSliceQueryParams = {
+    sliceStart: number;
+    sliceEnd: number;
+};
+declare type getSampleQueryParams = {
+    limitPayloadValues?: number;
+};
+declare type getSampleAsAudioQueryParams = {
+    axisIx: number;
+    sliceStart?: number;
+    sliceEnd?: number;
+};
+declare type getSampleAsImageQueryParams = {
+    afterInputBlock?: boolean;
+};
+declare type getSampleAsVideoQueryParams = {
+    afterInputBlock?: boolean;
+};
+declare type getSampleSliceQueryParams = {
+    sliceStart: number;
+    sliceEnd: number;
+};
+declare type listSamplesQueryParams = {
+    category: 'training' | 'testing' | 'anomaly';
+    limit?: number;
+    offset?: number;
+    excludeSensors?: boolean;
+    labels?: string;
+    filename?: string;
+    maxLength?: number;
+    minLength?: number;
+    minFrequency?: number;
+    maxFrequency?: number;
+    signatureValidity?: 'both' | 'valid' | 'invalid';
+    includeDisabled?: 'both' | 'enabled' | 'disabled';
+};
+declare type runDspSampleSliceReadOnlyQueryParams = {
+    sliceStart: number;
+    sliceEnd: number;
+};
+export declare type AllowsReadOnlyApiOpts = {
+    extraHeaders?: {
+        [name: string]: string;
+    };
+};
 export declare class AllowsReadOnlyApi {
     protected _basePath: string;
     protected defaultHeaders: any;
     protected _useQuerystring: boolean;
+    protected _opts: AllowsReadOnlyApiOpts;
     protected authentications: {
         default: Authentication;
         ApiKeyAuthentication: ApiKeyAuth;
         JWTAuthentication: ApiKeyAuth;
         JWTHttpHeaderAuthentication: ApiKeyAuth;
     };
-    constructor(basePath?: string);
+    constructor(basePath?: string, opts?: AllowsReadOnlyApiOpts);
     set useQuerystring(value: boolean);
     set basePath(basePath: string);
     get basePath(): string;
+    set opts(opts: AllowsReadOnlyApiOpts);
+    get opts(): AllowsReadOnlyApiOpts;
     setDefaultAuthentication(auth: Authentication): void;
     setApiKey(key: AllowsReadOnlyApiApiKeys, value: string | undefined): void;
     /**
@@ -66,7 +159,7 @@ export declare class AllowsReadOnlyApi {
      * @param featureAx1 Feature axis 1
      * @param featureAx2 Feature axis 2
      */
-    anomalyTrainedFeatures(projectId: number, learnId: number, featureAx1: number, featureAx2: number, options?: {
+    anomalyTrainedFeatures(projectId: number, learnId: number, queryParams: anomalyTrainedFeaturesQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -88,8 +181,21 @@ export declare class AllowsReadOnlyApi {
      * @summary Classify sample
      * @param projectId Project ID
      * @param sampleId Sample ID
+     * @param includeDebugInfo Whether to return the debug information from FOMO classification.
+     */
+    classifySample(projectId: number, sampleId: number, queryParams: classifySampleQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ClassifySampleResponse>;
+    /**
+     * Classify a complete file against the specified learn block. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and classify for every window that is extracted.
+     * @summary Classify sample by learn block
+     * @param projectId Project ID
+     * @param sampleId Sample ID
+     * @param blockId Block ID
      */
-    classifySample(projectId: number, sampleId: number, options?: {
+    classifySampleByLearnBlock(projectId: number, sampleId: number, blockId: number, options?: {
         headers: {
             [name: string]: string;
         };
@@ -108,7 +214,7 @@ export declare class AllowsReadOnlyApi {
      * @param signatureValidity Include samples with either valid or invalid signatures
      * @param includeDisabled Include only enabled or disabled samples (or both)
      */
-    countSamples(projectId: number, category: 'training' | 'testing' | 'anomaly', labels?: string, filename?: string, maxLength?: number, minLength?: number, minFrequency?: number, maxFrequency?: number, signatureValidity?: 'both' | 'valid' | 'invalid', includeDisabled?: 'both' | 'enabled' | 'disabled', options?: {
+    countSamples(projectId: number, queryParams: countSamplesQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -121,7 +227,7 @@ export declare class AllowsReadOnlyApi {
      * @param modelType Optional model type of the build (if not, it uses the settings in the Keras block)
      * @param engine Optional engine for the build (if not, it uses the default engine for the deployment target)
      */
-    downloadBuild(projectId: number, type: string, modelType?: KerasModelTypeEnum, engine?: DeploymentTargetEngine, options?: {
+    downloadBuild(projectId: number, queryParams: downloadBuildQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -134,7 +240,7 @@ export declare class AllowsReadOnlyApi {
      * @param category Which of the three acquisition categories to download data from
      * @param raw Whether to download raw data or processed data. Processed data is the default.
      */
-    downloadDspData(projectId: number, dspId: number, category: 'training' | 'testing' | 'anomaly', raw?: boolean, options?: {
+    downloadDspData(projectId: number, dspId: number, category: 'training' | 'testing' | 'anomaly', queryParams: downloadDspDataQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -185,7 +291,7 @@ export declare class AllowsReadOnlyApi {
      * @param featureAx3 Feature axis 3
      * @param category Which of the three acquisition categories to download data from
      */
-    dspSampleTrainedFeatures(projectId: number, dspId: number, featureAx1: number, featureAx2: number, featureAx3: number, category: 'training' | 'testing' | 'anomaly', options?: {
+    dspSampleTrainedFeatures(projectId: number, dspId: number, category: 'training' | 'testing' | 'anomaly', queryParams: dspSampleTrainedFeaturesQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -205,12 +311,25 @@ export declare class AllowsReadOnlyApi {
      * Get classify job result, containing the result for the complete testing dataset.
      * @summary Classify job result
      * @param projectId Project ID
+     * @param featureExplorerOnly Whether to get only the classification results relevant to the feature explorer.
      */
-    getClassifyJobResult(projectId: number, options?: {
+    getClassifyJobResult(projectId: number, queryParams: getClassifyJobResultQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
     }): Promise<ClassifyJobResponse>;
+    /**
+     * Get classify job result, containing the predictions for a given page.
+     * @summary Single page of a classify job result
+     * @param projectId Project ID
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     */
+    getClassifyJobResultPage(projectId: number, queryParams: getClassifyJobResultPageQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ClassifyJobResponsePage>;
     /**
      * t-SNE2 output of the raw dataset
      * @summary Get data explorer features
@@ -250,7 +369,7 @@ export declare class AllowsReadOnlyApi {
      * @param sampleId Sample ID
      * @param limitPayloadValues Limit the number of payload values in the response
      */
-    getDspRawSample(projectId: number, dspId: number, sampleId: number, limitPayloadValues?: number, options?: {
+    getDspRawSample(projectId: number, dspId: number, sampleId: number, queryParams: getDspRawSampleQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -264,7 +383,7 @@ export declare class AllowsReadOnlyApi {
      * @param sliceStart Begin index of the slice
      * @param sliceEnd End index of the slice
      */
-    getDspSampleSlice(projectId: number, dspId: number, sampleId: number, sliceStart: number, sliceEnd: number, options?: {
+    getDspSampleSlice(projectId: number, dspId: number, sampleId: number, queryParams: getDspSampleSliceQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -351,6 +470,16 @@ export declare class AllowsReadOnlyApi {
             [name: string]: string;
         };
     }): Promise<GetPerformanceCalibrationStatusResponse>;
+    /**
+     * List a summary about this project - available for public projects.
+     * @summary Public project information
+     * @param projectId Project ID
+     */
+    getProjectInfoSummary(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ProjectInfoSummaryResponse>;
     /**
      * Get a sample.
      * @summary Get sample
@@ -358,7 +487,7 @@ export declare class AllowsReadOnlyApi {
      * @param sampleId Sample ID
      * @param limitPayloadValues Limit the number of payload values in the response
      */
-    getSample(projectId: number, sampleId: number, limitPayloadValues?: number, options?: {
+    getSample(projectId: number, sampleId: number, queryParams: getSampleQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -372,7 +501,7 @@ export declare class AllowsReadOnlyApi {
      * @param sliceStart Begin index of the slice
      * @param sliceEnd End index of the slice
      */
-    getSampleAsAudio(projectId: number, sampleId: number, axisIx: number, sliceStart?: number, sliceEnd?: number, options?: {
+    getSampleAsAudio(projectId: number, sampleId: number, queryParams: getSampleAsAudioQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -384,7 +513,7 @@ export declare class AllowsReadOnlyApi {
      * @param sampleId Sample ID
      * @param afterInputBlock Whether to process the image through the input block first
      */
-    getSampleAsImage(projectId: number, sampleId: number, afterInputBlock?: boolean, options?: {
+    getSampleAsImage(projectId: number, sampleId: number, queryParams: getSampleAsImageQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -407,7 +536,7 @@ export declare class AllowsReadOnlyApi {
      * @param sampleId Sample ID
      * @param afterInputBlock Whether to process the image through the input block first
      */
-    getSampleAsVideo(projectId: number, sampleId: number, afterInputBlock?: boolean, options?: {
+    getSampleAsVideo(projectId: number, sampleId: number, queryParams: getSampleAsVideoQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -420,7 +549,7 @@ export declare class AllowsReadOnlyApi {
      * @param sliceStart Begin index of the slice
      * @param sliceEnd End index of the slice
      */
-    getSampleSlice(projectId: number, sampleId: number, sliceStart: number, sliceEnd: number, options?: {
+    getSampleSlice(projectId: number, sampleId: number, queryParams: getSampleSliceQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -463,7 +592,7 @@ export declare class AllowsReadOnlyApi {
         headers: {
             [name: string]: string;
         };
-    }): Promise<DeploymentTargetsResponse>;
+    }): Promise<ProjectDeploymentTargetsResponse>;
     /**
      * List deployment targets for a project from data sources page  (it shows some things like all Linux deploys, and hides \'fake\' deploy targets like mobile phone / computer)
      * @summary Deployment targets (data sources)
@@ -474,15 +603,6 @@ export declare class AllowsReadOnlyApi {
             [name: string]: string;
         };
     }): Promise<DeploymentTargetsResponse>;
-    /**
-     * Retrieve list of active projects. If authenticating using JWT token this lists all the projects the user has access to, if authenticating using an API key, this only lists that project.
-     * @summary List active projects
-     */
-    listProjects(options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<ListProjectsResponse>;
     /**
      * Retrieve all raw data by category.
      * @summary List samples
@@ -500,7 +620,7 @@ export declare class AllowsReadOnlyApi {
      * @param signatureValidity Include samples with either valid or invalid signatures
      * @param includeDisabled Include only enabled or disabled samples (or both)
      */
-    listSamples(projectId: number, category: 'training' | 'testing' | 'anomaly', limit?: number, offset?: number, excludeSensors?: boolean, labels?: string, filename?: string, maxLength?: number, minLength?: number, minFrequency?: number, maxFrequency?: number, signatureValidity?: 'both' | 'valid' | 'invalid', includeDisabled?: 'both' | 'enabled' | 'disabled', options?: {
+    listSamples(projectId: number, queryParams: listSamplesQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
@@ -514,9 +634,21 @@ export declare class AllowsReadOnlyApi {
      * @param sliceStart Begin index of the slice
      * @param sliceEnd End index of the slice
      */
-    runDspSampleSliceReadOnly(projectId: number, dspId: number, sampleId: number, sliceStart: number, sliceEnd: number, options?: {
+    runDspSampleSliceReadOnly(projectId: number, dspId: number, sampleId: number, queryParams: runDspSampleSliceReadOnlyQueryParams, options?: {
         headers: {
             [name: string]: string;
         };
     }): Promise<DspRunResponseWithSample>;
+    /**
+     * Test out a pretrained model (using raw features) - upload first via  `uploadPretrainedModel`. If you want to deploy a pretrained model from the API, see `startDeployPretrainedModelJob`.
+     * @summary Test pretrained model
+     * @param projectId Project ID
+     * @param testPretrainedModelRequest
+     */
+    testPretrainedModel(projectId: number, testPretrainedModelRequest?: TestPretrainedModelRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<TestPretrainedModelResponse>;
 }
+export {};