edge-impulse-api 1.22.0 → 1.22.2

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

@@ -0,0 +1,110 @@
+/**
+ * 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 { ImpulseDspBlockOrganization } from './impulseDspBlockOrganization';
+export declare class ImpulseDspBlock {
+    /**
+    * Identifier for this block. Make sure to up this number when creating a new block, and don\'t re-use identifiers. If the block hasn\'t changed, keep the ID as-is. ID must be unique across the project and greather than zero (>0).
+    */
+    'id': number;
+    /**
+    * Block type
+    */
+    'type': string;
+    /**
+    * Block name, will be used in menus
+    */
+    'name': string;
+    /**
+    * Input axes, identified by the name in the name of the axis
+    */
+    'axes': Array<string>;
+    /**
+    * Block title, used in the impulse UI
+    */
+    'title': string;
+    /**
+    * Number of features this DSP block outputs per axis. This is only set when the DSP block is configured.
+    */
+    'valuesPerAxis'?: number;
+    /**
+    * The ID of the Input block a DSP block is connected to
+    */
+    'input'?: number;
+    /**
+    * Whether this block is the primary version of its base block.
+    */
+    'primaryVersion': boolean;
+    /**
+    * The version number of the original block this version was based on. If this is an original block, will be undefined.
+    */
+    'baseBlockId'?: number;
+    /**
+    * The version number of the original tuner block this version was based on. If this is an original tuner block, will be undefined
+    */
+    'tunerBaseBlockId'?: number;
+    /**
+    * The version number of the original tuner template block this version was based on. If this is an original tuner template block, will be undefined
+    */
+    'tunerTemplateId'?: number;
+    /**
+    * Specifies if this block was copied from a tuner block when a tuner model variant was set as primary model
+    */
+    'tunerPrimary'?: boolean;
+    /**
+    * ID of block this block version was cloned from
+    */
+    'clonedFromBlockId'?: number;
+    /**
+    * Specifies if this block was updated after being cloned/created
+    */
+    'mutated'?: boolean;
+    /**
+    * Whether is block is enabled. A block is assumed to be enabled when unset.
+    */
+    'enabled'?: boolean;
+    /**
+    * Whether block is stored in database.
+    */
+    'db'?: boolean;
+    /**
+    * A short description of the block version, displayed in the block versioning UI
+    */
+    'description'?: string;
+    /**
+    * The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.
+    */
+    'createdBy'?: string;
+    /**
+    * The datetime that the block version was created. Cannot be set via API.
+    */
+    'createdAt'?: Date;
+    /**
+    * Implementation version of the block
+    */
+    'implementationVersion': number;
+    'organization'?: ImpulseDspBlockOrganization;
+    /**
+    * Required for type \'custom\'
+    */
+    'customUrl'?: 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/impulseDspBlockOrganization.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 ImpulseDspBlockOrganization {
+    'id': number;
+    '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/impulseInputBlock.d.ts

@@ -0,0 +1,136 @@
+/**
+ * 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 ImpulseInputBlock {
+    /**
+    * Identifier for this block. Make sure to up this number when creating a new block, and don\'t re-use identifiers. If the block hasn\'t changed, keep the ID as-is. ID must be unique across the project and greather than zero (>0).
+    */
+    'id': number;
+    /**
+    * Block type (either time-series or image)
+    */
+    'type': ImpulseInputBlockTypeEnum;
+    /**
+    * Block name, will be used in menus
+    */
+    'name': string;
+    /**
+    * Block title, used in the impulse UI
+    */
+    'title': string;
+    /**
+    * Size of the sliding window in milliseconds
+    */
+    'windowSizeMs'?: number;
+    /**
+    * We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step.
+    */
+    'windowIncreaseMs'?: number;
+    /**
+    * (Input only) Frequency of the input data in Hz
+    */
+    'frequencyHz'?: number;
+    /**
+    * We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step in classification mode.
+    */
+    'classificationWindowIncreaseMs'?: number;
+    /**
+    * Whether to zero pad data when a data item is too short
+    */
+    'padZeros'?: boolean;
+    /**
+    * Width all images are resized to before training
+    */
+    'imageWidth'?: number;
+    /**
+    * Width all images are resized to before training
+    */
+    'imageHeight'?: number;
+    /**
+    * How to resize images before training
+    */
+    'resizeMode'?: ImpulseInputBlockResizeModeEnum;
+    /**
+    * Resize method to use when resizing images
+    */
+    'resizeMethod'?: ImpulseInputBlockResizeMethodEnum;
+    /**
+    * If images are resized using a crop, choose where to anchor the crop
+    */
+    'cropAnchor'?: ImpulseInputBlockCropAnchorEnum;
+    /**
+    * Whether this block is the primary version of its base block.
+    */
+    'primaryVersion': boolean;
+    /**
+    * The version number of the original block this version was based on. If this is an original block, will be undefined.
+    */
+    'baseBlockId'?: number;
+    /**
+    * The version number of the original tuner block this version was based on. If this is an original tuner block, will be undefined
+    */
+    'tunerBaseBlockId'?: number;
+    /**
+    * The version number of the original tuner template block this version was based on. If this is an original tuner template block, will be undefined
+    */
+    'tunerTemplateId'?: number;
+    /**
+    * Specifies if this block was copied from a tuner block when a tuner model variant was set as primary model
+    */
+    'tunerPrimary'?: boolean;
+    /**
+    * ID of block this block version was cloned from
+    */
+    'clonedFromBlockId'?: number;
+    /**
+    * Specifies if this block was updated after being cloned/created
+    */
+    'mutated'?: boolean;
+    /**
+    * Whether is block is enabled. A block is assumed to be enabled when unset.
+    */
+    'enabled'?: boolean;
+    /**
+    * Whether block is stored in database.
+    */
+    'db'?: boolean;
+    /**
+    * A short description of the block version, displayed in the block versioning UI
+    */
+    'description'?: string;
+    /**
+    * The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.
+    */
+    'createdBy'?: string;
+    /**
+    * The datetime that the block version was created. Cannot be set via API.
+    */
+    'createdAt'?: Date;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}
+export declare type ImpulseInputBlockTypeEnum = 'time-series' | 'image' | 'video';
+export declare const ImpulseInputBlockTypeEnumValues: string[];
+export declare type ImpulseInputBlockResizeModeEnum = 'squash' | 'fit-short' | 'fit-long' | 'crop';
+export declare const ImpulseInputBlockResizeModeEnumValues: string[];
+export declare type ImpulseInputBlockResizeMethodEnum = 'lanczos3' | 'nearest';
+export declare const ImpulseInputBlockResizeMethodEnumValues: string[];
+export declare type ImpulseInputBlockCropAnchorEnum = 'top-left' | 'top-center' | 'top-right' | 'middle-left' | 'middle-center' | 'middle-right' | 'bottom-left' | 'bottom-center' | 'bottom-right';
+export declare const ImpulseInputBlockCropAnchorEnumValues: string[];

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

