edge-impulse-api 1.22.1 → 1.22.2

package/build/library/sdk/model/dSPMetadataResponse.d.ts

@@ -0,0 +1,76 @@
+/**
+ * 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 { DSPMetadataIncludedSamples } from './dSPMetadataIncludedSamples';
+import { DSPMetadataOutputConfig } from './dSPMetadataOutputConfig';
+export declare class DSPMetadataResponse {
+    /**
+    * Whether the operation succeeded
+    */
+    'success': boolean;
+    /**
+    * Optional error description (set if \'success\' was false)
+    */
+    'error'?: string;
+    /**
+    * Date when the features were created
+    */
+    'created': Date;
+    'dspConfig': {
+        [key: string]: string;
+    };
+    /**
+    * Labels in the dataset when generator ran
+    */
+    'labels': Array<string>;
+    /**
+    * Names of the generated features. Only set if axes have explicit labels.
+    */
+    'featureLabels'?: Array<string>;
+    'windowCount': number;
+    /**
+    * Number of features for this DSP block
+    */
+    'featureCount': number;
+    /**
+    * The included samples in this DSP block. Note that these are sorted in the same way as the `npy` files are laid out. So with the `windowCount` parameter you can exactly search back to see which file contributed to which windows there.
+    */
+    'includedSamples': Array<DSPMetadataIncludedSamples>;
+    /**
+    * Length of the sliding window when generating features.
+    */
+    'windowSizeMs': number;
+    /**
+    * Increase of the sliding window when generating features.
+    */
+    'windowIncreaseMs': number;
+    /**
+    * Whether data was zero-padded when generating features.
+    */
+    'padZeros': boolean;
+    /**
+    * Frequency of the original data in Hz.
+    */
+    'frequency': number;
+    'outputConfig': DSPMetadataOutputConfig;
+    'fftUsed'?: Array<number>;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/build/library/sdk/model/dataExplorerPredictionsResponse.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 { ModelPrediction } from './modelPrediction';
+export declare class DataExplorerPredictionsResponse {
+    /**
+    * Whether the operation succeeded
+    */
+    'success': boolean;
+    /**
+    * Optional error description (set if \'success\' was false)
+    */
+    'error'?: string;
+    'predictions': Array<ModelPrediction>;
+    'labels': Array<string>;
+    'classificationType': DataExplorerPredictionsResponseClassificationTypeEnum;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}
+export declare type DataExplorerPredictionsResponseClassificationTypeEnum = 'classification' | 'regression';
+export declare const DataExplorerPredictionsResponseClassificationTypeEnumValues: string[];

package/build/library/sdk/model/dataExplorerPredictionsResponseAllOf.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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 { ModelPrediction } from './modelPrediction';
+export declare class DataExplorerPredictionsResponseAllOf {
+    'predictions': Array<ModelPrediction>;
+    'labels': Array<string>;
+    'classificationType': DataExplorerPredictionsResponseAllOfClassificationTypeEnum;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}
+export declare type DataExplorerPredictionsResponseAllOfClassificationTypeEnum = 'classification' | 'regression';
+export declare const DataExplorerPredictionsResponseAllOfClassificationTypeEnumValues: string[];

package/build/library/sdk/model/dataExplorerSettings.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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.
+ */
+export declare class DataExplorerSettings {
+    /**
+    * Preset to use for the data explorer.
+    */
+    'preset'?: DataExplorerSettingsPresetEnum;
+    'dimensionalityReductionTechnique'?: DataExplorerSettingsDimensionalityReductionTechniqueEnum;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}
+export declare type DataExplorerSettingsPresetEnum = 'keywords' | 'images' | 'current-impulse' | 'current-impulse-embeddings';
+export declare const DataExplorerSettingsPresetEnumValues: string[];
+export declare type DataExplorerSettingsDimensionalityReductionTechniqueEnum = 'tsne' | 'pca';
+export declare const DataExplorerSettingsDimensionalityReductionTechniqueEnumValues: string[];

