edge-impulse-linux 1.3.9 → 1.3.12

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

@@ -1,554 +0,0 @@
-/**
- * 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.
- */
-/// <reference types="node" />
-import http = require('http');
-import { AnomalyModelMetadataResponse } from '../model/anomalyModelMetadataResponse';
-import { AnomalyTrainedFeaturesResponse } from '../model/anomalyTrainedFeaturesResponse';
-import { ClassifyJobResponse } from '../model/classifyJobResponse';
-import { ClassifySampleResponse } from '../model/classifySampleResponse';
-import { CountSamplesResponse } from '../model/countSamplesResponse';
-import { DSPMetadataResponse } from '../model/dSPMetadataResponse';
-import { DataExplorerPredictionsResponse } from '../model/dataExplorerPredictionsResponse';
-import { DeploymentTargetsResponse } from '../model/deploymentTargetsResponse';
-import { DspRunResponseWithSample } from '../model/dspRunResponseWithSample';
-import { DspSampleFeaturesResponse } from '../model/dspSampleFeaturesResponse';
-import { DspTrainedFeaturesResponse } from '../model/dspTrainedFeaturesResponse';
-import { GetDataExplorerFeaturesResponse } from '../model/getDataExplorerFeaturesResponse';
-import { GetNotesResponse } from '../model/getNotesResponse';
-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 { Authentication } from '../model/models';
-import { ApiKeyAuth } from '../model/models';
-export declare enum AllowsReadOnlyApiApiKeys {
-    ApiKeyAuthentication = 0,
-    JWTAuthentication = 1,
-    JWTHttpHeaderAuthentication = 2
-}
-export declare class AllowsReadOnlyApi {
-    protected _basePath: string;
-    protected defaultHeaders: any;
-    protected _useQuerystring: boolean;
-    protected authentications: {
-        default: Authentication;
-        ApiKeyAuthentication: ApiKeyAuth;
-        JWTAuthentication: ApiKeyAuth;
-        JWTHttpHeaderAuthentication: ApiKeyAuth;
-    };
-    constructor(basePath?: string);
-    set useQuerystring(value: boolean);
-    set basePath(basePath: string);
-    get basePath(): string;
-    setDefaultAuthentication(auth: Authentication): void;
-    setApiKey(key: AllowsReadOnlyApiApiKeys, value: string): void;
-    /**
-     * Get a sample of trained features, this extracts a number of samples and their features.
-     * @summary Trained features
-     * @param projectId Project ID
-     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
-     * @param featureAx1 Feature axis 1
-     * @param featureAx2 Feature axis 2
-     */
-    anomalyTrainedFeatures(projectId: number, learnId: number, featureAx1: number, featureAx2: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: AnomalyTrainedFeaturesResponse;
-    }>;
-    /**
-     * Get trained features for a single sample. This runs both the DSP prerequisites and the anomaly classifier.
-     * @summary Trained features for sample
-     * @param projectId Project ID
-     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
-     * @param sampleId Sample ID
-     */
-    anomalyTrainedFeaturesPerSample(projectId: number, learnId: number, sampleId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: AnomalyTrainedFeaturesResponse;
-    }>;
-    /**
-     * Classify a complete file against the current impulse. 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
-     * @param projectId Project ID
-     * @param sampleId Sample ID
-     */
-    classifySample(projectId: number, sampleId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: ClassifySampleResponse;
-    }>;
-    /**
-     * Count all raw data by category.
-     * @summary Count samples
-     * @param projectId Project ID
-     * @param category Which of the three acquisition categories to retrieve data from
-     * @param labels Only include samples with a label within the given list of labels, given as a JSON string
-     * @param filename Only include samples whose filename includes the given filename
-     * @param maxLength Only include samples shorter than the given length, in milliseconds
-     * @param minLength Only include samples longer than the given length, in milliseconds
-     * @param minFrequency Only include samples with higher frequency than given frequency, in hertz
-     * @param maxFrequency Only include samples with lower frequency than given frequency, in hertz
-     * @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?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: CountSamplesResponse;
-    }>;
-    /**
-     * Download the build artefacts for a project
-     * @summary Download
-     * @param projectId Project ID
-     * @param type Output format
-     * @param modelType Optional model type of the build (if not, it uses the settings in the Keras block)
-     */
-    downloadBuild(projectId: number, type: string, modelType?: KerasModelTypeEnum, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: Buffer;
-    }>;
-    /**
-     * Download raw output from a DSP block over all data in the training set, already sliced in windows. In Numpy binary format.
-     * @summary Download DSP data
-     * @param projectId Project ID
-     * @param dspId DSP Block ID, use the impulse functions to retrieve the ID
-     * @param category Which of the three acquisition categories to download data from
-     */
-    downloadDspData(projectId: number, dspId: number, category: 'training' | 'testing' | 'anomaly', options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: Buffer;
-    }>;
-    /**
-     * Download labels for a DSP block over all data in the training set, already sliced in windows.
-     * @summary Download DSP labels
-     * @param projectId Project ID
-     * @param dspId DSP Block ID, use the impulse functions to retrieve the ID
-     * @param category Which of the three acquisition categories to download data from
-     */
-    downloadDspLabels(projectId: number, dspId: number, category: 'training' | 'testing' | 'anomaly', options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: Buffer;
-    }>;
-    /**
-     * Download a trained model for a learning block. Depending on the block this can be a TensorFlow model, or the cluster centroids.
-     * @summary Download trained model
-     * @param projectId Project ID
-     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
-     * @param modelDownloadId Model download ID, which can be obtained from the project information
-     */
-    downloadLearnModel(projectId: number, learnId: number, modelDownloadId: string, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: Buffer;
-    }>;
-    /**
-     * Runs the DSP block against a sample. 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 run the DSP function for every window that is extracted.
-     * @summary Features for sample
-     * @param projectId Project ID
-     * @param dspId DSP Block ID, use the impulse functions to retrieve the ID
-     * @param sampleId Sample ID
-     */
-    dspGetFeaturesForSample(projectId: number, dspId: number, sampleId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: DspSampleFeaturesResponse;
-    }>;
-    /**
-     * Get a sample of trained features, this extracts a number of samples and their labels. Used to visualize the current training set.
-     * @summary Sample of trained features
-     * @param projectId Project ID
-     * @param dspId DSP Block ID, use the impulse functions to retrieve the ID
-     * @param featureAx1 Feature axis 1
-     * @param featureAx2 Feature axis 2
-     * @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?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: DspTrainedFeaturesResponse;
-    }>;
-    /**
-     * Get metadata about a trained anomaly block. Use the impulse blocks to find the learnId.
-     * @summary Anomaly metadata
-     * @param projectId Project ID
-     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
-     */
-    getAnomalyMetadata(projectId: number, learnId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: AnomalyModelMetadataResponse;
-    }>;
-    /**
-     * Get classify job result, containing the result for the complete testing dataset.
-     * @summary Classify job result
-     * @param projectId Project ID
-     */
-    getClassifyJobResult(projectId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: ClassifyJobResponse;
-    }>;
-    /**
-     * t-SNE2 output of the raw dataset
-     * @summary Get data explorer features
-     * @param projectId Project ID
-     */
-    getDataExplorerFeatures(projectId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: GetDataExplorerFeaturesResponse;
-    }>;
-    /**
-     * Predictions for every data explorer point (only available when using current impulse to populate data explorer)
-     * @summary Get data explorer predictions
-     * @param projectId Project ID
-     */
-    getDataExplorerPredictions(projectId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: DataExplorerPredictionsResponse;
-    }>;
-    /**
-     * Retrieve the metadata from a generated DSP block.
-     * @summary Get metadata
-     * @param projectId Project ID
-     * @param dspId DSP Block ID, use the impulse functions to retrieve the ID
-     */
-    getDspMetadata(projectId: number, dspId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: DSPMetadataResponse;
-    }>;
-    /**
-     * Get raw sample data, but with only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out. If you pass dspId = 0 this will return a raw graph without any processing.
-     * @summary Get raw sample
-     * @param projectId Project ID
-     * @param dspId DSP Block ID, use the impulse functions to retrieve the ID
-     * @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?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: GetSampleResponse;
-    }>;
-    /**
-     * Get slice of raw sample data, but with only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out.
-     * @summary Get raw sample (slice)
-     * @param projectId Project ID
-     * @param dspId DSP Block ID, use the impulse functions to retrieve the ID
-     * @param sampleId Sample ID
-     * @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?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: GetSampleResponse;
-    }>;
-    /**
-     * t-SNE2 output of the raw dataset using embeddings from this Keras block
-     * @summary Get data explorer features
-     * @param projectId Project ID
-     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
-     */
-    getKerasDataExplorerFeatures(projectId: number, learnId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: GetDataExplorerFeaturesResponse;
-    }>;
-    /**
-     * Get metadata about a trained Keras block. Use the impulse blocks to find the learnId.
-     * @summary Keras metadata
-     * @param projectId Project ID
-     * @param learnId Learn Block ID, use the impulse functions to retrieve the ID
-     */
-    getKerasMetadata(projectId: number, learnId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: KerasModelMetadata;
-    }>;
-    /**
-     * Get all notes in project.
-     * @summary Get notes
-     * @param projectId Project ID
-     */
-    getNotes(projectId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: GetNotesResponse;
-    }>;
-    /**
-     * Get a sample.
-     * @summary Get sample
-     * @param projectId Project ID
-     * @param sampleId Sample ID
-     * @param limitPayloadValues Limit the number of payload values in the response
-     */
-    getSample(projectId: number, sampleId: number, limitPayloadValues?: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: GetSampleResponse;
-    }>;
-    /**
-     * Get a sample as a WAV file. This only applies to samples with an audio axis.
-     * @summary Get WAV file
-     * @param projectId Project ID
-     * @param sampleId Sample ID
-     * @param axisIx Axis index
-     * @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?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: Buffer;
-    }>;
-    /**
-     * Get a sample as an image file. This only applies to samples with RGBA data.
-     * @summary Get image file
-     * @param projectId Project ID
-     * @param sampleId Sample ID
-     * @param afterInputBlock Whether to process the image through the input block first
-     */
-    getSampleAsImage(projectId: number, sampleId: number, afterInputBlock?: boolean, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: Buffer;
-    }>;
-    /**
-     * Download a sample in it\'s original format as uploaded to the ingestion service.
-     * @summary Download file
-     * @param projectId Project ID
-     * @param sampleId Sample ID
-     */
-    getSampleAsRaw(projectId: number, sampleId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: Buffer;
-    }>;
-    /**
-     * Get a sample as an video file. This only applies to samples with video data.
-     * @summary Get video file
-     * @param projectId Project ID
-     * @param sampleId Sample ID
-     * @param afterInputBlock Whether to process the image through the input block first
-     */
-    getSampleAsVideo(projectId: number, sampleId: number, afterInputBlock?: boolean, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: Buffer;
-    }>;
-    /**
-     * Get a slice of a sample.
-     * @summary Get sample slice
-     * @param projectId Project ID
-     * @param sampleId Sample ID
-     * @param sliceStart Begin index of the slice
-     * @param sliceEnd End index of the slice
-     */
-    getSampleSlice(projectId: number, sampleId: number, sliceStart: number, sliceEnd: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: GetSampleResponse;
-    }>;
-    /**
-     * t-SNE2 output of the raw dataset
-     * @summary Check data explorer features
-     * @param projectId Project ID
-     */
-    hasDataExplorerFeatures(projectId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: HasDataExplorerFeaturesResponse;
-    }>;
-    /**
-     * List all deployment targets
-     * @summary Deployment targets
-     */
-    listAllDeploymentTargets(options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: DeploymentTargetsResponse;
-    }>;
-    /**
-     * List deployment targets for a project
-     * @summary Deployment targets
-     * @param projectId Project ID
-     */
-    listDeploymentTargetsForProject(projectId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: DeploymentTargetsResponse;
-    }>;
-    /**
-     * 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)
-     * @param projectId Project ID
-     */
-    listDeploymentTargetsForProjectDataSources(projectId: number, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: 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<{
-        response: http.IncomingMessage;
-        body: ListProjectsResponse;
-    }>;
-    /**
-     * Retrieve all raw data by category.
-     * @summary List samples
-     * @param projectId Project ID
-     * @param category Which of the three acquisition categories to retrieve data from
-     * @param limit Maximum number of results
-     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
-     * @param excludeSensors Whether to exclude sensors in the response (as these can slow down requests when you have large pages).
-     * @param labels Only include samples with a label within the given list of labels, given as a JSON string
-     * @param filename Only include samples whose filename includes the given filename
-     * @param maxLength Only include samples shorter than the given length, in milliseconds
-     * @param minLength Only include samples longer than the given length, in milliseconds
-     * @param minFrequency Only include samples with higher frequency than given frequency, in hertz
-     * @param maxFrequency Only include samples with lower frequency than given frequency, in hertz
-     * @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?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: ListSamplesResponse;
-    }>;
-    /**
-     * Get slice of sample data, and run it through the DSP block. This only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out.
-     * @summary Get processed sample (slice)
-     * @param projectId Project ID
-     * @param dspId DSP Block ID, use the impulse functions to retrieve the ID
-     * @param sampleId Sample ID
-     * @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?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        response: http.IncomingMessage;
-        body: DspRunResponseWithSample;
-    }>;
-}