@@ -0,0 +1,90 @@
+/**
+ * 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 { LearnBlockType } from './learnBlockType';
+export declare class ImpulseLearnBlock {
+    /**
+    * Identifier for this block. Make sure to up this number when creating a new block, and don\'t re-use identifiers. If the block hasn\'t changed, keep the ID as-is. ID must be unique across the project and greather than zero (>0).
+    */
+    'id': number;
+    'type': LearnBlockType;
+    /**
+    * Block name, will be used in menus. If a block has a baseBlockId, this field is ignored and the base block\'s name is used instead.
+    */
+    'name': string;
+    /**
+    * DSP dependencies, identified by DSP block ID
+    */
+    'dsp': Array<number>;
+    /**
+    * Block title, used in the impulse UI
+    */
+    'title': string;
+    /**
+    * Whether this block is the primary version of its base block.
+    */
+    'primaryVersion': boolean;
+    /**
+    * The version number of the original block this version was based on. If this is an original block, will be undefined.
+    */
+    'baseBlockId'?: number;
+    /**
+    * The version number of the original tuner block this version was based on. If this is an original tuner block, will be undefined
+    */
+    'tunerBaseBlockId'?: number;
+    /**
+    * The version number of the original tuner template block this version was based on. If this is an original tuner template block, will be undefined
+    */
+    'tunerTemplateId'?: number;
+    /**
+    * Specifies if this block was copied from a tuner block when a tuner model variant was set as primary model
+    */
+    'tunerPrimary'?: boolean;
+    /**
+    * ID of block this block version was cloned from
+    */
+    'clonedFromBlockId'?: number;
+    /**
+    * Specifies if this block was updated after being cloned/created
+    */
+    'mutated'?: boolean;
+    /**
+    * Whether is block is enabled. A block is assumed to be enabled when unset.
+    */
+    'enabled'?: boolean;
+    /**
+    * Whether block is stored in database.
+    */
+    'db'?: boolean;
+    /**
+    * A short description of the block version, displayed in the block versioning UI
+    */
+    'description'?: string;
+    /**
+    * The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.
+    */
+    'createdBy'?: string;
+    /**
+    * The datetime that the block version was created. Cannot be set via API.
+    */
+    'createdAt'?: Date;
+    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/inputBlock.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 InputBlock {
+    'type': InputBlockTypeEnum;
+    'title': string;
+    'author': string;
+    'description': string;
+    'name': string;
+    'recommended'?: boolean;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}
+export declare type InputBlockTypeEnum = 'time-series' | 'image' | 'video';
+export declare const InputBlockTypeEnumValues: string[];

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