package/build/library/sdk/model/datasetRatioData.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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 { DatasetRatioDataRatio } from './datasetRatioDataRatio';
+export declare class DatasetRatioData {
+    'ratio'?: DatasetRatioDataRatio;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/build/library/sdk/model/datasetRatioDataRatio.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+export declare class DatasetRatioDataRatio {
+    /**
+    * number of training samples after rebalance
+    */
+    'training'?: number;
+    /**
+    * number of testing samples after rebalance
+    */
+    'testing'?: number;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/build/library/sdk/model/deletePortalFileRequest.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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.
+ */
+export declare class DeletePortalFileRequest {
+    /**
+    * S3 path (within the portal)
+    */
+    'path': string;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/build/library/sdk/model/dependencyData.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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.
+ */
+export declare class DependencyData {
+    'classes': Array<string>;
+    'blockNames': Array<string>;
+    'featureCount': number;
+    'sampleCount': number;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/build/library/sdk/model/deployPretrainedModelInputAudio.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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.
+ */
+export declare class DeployPretrainedModelInputAudio {
+    'inputType': DeployPretrainedModelInputAudioInputTypeEnum;
+    'frequencyHz': number;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}
+export declare type DeployPretrainedModelInputAudioInputTypeEnum = 'audio';
+export declare const DeployPretrainedModelInputAudioInputTypeEnumValues: string[];

package/build/library/sdk/model/deployPretrainedModelInputImage.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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.
+ */
+export declare class DeployPretrainedModelInputImage {
+    'inputType': DeployPretrainedModelInputImageInputTypeEnum;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}
+export declare type DeployPretrainedModelInputImageInputTypeEnum = 'image';
+export declare const DeployPretrainedModelInputImageInputTypeEnumValues: string[];

package/build/library/sdk/model/deployPretrainedModelInputNone.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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.
+ */
+export declare class DeployPretrainedModelInputNone {
+    'inputType': DeployPretrainedModelInputNoneInputTypeEnum;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}
+export declare type DeployPretrainedModelInputNoneInputTypeEnum = 'none';
+export declare const DeployPretrainedModelInputNoneInputTypeEnumValues: string[];

package/build/library/sdk/model/deployPretrainedModelInputOther.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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.
+ */
+export declare class DeployPretrainedModelInputOther {
+    'inputType': DeployPretrainedModelInputOtherInputTypeEnum;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}
+export declare type DeployPretrainedModelInputOtherInputTypeEnum = 'other';
+export declare const DeployPretrainedModelInputOtherInputTypeEnumValues: string[];

package/build/library/sdk/model/deployPretrainedModelInputTimeSeries.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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.
+ */
+export declare class DeployPretrainedModelInputTimeSeries {
+    'inputType': DeployPretrainedModelInputTimeSeriesInputTypeEnum;
+    'frequencyHz': number;
+    'windowLengthMs': number;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}
+export declare type DeployPretrainedModelInputTimeSeriesInputTypeEnum = 'time-series';
+export declare const DeployPretrainedModelInputTimeSeriesInputTypeEnumValues: string[];

package/build/library/sdk/model/deployPretrainedModelModelClassification.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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.
+ */
+export declare class DeployPretrainedModelModelClassification {
+    'modelType': DeployPretrainedModelModelClassificationModelTypeEnum;
+    'labels': Array<string>;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}
+export declare type DeployPretrainedModelModelClassificationModelTypeEnum = 'classification';
+export declare const DeployPretrainedModelModelClassificationModelTypeEnumValues: string[];

package/build/library/sdk/model/deployPretrainedModelModelObjectDetection.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 { ObjectDetectionLastLayer } from './objectDetectionLastLayer';
+export declare class DeployPretrainedModelModelObjectDetection {
+    'modelType': DeployPretrainedModelModelObjectDetectionModelTypeEnum;
+    'labels': Array<string>;
+    'lastLayer': ObjectDetectionLastLayer;
+    /**
+    * Threshold for objects (f.e. 0.3)
+    */
+    'minimumConfidence': number;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}
+export declare type DeployPretrainedModelModelObjectDetectionModelTypeEnum = 'object-detection';
+export declare const DeployPretrainedModelModelObjectDetectionModelTypeEnumValues: string[];

package/build/library/sdk/model/deployPretrainedModelModelRegression.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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.
+ */
+export declare class DeployPretrainedModelModelRegression {
+    'modelType': DeployPretrainedModelModelRegressionModelTypeEnum;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}
+export declare type DeployPretrainedModelModelRegressionModelTypeEnum = 'regression';
+export declare const DeployPretrainedModelModelRegressionModelTypeEnumValues: string[];

package/build/library/sdk/model/deployPretrainedModelRequest.d.ts

@@ -0,0 +1,46 @@
+/**
+ * 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 { DeployPretrainedModelRequestModelInfo } from './deployPretrainedModelRequestModelInfo';
+import { DeploymentTargetEngine } from './deploymentTargetEngine';
+export declare class DeployPretrainedModelRequest {
+    /**
+    * A base64 encoded pretrained model
+    */
+    'modelFileBase64': string;
+    'modelFileType': DeployPretrainedModelRequestModelFileTypeEnum;
+    /**
+    * The name of the built target. You can find this by listing all deployment targets through `listDeploymentTargetsForProject` (via `GET /v1/api/{projectId}/deployment/targets`) and see the `format` type.
+    */
+    'deploymentType': string;
+    'engine'?: DeploymentTargetEngine;
+    'modelInfo': DeployPretrainedModelRequestModelInfo;
+    /**
+    * A base64 encoded .npy file containing the features from your validation set (optional for onnx and saved_model) - used to quantize your model.
+    */
+    'representativeFeaturesBase64'?: string;
+    'deployModelType'?: DeployPretrainedModelRequestDeployModelTypeEnum;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}
+export declare type DeployPretrainedModelRequestModelFileTypeEnum = 'tflite' | 'onnx' | 'saved_model';
+export declare const DeployPretrainedModelRequestModelFileTypeEnumValues: string[];
+export declare type DeployPretrainedModelRequestDeployModelTypeEnum = 'int8' | 'float32';
+export declare const DeployPretrainedModelRequestDeployModelTypeEnumValues: string[];

package/build/library/sdk/model/deployPretrainedModelRequestModelInfo.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 { DeployPretrainedModelInputTimeSeries } from './deployPretrainedModelInputTimeSeries';
+import { DeployPretrainedModelInputAudio } from './deployPretrainedModelInputAudio';
+import { DeployPretrainedModelInputImage } from './deployPretrainedModelInputImage';
+import { DeployPretrainedModelInputOther } from './deployPretrainedModelInputOther';
+import { DeployPretrainedModelModelClassification } from './deployPretrainedModelModelClassification';
+import { DeployPretrainedModelModelRegression } from './deployPretrainedModelModelRegression';
+import { DeployPretrainedModelModelObjectDetection } from './deployPretrainedModelModelObjectDetection';
+export declare class DeployPretrainedModelRequestModelInfo {
+    'input': DeployPretrainedModelInputTimeSeries | DeployPretrainedModelInputAudio | DeployPretrainedModelInputImage | DeployPretrainedModelInputOther;
+    'model': DeployPretrainedModelModelClassification | DeployPretrainedModelModelRegression | DeployPretrainedModelModelObjectDetection;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}