edge-impulse-api 1.22.1 → 1.22.2

package/build/library/sdk/model/dspRunResponseWithSample.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.
+ */
+import { DspRunGraph } from './dspRunGraph';
+import { DspRunResponseAllOfPerformance } from './dspRunResponseAllOfPerformance';
+import { RawSampleData } from './rawSampleData';
+export declare class DspRunResponseWithSample {
+    /**
+    * Whether the operation succeeded
+    */
+    'success': boolean;
+    /**
+    * Optional error description (set if \'success\' was false)
+    */
+    'error'?: string;
+    /**
+    * Array of processed features. Laid out according to the names in \'labels\'
+    */
+    'features': Array<number>;
+    /**
+    * Graphs to plot to give an insight in how the DSP process ran
+    */
+    'graphs': Array<DspRunGraph>;
+    /**
+    * Labels of the feature axes
+    */
+    'labels'?: Array<string>;
+    'sample': RawSampleData;
+    'performance'?: DspRunResponseAllOfPerformance;
+    'canProfilePerformance': 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/dspRunResponseWithSampleAllOf.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 { DspRunGraph } from './dspRunGraph';
+import { DspRunResponseAllOfPerformance } from './dspRunResponseAllOfPerformance';
+import { RawSampleData } from './rawSampleData';
+export declare class DspRunResponseWithSampleAllOf {
+    /**
+    * Array of processed features. Laid out according to the names in \'labels\'
+    */
+    'features': Array<number>;
+    /**
+    * Graphs to plot to give an insight in how the DSP process ran
+    */
+    'graphs': Array<DspRunGraph>;
+    /**
+    * Labels of the feature axes
+    */
+    'labels'?: Array<string>;
+    'sample': RawSampleData;
+    'performance'?: DspRunResponseAllOfPerformance;
+    'canProfilePerformance': 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/dspSampleFeaturesResponse.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 { DspSampleFeaturesResponseAllOfData } from './dspSampleFeaturesResponseAllOfData';
+export declare class DspSampleFeaturesResponse {
+    /**
+    * 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<DspSampleFeaturesResponseAllOfData>;
+    /**
+    * When showing the processed features, skip the first X features. This is used in dimensionality reduction where artificial features are introduced in the response (on the first few positions).
+    */
+    'skipFirstFeatures': 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/dspSampleFeaturesResponseAllOf.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 { DspSampleFeaturesResponseAllOfData } from './dspSampleFeaturesResponseAllOfData';
+export declare class DspSampleFeaturesResponseAllOf {
+    /**
+    * Total number of windows in the data set
+    */
+    'totalSampleCount': number;
+    'data': Array<DspSampleFeaturesResponseAllOfData>;
+    /**
+    * When showing the processed features, skip the first X features. This is used in dimensionality reduction where artificial features are introduced in the response (on the first few positions).
+    */
+    'skipFirstFeatures': 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/dspSampleFeaturesResponseAllOfData.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 { DspSampleFeaturesResponseAllOfSample } from './dspSampleFeaturesResponseAllOfSample';
+export declare class DspSampleFeaturesResponseAllOfData {
+    /**
+    * Feature data for this window
+    */
+    'X': Array<number>;
+    /**
+    * Training label index
+    */
+    'y': number;
+    /**
+    * Training label string
+    */
+    'yLabel': string;
+    'sample'?: DspSampleFeaturesResponseAllOfSample;
+    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/dspSampleFeaturesResponseAllOfSample.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 DspSampleFeaturesResponseAllOfSample {
+    'id': number;
+    'name': string;
+    'startMs': number;
+    'endMs': 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/dspTrainedFeaturesResponse.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 { DspTrainedFeaturesResponseAllOfData } from './dspTrainedFeaturesResponseAllOfData';
+export declare class DspTrainedFeaturesResponse {
+    /**
+    * 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<DspTrainedFeaturesResponseAllOfData>;
+    /**
+    * When showing the processed features, skip the first X features. This is used in dimensionality reduction where artificial features are introduced in the response (on the first few positions).
+    */
+    'skipFirstFeatures': 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/dspTrainedFeaturesResponseAllOf.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 { DspTrainedFeaturesResponseAllOfData } from './dspTrainedFeaturesResponseAllOfData';
+export declare class DspTrainedFeaturesResponseAllOf {
+    /**
+    * Total number of windows in the data set
+    */
+    'totalSampleCount': number;
+    'data': Array<DspTrainedFeaturesResponseAllOfData>;
+    /**
+    * When showing the processed features, skip the first X features. This is used in dimensionality reduction where artificial features are introduced in the response (on the first few positions).
+    */
+    'skipFirstFeatures': 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/dspTrainedFeaturesResponseAllOfData.d.ts

@@ -0,0 +1,40 @@
+/**
+ * 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 { DspTrainedFeaturesResponseAllOfSample } from './dspTrainedFeaturesResponseAllOfSample';
+export declare class DspTrainedFeaturesResponseAllOfData {
+    /**
+    * Data by feature index for this window
+    */
+    'X': {
+        [key: string]: number;
+    };
+    /**
+    * Training label index
+    */
+    'y': number;
+    /**
+    * Training label string
+    */
+    'yLabel': string;
+    'sample'?: DspTrainedFeaturesResponseAllOfSample;
+    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/dspTrainedFeaturesResponseAllOfSample.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 DspTrainedFeaturesResponseAllOfSample {
+    'id': number;
+    'name': string;
+    'startMs': number;
+    'endMs': 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/editSampleLabelRequest.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 EditSampleLabelRequest {
+    /**
+    * New label for this sample
+    */
+    'label': 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/evaluateJobResponse.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 { ModelVariantStats } from './modelVariantStats';
+export declare class EvaluateJobResponse {
+    /**
+    * Whether the operation succeeded
+    */
+    'success': boolean;
+    /**
+    * Optional error description (set if \'success\' was false)
+    */
+    'error'?: string;
+    'result': Array<ModelVariantStats>;
+    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/evaluateJobResponseAllOf.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 { ModelVariantStats } from './modelVariantStats';
+export declare class EvaluateJobResponseAllOf {
+    'result': Array<ModelVariantStats>;
+    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/evaluateResultValue.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 EvaluateResultValue {
+    /**
+    * The value based on the model alone
+    */
+    'raw'?: number;
+    /**
+    * The value including the result of anomaly detection
+    */
+    'withAnomaly'?: 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/exportGetUrlResponse.d.ts

@@ -0,0 +1,41 @@
+/**
+ * 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 ExportGetUrlResponse {
+    /**
+    * Whether the operation succeeded
+    */
+    'success': boolean;
+    /**
+    * Optional error description (set if \'success\' was false)
+    */
+    'error'?: string;
+    'hasExport': boolean;
+    /**
+    * Set if hasExport is true
+    */
+    'created'?: Date;
+    /**
+    * Set if hasExport is true
+    */
+    'url'?: 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/exportGetUrlResponseAllOf.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 ExportGetUrlResponseAllOf {
+    'hasExport': boolean;
+    /**
+    * Set if hasExport is true
+    */
+    'created'?: Date;
+    /**
+    * Set if hasExport is true
+    */
+    'url'?: 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/exportOriginalDataRequest.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 ExportOriginalDataRequest {
+    /**
+    * Whether to rename the exported file names to an uploader friendly format (e.g. label.filename.cbor)
+    */
+    'uploaderFriendlyFilenames': boolean;
+    /**
+    * Whether to retain crops and splits. If this is disabled, then the original files are returned (as they were uploaded).
+    */
+    'retainCrops': 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/exportWavDataRequest.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 ExportWavDataRequest {
+    /**
+    * Whether to retain crops and splits. If this is disabled, then the original files are returned (as they were uploaded).
+    */
+    'retainCrops': 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/findSegmentSampleRequest.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 FindSegmentSampleRequest {
+    /**
+    * If set, the segments are automatically shifted randomly, to make the dataset distribution more uniform.
+    */
+    'shiftSegments': boolean;
+    'segmentLengthMs': number;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}