@@ -0,0 +1,35 @@
+/**
+ * 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 InviteOrganizationMemberRequest {
+    /**
+    * E-mail address
+    */
+    'email': string;
+    'role': InviteOrganizationMemberRequestRoleEnum;
+    /**
+    * Only used for \'guest\' users. Limits the datasets the user has access to.
+    */
+    'datasets': 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 InviteOrganizationMemberRequestRoleEnum = 'admin' | 'member' | 'guest';
+export declare const InviteOrganizationMemberRequestRoleEnumValues: string[];

package/build/library/sdk/model/job.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.
+ */
+export declare class Job {
+    /**
+    * Job id, use this to refer back to the job. The web socket API also uses this ID.
+    */
+    'id': number;
+    'category': string;
+    /**
+    * External job identifier, this can be used to categorize jobs, and recover job status. E.g. set this to \'keras-192\' for a Keras learning block with ID 192. When a user refreshes the page you can check whether a job is active for this ID and re-attach.
+    */
+    'key': string;
+    /**
+    * When the job was created.
+    */
+    'created': Date;
+    /**
+    * When the job was started.
+    */
+    'started'?: Date;
+    /**
+    * When the job was finished.
+    */
+    'finished'?: Date;
+    /**
+    * Whether the job finished successfully.
+    */
+    'finishedSuccessful'?: boolean;
+    /**
+    * The IDs of users who should be notified when a job is finished.
+    */
+    'jobNotificationUids': Array<number>;
+    /**
+    * Additional metadata associated with this job.
+    */
+    'additionalInfo'?: 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/jobSummaryResponse.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 { JobSummaryResponseAllOfSummary } from './jobSummaryResponseAllOfSummary';
+export declare class JobSummaryResponse {
+    /**
+    * Whether the operation succeeded
+    */
+    'success': boolean;
+    /**
+    * Optional error description (set if \'success\' was false)
+    */
+    'error'?: string;
+    'summary': Array<JobSummaryResponseAllOfSummary>;
+    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/jobSummaryResponseAllOf.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 { JobSummaryResponseAllOfSummary } from './jobSummaryResponseAllOfSummary';
+export declare class JobSummaryResponseAllOf {
+    'summary': Array<JobSummaryResponseAllOfSummary>;
+    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/jobSummaryResponseAllOfSummary.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 JobSummaryResponseAllOfSummary {
+    'category': string;
+    /**
+    * Length per category in milliseconds
+    */
+    'lengthMs': 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/kerasModelLayer.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 { KerasModelLayerInput } from './kerasModelLayerInput';
+import { KerasModelLayerOutput } from './kerasModelLayerOutput';
+export declare class KerasModelLayer {
+    'input': KerasModelLayerInput;
+    'output': KerasModelLayerOutput;
+    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/kerasModelLayerInput.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 KerasModelLayerInput {
+    /**
+    * Input size
+    */
+    'shape': number;
+    /**
+    * TensorFlow name
+    */
+    'name': string;
+    /**
+    * TensorFlow type
+    */
+    'type': 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/kerasModelLayerOutput.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 KerasModelLayerOutput {
+    /**
+    * Output size
+    */
+    'shape': number;
+    /**
+    * TensorFlow name
+    */
+    'name': string;
+    /**
+    * TensorFlow type
+    */
+    'type': string;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}