edge-impulse-api 1.22.1 → 1.22.2

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

@@ -0,0 +1,36 @@
+/**
+ * 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 AkidaEdgeLearningConfig {
+    /**
+    * True if Akida Edge Learning model creation is enabled. Other properties will be ignored if this is false.
+    */
+    'enabled': boolean;
+    /**
+    * Number of additional classes that will be added to the Edge Learning model.
+    */
+    'additionalClasses'?: number;
+    /**
+    * Number of neurons in each class on the last layer in the Edge Learning model.
+    */
+    'neuronsPerClass'?: 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/anomalyModelMetadata.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 { AnomalyModelMetadataClusters } from './anomalyModelMetadataClusters';
+export declare class AnomalyModelMetadata {
+    /**
+    * Date when the model was trained
+    */
+    'created': Date;
+    /**
+    * Scale input for StandardScaler. Values are scaled like this (where `ix` is axis index): `input[ix] = (input[ix] - mean[ix]) / scale[ix];`
+    */
+    'scale': Array<number>;
+    /**
+    * Mean input for StandardScaler. Values are scaled like this (where `ix` is axis index): `input[ix] = (input[ix] - mean[ix]) / scale[ix];`
+    */
+    'mean': Array<number>;
+    /**
+    * Trained K-means clusters
+    */
+    'clusters': Array<AnomalyModelMetadataClusters>;
+    /**
+    * Which axes were included during training (by index)
+    */
+    'axes': Array<number>;
+    /**
+    * Default minimum confidence rating required before tagging as anomaly, based on scores of training data (GMM only).
+    */
+    'defaultMinimumConfidenceRating'?: 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/anomalyModelMetadataClusters.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 AnomalyModelMetadataClusters {
+    /**
+    * Center of each cluster (one value per axis)
+    */
+    'center': Array<number>;
+    /**
+    * Size of the cluster
+    */
+    'maxError': 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/anomalyModelMetadataResponse.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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 { AnomalyModelMetadataClusters } from './anomalyModelMetadataClusters';
+export declare class AnomalyModelMetadataResponse {
+    /**
+    * Whether the operation succeeded
+    */
+    'success': boolean;
+    /**
+    * Optional error description (set if \'success\' was false)
+    */
+    'error'?: string;
+    /**
+    * Date when the model was trained
+    */
+    'created': Date;
+    /**
+    * Scale input for StandardScaler. Values are scaled like this (where `ix` is axis index): `input[ix] = (input[ix] - mean[ix]) / scale[ix];`
+    */
+    'scale': Array<number>;
+    /**
+    * Mean input for StandardScaler. Values are scaled like this (where `ix` is axis index): `input[ix] = (input[ix] - mean[ix]) / scale[ix];`
+    */
+    'mean': Array<number>;
+    /**
+    * Trained K-means clusters
+    */
+    'clusters': Array<AnomalyModelMetadataClusters>;
+    /**
+    * Which axes were included during training (by index)
+    */
+    'axes': Array<number>;
+    /**
+    * Default minimum confidence rating required before tagging as anomaly, based on scores of training data (GMM only).
+    */
+    'defaultMinimumConfidenceRating'?: 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/anomalyResponse.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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 { AnomalyResponseAllOfAxes } from './anomalyResponseAllOfAxes';
+import { DependencyData } from './dependencyData';
+export declare class AnomalyResponse {
+    /**
+    * Whether the operation succeeded
+    */
+    'success': boolean;
+    /**
+    * Optional error description (set if \'success\' was false)
+    */
+    'error'?: string;
+    'dependencies': DependencyData;
+    'name': string;
+    /**
+    * Selectable axes for the anomaly detection block
+    */
+    'axes': Array<AnomalyResponseAllOfAxes>;
+    /**
+    * Whether the block is trained
+    */
+    'trained': boolean;
+    /**
+    * Number of clusters for K-means, or number of components for GMM (in config)
+    */
+    'clusterCount'?: number;
+    /**
+    * Selected clusters (in config)
+    */
+    'selectedAxes': Array<number>;
+    /**
+    * Minimum confidence rating for this block, scores above this number will be flagged as anomaly.
+    */
+    'minimumConfidenceRating': 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/anomalyResponseAllOf.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 { AnomalyResponseAllOfAxes } from './anomalyResponseAllOfAxes';
+import { DependencyData } from './dependencyData';
+export declare class AnomalyResponseAllOf {
+    'dependencies': DependencyData;
+    'name': string;
+    /**
+    * Selectable axes for the anomaly detection block
+    */
+    'axes': Array<AnomalyResponseAllOfAxes>;
+    /**
+    * Whether the block is trained
+    */
+    'trained': boolean;
+    /**
+    * Number of clusters for K-means, or number of components for GMM (in config)
+    */
+    'clusterCount'?: number;
+    /**
+    * Selected clusters (in config)
+    */
+    'selectedAxes': Array<number>;
+    /**
+    * Minimum confidence rating for this block, scores above this number will be flagged as anomaly.
+    */
+    'minimumConfidenceRating': 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/anomalyResponseAllOfAxes.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 AnomalyResponseAllOfAxes {
+    'label': string;
+    'selected': boolean;
+    'favourite': boolean;
+    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/anomalyTrainedFeaturesResponse.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 { AnomalyTrainedFeaturesResponseAllOfData } from './anomalyTrainedFeaturesResponseAllOfData';
+export declare class AnomalyTrainedFeaturesResponse {
+    /**
+    * Whether the operation succeeded
+    */
+    'success': boolean;
+    /**
+    * Optional error description (set if \'success\' was false)
+    */
+    'error'?: string;
+    /**
+    * Total number of windows in the data set
+    */
+    'totalSampleCount': number;
+    'data': Array<AnomalyTrainedFeaturesResponseAllOfData>;
+    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/anomalyTrainedFeaturesResponseAllOf.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 { AnomalyTrainedFeaturesResponseAllOfData } from './anomalyTrainedFeaturesResponseAllOfData';
+export declare class AnomalyTrainedFeaturesResponseAllOf {
+    /**
+    * Total number of windows in the data set
+    */
+    'totalSampleCount': number;
+    'data': Array<AnomalyTrainedFeaturesResponseAllOfData>;
+    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/anomalyTrainedFeaturesResponseAllOfData.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.
+ */
+export declare class AnomalyTrainedFeaturesResponseAllOfData {
+    /**
+    * Data by feature index for this window. Note that this data was scaled by the StandardScaler, use the anomaly metadata to unscale if needed.
+    */
+    'X': {
+        [key: string]: number;
+    };
+    /**
+    * Label used for datapoint colorscale in anomaly explorer (for gmm only). Is currently the result of the scoring function.
+    */
+    'label'?: 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/augmentationPolicyImageEnum.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+/**
+* The data augmentation policy to use with image input
+*/
+export declare type AugmentationPolicyImageEnum = 'none' | 'all';
+export declare const AugmentationPolicyImageEnumValues: string[];

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

@@ -0,0 +1,50 @@
+/**
+ * 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 AugmentationPolicySpectrogram {
+    /**
+    * True if spectrogram augmentation is enabled. Other properties will be ignored if this is false.
+    */
+    'enabled': boolean;
+    /**
+    * True if warping along the time axis is enabled.
+    */
+    'warping'?: boolean;
+    /**
+    * The amount of frequency masking to apply.
+    */
+    'freqMasking'?: AugmentationPolicySpectrogramFreqMaskingEnum;
+    /**
+    * The amount of time masking to apply.
+    */
+    'timeMasking'?: AugmentationPolicySpectrogramTimeMaskingEnum;
+    /**
+    * The amount of Gaussian noise to add.
+    */
+    'gaussianNoise'?: AugmentationPolicySpectrogramGaussianNoiseEnum;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}
+export declare type AugmentationPolicySpectrogramFreqMaskingEnum = 'none' | 'low' | 'high';
+export declare const AugmentationPolicySpectrogramFreqMaskingEnumValues: string[];
+export declare type AugmentationPolicySpectrogramTimeMaskingEnum = 'none' | 'low' | 'high';
+export declare const AugmentationPolicySpectrogramTimeMaskingEnumValues: string[];
+export declare type AugmentationPolicySpectrogramGaussianNoiseEnum = 'none' | 'low' | 'high';
+export declare const AugmentationPolicySpectrogramGaussianNoiseEnumValues: string[];

package/build/library/sdk/model/authorizeThirdPartyRequest.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 AuthorizeThirdPartyRequest {
+    /**
+    * The URL to redirect to after authorization is completed.
+    */
+    'nextUrl': 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/autotuneDspRequest.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 AutotuneDspRequest {
+    /**
+    * DSP block ID to autotune parameters of
+    */
+    'dspId': 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/boundingBox.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.
+ */
+/**
+* This has the _absolute values_ for x/y/w/h (so 0..x (where x is the w/h of the image))
+*/
+export declare class BoundingBox {
+    'label': string;
+    'x': number;
+    'y': number;
+    'width': number;
+    'height': 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/boundingBoxWithScore.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.
+ */
+/**
+* This has the _ratio_ for x/y/w/h (so 0..1)
+*/
+export declare class BoundingBoxWithScore {
+    'label': string;
+    'x': number;
+    'y': number;
+    'width': number;
+    'height': number;
+    'score': 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/buildOnDeviceModelRequest.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.
+ */
+import { DeploymentTargetEngine } from './deploymentTargetEngine';
+import { KerasModelTypeEnum } from './kerasModelTypeEnum';
+export declare class BuildOnDeviceModelRequest {
+    'engine': DeploymentTargetEngine;
+    'modelType'?: KerasModelTypeEnum;
+    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/buildOrganizationOnDeviceModelRequest.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.
+ */
+import { DeploymentTargetEngine } from './deploymentTargetEngine';
+import { KerasModelTypeEnum } from './kerasModelTypeEnum';
+export declare class BuildOrganizationOnDeviceModelRequest {
+    'engine': DeploymentTargetEngine;
+    'deployBlockId': number;
+    'modelType'?: KerasModelTypeEnum;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}