edge-impulse-api 1.22.1 → 1.22.2

package/build/library/sdk/model/performanceCalibrationDetection.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 PerformanceCalibrationDetection {
+    /**
+    * The time of the detection in milliseconds
+    */
+    'time': number;
+    /**
+    * The label that was detected
+    */
+    '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/performanceCalibrationFalsePositive.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.
+ */
+export declare class PerformanceCalibrationFalsePositive {
+    /**
+    * The type of false positive. Incorrect is when a detection matches the wrong ground truth. Duplicate is when the same ground truth was detected more than once. The first correct detection is considered a true positive but subsequent detections are considered false positives. Spurious is when the detection was not associated with any ground truth.
+    */
+    'type': PerformanceCalibrationFalsePositiveTypeEnum;
+    /**
+    * The time of the detection in milliseconds
+    */
+    'detectionTime': number;
+    /**
+    * The label of any associated ground truth
+    */
+    'groundTruthLabel'?: string;
+    /**
+    * The start time of any associated ground truth
+    */
+    'groundTruthStart'?: number;
+    /**
+    * All of the sample IDs in the affected region
+    */
+    'sampleIds'?: Array<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 PerformanceCalibrationFalsePositiveTypeEnum = 'incorrect' | 'duplicate' | 'spurious';
+export declare const PerformanceCalibrationFalsePositiveTypeEnumValues: string[];

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

@@ -0,0 +1,51 @@
+/**
+ * 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 { PerformanceCalibrationGroundTruthSamples } from './performanceCalibrationGroundTruthSamples';
+export declare class PerformanceCalibrationGroundTruth {
+    /**
+    * Whether this region is a single sample, a region of background noise, or a region of background noise that contains samples.
+    */
+    'type': PerformanceCalibrationGroundTruthTypeEnum;
+    /**
+    * Index of the label in the array of all labels
+    */
+    'labelIdx': number;
+    /**
+    * String label of the sample
+    */
+    'labelString': string;
+    /**
+    * The start time of the region in milliseconds
+    */
+    'start': number;
+    /**
+    * The length of the region in milliseconds
+    */
+    'length': number;
+    /**
+    * If the region contains samples, all the samples within this region
+    */
+    'samples'?: Array<PerformanceCalibrationGroundTruthSamples>;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}
+export declare type PerformanceCalibrationGroundTruthTypeEnum = 'sample' | 'noise' | 'combined_noise';
+export declare const PerformanceCalibrationGroundTruthTypeEnumValues: string[];

package/build/library/sdk/model/performanceCalibrationGroundTruthSamples.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.
+ */
+export declare class PerformanceCalibrationGroundTruthSamples {
+    /**
+    * The ID of the samples in Studio
+    */
+    'id': number;
+    /**
+    * The start time of the sample in milliseconds
+    */
+    'start': number;
+    /**
+    * The length of the sample in milliseconds
+    */
+    'length': number;
+    /**
+    * For debugging. The index of the sample in the original Y array.
+    */
+    'idx': 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/performanceCalibrationParameterSet.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 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 { PerformanceCalibrationDetection } from './performanceCalibrationDetection';
+import { PerformanceCalibrationParameterSetAggregateStats } from './performanceCalibrationParameterSetAggregateStats';
+import { PerformanceCalibrationParameterSetStats } from './performanceCalibrationParameterSetStats';
+import { PerformanceCalibrationParameters } from './performanceCalibrationParameters';
+export declare class PerformanceCalibrationParameterSet {
+    /**
+    * All of the detections using this parameter set
+    */
+    'detections': Array<PerformanceCalibrationDetection>;
+    /**
+    * Whether this is considered the best parameter set
+    */
+    'isBest': boolean;
+    /**
+    * All of the possible labels in the detections array
+    */
+    'labels': Array<string>;
+    'aggregateStats': PerformanceCalibrationParameterSetAggregateStats;
+    'stats': Array<PerformanceCalibrationParameterSetStats>;
+    'params': PerformanceCalibrationParameters;
+    /**
+    * The size of the input block window in milliseconds.
+    */
+    'windowSizeMs': 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/performanceCalibrationParameterSetAggregateStats.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.
+ */
+export declare class PerformanceCalibrationParameterSetAggregateStats {
+    'falsePositiveRate': number;
+    'falseNegativeRate': 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/performanceCalibrationParameterSetStats.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 { PerformanceCalibrationFalsePositive } from './performanceCalibrationFalsePositive';
+export declare class PerformanceCalibrationParameterSetStats {
+    'label': string;
+    'truePositives': number;
+    'falsePositives': number;
+    'falseNegatives': number;
+    'trueNegatives': number;
+    'falsePositiveRate': number;
+    'falseNegativeRate': number;
+    /**
+    * The details of every false positive detection.
+    */
+    'falsePositiveDetails'?: Array<PerformanceCalibrationFalsePositive>;
+    /**
+    * The times in ms at which false negatives occurred. These correspond to specific items in the ground truth.
+    */
+    'falseNegativeTimes': 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/performanceCalibrationParameters.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.
+ */
+import { PerformanceCalibrationParametersStandard } from './performanceCalibrationParametersStandard';
+export declare class PerformanceCalibrationParameters {
+    /**
+    * The post-processing algorithm type.
+    */
+    'type': PerformanceCalibrationParametersTypeEnum;
+    /**
+    * The version number of the post-processing algorithm.
+    */
+    'version': number;
+    'parametersStandard'?: PerformanceCalibrationParametersStandard;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}
+export declare type PerformanceCalibrationParametersTypeEnum = 'standard';
+export declare const PerformanceCalibrationParametersTypeEnumValues: string[];

package/build/library/sdk/model/performanceCalibrationParametersStandard.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 PerformanceCalibrationParametersStandard {
+    /**
+    * The length of the averaging window in milliseconds.
+    */
+    'averageWindowDurationMs': number;
+    /**
+    * The minimum threshold for detection, from 0-1.
+    */
+    'detectionThreshold': number;
+    /**
+    * The amount of time new matches will be ignored after a positive result.
+    */
+    'suppressionMs': 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/performanceCalibrationRawDetection.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 PerformanceCalibrationRawDetection {
+    /**
+    * The start time of the detected window in milliseconds
+    */
+    'start': number;
+    /**
+    * The end time of the detected window in milliseconds
+    */
+    'end': number;
+    'result': 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/performanceCalibrationSaveParameterSetRequest.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 { PerformanceCalibrationParameters } from './performanceCalibrationParameters';
+export declare class PerformanceCalibrationSaveParameterSetRequest {
+    'params': PerformanceCalibrationParameters;
+    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/performanceCalibrationUploadLabeledAudioRequest.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.
+ */
+/// <reference types="node" />
+export declare class PerformanceCalibrationUploadLabeledAudioRequest {
+    'zip': {
+        fieldname: string;
+        originalname: string;
+        encoding: string;
+        mimetype: string;
+        buffer: Buffer;
+        size: 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/performanceCalibrationUploadLabeledAudioResponse.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 PerformanceCalibrationUploadLabeledAudioResponse {
+    /**
+    * Whether the operation succeeded
+    */
+    'success': boolean;
+    /**
+    * Optional error description (set if \'success\' was false)
+    */
+    'error'?: string;
+    'uploadKey': 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/performanceCalibrationUploadLabeledAudioResponseAllOf.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 PerformanceCalibrationUploadLabeledAudioResponseAllOf {
+    'uploadKey': 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/permission.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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 type Permission = 'admin:metrics:read' | 'admin:organizations:read' | 'admin:organizations:write' | 'admin:projects:members:write' | 'admin:projects:read' | 'admin:projects:write' | 'admin:users:permissions:write' | 'admin:users:read' | 'admin:users:write' | 'projects:limits:write' | 'projects:training:keras:write' | 'thirdpartyauth:read' | 'thirdpartyauth:write' | 'users:emails:read' | 'whitelabels:read' | 'whitelabels:write';
+export declare const PermissionValues: string[];

package/build/library/sdk/model/permission.js

@@ -0,0 +1,16 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PermissionValues = void 0;
+exports.PermissionValues = ['admin:metrics:read', 'admin:organizations:read', 'admin:organizations:write', 'admin:projects:members:write', 'admin:projects:read', 'admin:projects:write', 'admin:users:permissions:write', 'admin:users:read', 'admin:users:write', 'projects:limits:write', 'projects:training:keras:write', 'thirdpartyauth:read', 'thirdpartyauth:write', 'users:emails:read', 'whitelabels:read', 'whitelabels:write'];
+//# sourceMappingURL=permission.js.map

package/build/library/sdk/model/permission.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permission.js","sourceRoot":"","sources":["../../../../library/sdk/model/permission.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;AAKU,QAAA,gBAAgB,GAAa,CAAC,oBAAoB,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,8BAA8B,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,+BAA+B,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,+BAA+B,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,mBAAmB,CAAC,CAAC"}

package/build/library/sdk/model/portalFile.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 PortalFile {
+    'name': string;
+    'addedDate'?: Date;
+    'size'?: number;
+    'eTag'?: string;
+    '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/portalInfoResponse.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 PortalInfoResponse {
+    'name': string;
+    'description': string;
+    'organizationId': number;
+    'organizationName': string;
+    'organizationLogo'?: 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/pretrainedModelTensor.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 PretrainedModelTensor {
+    'dataType': PretrainedModelTensorDataTypeEnum;
+    'name': string;
+    'shape': Array<number>;
+    'quantizationScale'?: number;
+    'quantizationZeroPoint'?: 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 PretrainedModelTensorDataTypeEnum = 'int8' | 'uint8' | 'float32';
+export declare const PretrainedModelTensorDataTypeEnumValues: string[];