Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Grab a segment image from the auto-labeler
Project ID
Which image to receive from the auto-labeler
OK
Download a sample in it's original format as uploaded to the ingestion service.
Project ID
Sample ID
CBOR or JSON file
Get a sample as an image file. This only applies to samples with RGBA data.
Project ID
Sample ID
Whether to process the image through the input block first
If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).
Image file (either JPEG or PNG format)
Get a sample as an video file. This only applies to samples with video data.
Project ID
Sample ID
Whether to process the image through the input block first
If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).
Video file in AVI or MP4 format
Get a sample as a WAV file. This only applies to samples with an audio axis.
Project ID
Sample ID
Axis index
Begin index of the slice. If not given, the whole sample is used.
End index of the slice. If not given, the whole sample is used.
If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).
Wav file
Get a sample.
Project ID
Sample ID
Limit the number of payload values in the response
If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
2
"idle01.d8Ae"
Whether signature validation passed
true
"HS256"
Either the shared key or the public key that was used to validate the sample
Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.
Timestamp when the sample was last modified.
"training"
"healthy-machine"
Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.
16
Frequency of the sample. If the data was resampled, then this lists the resampled frequency.
62.5
Interval between two windows (1000 / frequency) in the source data (before resampling).
16
Frequency of the sample in the source data (before resampling).
62.5
Name of the axis
"accX"
Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).
Number of readings in this file
Total length (in ms.) of this file
Timestamp when the sample was added to the current acquisition bucket.
True if the current sample is excluded from use
True if the current sample is still processing (e.g. for video)
Set when sample is processing and a job has picked up the request
Set when processing this sample failed
Error (only set when processing this sample failed)
Whether the sample is cropped from another sample (and has crop start / end info)
Sample free form associated metadata
Unique identifier of the project this sample belongs to
Name of the owner of the project this sample belongs to
Name of the project this sample belongs to
What labeling flow the project this sample belongs to uses
Data sample SHA 256 hash (including CBOR envelope if applicable)
Start index of the label (e.g. 0)
End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.
The label for this section.
Sensor readings and metadata
Unique identifier for this device. Only set this when the device has a globally unique identifier (e.g. MAC address).
"ac:87:a3:0a:2d:1b"
Device type, for example the exact model of the device. Should be the same for all similar devices.
"DISCO-L475VG-IOT01A"
Array with sensor axes
Name of the axis
"accX"
Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).
Array of sensor values. One array item per interval, and as many items in this array as there are sensor axes. This type is returned if there are multiple axes.
New start index of the cropped sample
0
New end index of the cropped sample
128
Total number of payload values
Get a slice of a sample.
Project ID
Sample ID
Begin index of the slice
End index of the slice. If not given, the sample will be sliced to the same length as the impulse input block window length.
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
2
"idle01.d8Ae"
Whether signature validation passed
true
"HS256"
Either the shared key or the public key that was used to validate the sample
Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.
Timestamp when the sample was last modified.
"training"
"healthy-machine"
Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.
16
Frequency of the sample. If the data was resampled, then this lists the resampled frequency.
62.5
Interval between two windows (1000 / frequency) in the source data (before resampling).
16
Frequency of the sample in the source data (before resampling).
62.5
Name of the axis
"accX"
Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).
Number of readings in this file
Total length (in ms.) of this file
Timestamp when the sample was added to the current acquisition bucket.
True if the current sample is excluded from use
True if the current sample is still processing (e.g. for video)
Set when sample is processing and a job has picked up the request
Set when processing this sample failed
Error (only set when processing this sample failed)
Whether the sample is cropped from another sample (and has crop start / end info)
Sample free form associated metadata
Unique identifier of the project this sample belongs to
Name of the owner of the project this sample belongs to
Name of the project this sample belongs to
What labeling flow the project this sample belongs to uses
Data sample SHA 256 hash (including CBOR envelope if applicable)
Start index of the label (e.g. 0)
End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.
The label for this section.
Sensor readings and metadata
Unique identifier for this device. Only set this when the device has a globally unique identifier (e.g. MAC address).
"ac:87:a3:0a:2d:1b"
Device type, for example the exact model of the device. Should be the same for all similar devices.
"DISCO-L475VG-IOT01A"
Array with sensor axes
Name of the axis
"accX"
Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).
Array of sensor values. One array item per interval, and as many items in this array as there are sensor axes. This type is returned if there are multiple axes.
New start index of the cropped sample
0
New end index of the cropped sample
128
Total number of payload values
Enable a sample, ensuring that it is not excluded from the dataset.
Project ID
Sample ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
If a sample failed processing, retry the processing operation.
Project ID
Sample ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Clears the bounding box labels and moves item back to labeling queue
Project ID
Sample ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Remove the current data explorer state
Project ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Clears all object detection labels for this dataset, and places all images back in the labeling queue.
Project ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Disable a sample, ensuring that it is excluded from the dataset.
Project ID
Sample ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Deletes the sample. Note that this does not delete the data from cold storage.
Project ID
Sample ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Deletes all samples for this project over all categories. This also invalidates all DSP and learn blocks. Note that this does not delete the data from cold storage.
Project ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Determine if label noise metrics have been calculated. To calculate these metrics, use the calculateDataQualityMetrics
endpoint.
Project ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
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).
Block type (either time-series or image)
"time-series"
Block name, will be used in menus
"Time series"
Block title, used in the impulse UI
"Time series"
Size of the sliding window in milliseconds
2004
We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step.
(Input only) Frequency of the input data in Hz
60
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.
Whether to zero pad data when a data item is too short
Width all images are resized to before training
28
Width all images are resized to before training
28
How to resize images before training
"squash"
Resize method to use when resizing images
"squash"
If images are resized using a crop, choose where to anchor the crop
"middle-center"
Whether this block is the primary version of its base block.
The version number of the original block this version was based on. If this is an original block, will be undefined.
The version number of the original tuner block this version was based on. If this is an original tuner block, will be undefined
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
Specifies if this block was copied from a tuner block when a tuner model variant was set as primary model
ID of block this block version was cloned from
Specifies if this block was updated after being cloned/created
Whether is block is enabled. A block is assumed to be enabled when unset.
Whether block is stored in database.
A short description of the block version, displayed in the block versioning UI
"Reduced learning rate and more layers"
The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.
"createImpulse"
The datetime that the block version was created. Cannot be set via API.
Determine if data diversity metrics have been calculated. To calculate these metrics, use the calculateDataQualityMetrics
endpoint.
Project ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
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).
Block type (either time-series or image)
"time-series"
Block name, will be used in menus
"Time series"
Block title, used in the impulse UI
"Time series"
Size of the sliding window in milliseconds
2004
We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step.
(Input only) Frequency of the input data in Hz
60
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.
Whether to zero pad data when a data item is too short
Width all images are resized to before training
28
Width all images are resized to before training
28
How to resize images before training
"squash"
Resize method to use when resizing images
"squash"
If images are resized using a crop, choose where to anchor the crop
"middle-center"
Whether this block is the primary version of its base block.
The version number of the original block this version was based on. If this is an original block, will be undefined.
The version number of the original tuner block this version was based on. If this is an original tuner block, will be undefined
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
Specifies if this block was copied from a tuner block when a tuner model variant was set as primary model
ID of block this block version was cloned from
Specifies if this block was updated after being cloned/created
Whether is block is enabled. A block is assumed to be enabled when unset.
Whether block is stored in database.
A short description of the block version, displayed in the block versioning UI
"Reduced learning rate and more layers"
The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.
"createImpulse"
The datetime that the block version was created. Cannot be set via API.
Deletes samples. Note that this does not delete the data from cold storage.
Project ID
Which of the three acquisition categories to retrieve data from
Only include samples with a label within the given list of labels, given as a JSON string
"[\"idle\", \"snake\"]"
Only include samples whose filename includes the given filename
Only include samples shorter than the given length, in milliseconds
Only include samples longer than the given length, in milliseconds
Only include samples with higher frequency than given frequency, in hertz
Only include samples with lower frequency than given frequency, in hertz
Include samples with either valid or invalid signatures
Include only enabled or disabled samples (or both)
Only include samples with an ID within the given list of IDs, given as a JSON string
"[1, 2, 3]"
Exclude samples with an ID within the given list of IDs, given as a JSON string
"[4, 5, 6]"
Search query
"<id> <name>"
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Disables samples, ensuring that they are excluded from the dataset.
Project ID
Which of the three acquisition categories to retrieve data from
Only include samples with a label within the given list of labels, given as a JSON string
"[\"idle\", \"snake\"]"
Only include samples whose filename includes the given filename
Only include samples shorter than the given length, in milliseconds
Only include samples longer than the given length, in milliseconds
Only include samples with higher frequency than given frequency, in hertz
Only include samples with lower frequency than given frequency, in hertz
Include samples with either valid or invalid signatures
Include only enabled or disabled samples (or both)
Only include samples with an ID within the given list of IDs, given as a JSON string
"[1, 2, 3]"
Exclude samples with an ID within the given list of IDs, given as a JSON string
"[4, 5, 6]"
Search query
"<id> <name>"
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Adds or updates the metadata associated to a sample.
Project ID
Sample ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Deletes all samples for this project over a single category. Note that this does not delete the data from cold storage.
Project ID
Which of the three acquisition categories to download data from
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Split a video sample into individual frames.
Project ID
Sample ID
Frames per second to extract from this video.
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Enables samples, ensuring that they are not excluded from the dataset.
Project ID
Which of the three acquisition categories to retrieve data from
Only include samples with a label within the given list of labels, given as a JSON string
"[\"idle\", \"snake\"]"
Only include samples whose filename includes the given filename
Only include samples shorter than the given length, in milliseconds
Only include samples longer than the given length, in milliseconds
Only include samples with higher frequency than given frequency, in hertz
Only include samples with lower frequency than given frequency, in hertz
Include samples with either valid or invalid signatures
Include only enabled or disabled samples (or both)
Only include samples with an ID within the given list of IDs, given as a JSON string
"[1, 2, 3]"
Exclude samples with an ID within the given list of IDs, given as a JSON string
"[4, 5, 6]"
Search query
"<id> <name>"
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Used internally (from a data pipeline) to upload a picture of the data explorer
Project ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Move a sample to another category (e.g. from test to training).
Project ID
Sample ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
When segmenting a sample into smaller segments, store the segment length to ensure uniform segment lengths.
Project ID
Last segment length in milliseconds.
1000
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Get all unlabeled items from the object detection queue.
Project ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Get count for unlabeled items from the object detection queue.
Project ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Sets the label (also known as class) of the sample. Use the same label for similar types of data, as they are used during training.
Project ID
Sample ID
New label for this sample
"water-hammer"
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Sets the file name of the sample. This name does not need to be unique, but it's highly recommended to do so.
Project ID
Sample ID
New name for this sample
"faulty-machine2.A3de"
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Get data explorer configuration, like the type of data, and the input / dsp block to use.
Project ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Preset to use for the data explorer.
Lists all data with an 'imported from' metadata key. Used to check in a data source which items are already in a project.
Project ID
Maximum number of results
Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Sets the label (also known as class) of multiple samples.
Project ID
Which of the three acquisition categories to retrieve data from
Only include samples with a label within the given list of labels, given as a JSON string
"[\"idle\", \"snake\"]"
Only include samples whose filename includes the given filename
Only include samples shorter than the given length, in milliseconds
Only include samples longer than the given length, in milliseconds
Only include samples with higher frequency than given frequency, in hertz
Only include samples with lower frequency than given frequency, in hertz
Include samples with either valid or invalid signatures
Include only enabled or disabled samples (or both)
Only include samples with an ID within the given list of IDs, given as a JSON string
"[1, 2, 3]"
Exclude samples with an ID within the given list of IDs, given as a JSON string
"[4, 5, 6]"
Search query
"<id> <name>"
New label for this sample
"water-hammer"
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Move multiple samples to another category (e.g. from test to training).
Project ID
Which of the three acquisition categories to retrieve data from
Only include samples with a label within the given list of labels, given as a JSON string
"[\"idle\", \"snake\"]"
Only include samples whose filename includes the given filename
Only include samples shorter than the given length, in milliseconds
Only include samples longer than the given length, in milliseconds
Only include samples with higher frequency than given frequency, in hertz
Only include samples with lower frequency than given frequency, in hertz
Include samples with either valid or invalid signatures
Include only enabled or disabled samples (or both)
Only include samples with an ID within the given list of IDs, given as a JSON string
"[1, 2, 3]"
Exclude samples with an ID within the given list of IDs, given as a JSON string
"[4, 5, 6]"
Search query
"<id> <name>"
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Rebalances the dataset over training / testing categories. This resets the category for all data and splits it 80%/20% between training and testing. This is a deterministic process based on the hash of the name of the data.
Project ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
number of training samples after rebalance
number of testing samples after rebalance
Set data explorer configuration, like the type of data, and the input / dsp block to use.
Project ID
Preset to use for the data explorer.
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Slice a sample into multiple segments. The original file will be marked as deleted, but you can crop any created segment to retrieve the original file.
Project ID
Sample ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Count all raw data by category.
Project ID
Which of the three acquisition categories to retrieve data from
Only include samples with a label within the given list of labels, given as a JSON string
"[\"idle\", \"snake\"]"
Only include samples whose filename includes the given filename
Only include samples shorter than the given length, in milliseconds
Only include samples longer than the given length, in milliseconds
Only include samples with higher frequency than given frequency, in hertz
Only include samples with lower frequency than given frequency, in hertz
Include samples with either valid or invalid signatures
Include only enabled or disabled samples (or both)
Search query
"<id> <name>"
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Track objects between two samples. Source sample should have bounding boxes set.
Project ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Run the auto-labeler over all unlabeled data.
Project ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Job identifier. Status updates will include this identifier.
12873488112
Set labels for all auto-segment clusters.
Project ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Crop a sample to within a new range.
Project ID
Sample ID
New start index of the sample
0
New end index of the sample
128
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Retrieve the results of the auto-labeler (after running StartJobResponse
)
Project ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Find start and end times for all non-noise events in a sample
Project ID
Sample ID
If set, the segments are automatically shifted randomly, to make the dataset distribution more uniform.
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Set the bounding boxes for a sample
Project ID
Sample ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Set structured labels for a sample. If a sample has structured labels the label
column is ignored, and the sample is allowed to have multiple labels. An array of { startIndex, endIndex, label } needs to be passed in with labels for the complete sample (see valuesCount
to get the upper bound). endIndex is inclusive. If you pass in an incorrect array (e.g. missing values) you'll get an error back.
Project ID
Sample ID
Start index of the label (e.g. 0)
End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.
The label for this section.
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Get metadata for all samples in a project.
Project ID
Which of the three acquisition categories to retrieve data from
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Array with all available sample metadata.
Sample ID
Sample free form associated metadata
Classify an image using another neural network.
Project ID
Sample ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Predictions for every data explorer point (only available when using current impulse to populate data explorer)
Project ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Only set for object detection projects
Only set for visual anomaly projects. 2D array of shape (n, n) with raw anomaly scores, where n can be calculated as ((1/8 of image input size)/2 - 1). The scores corresponds to each grid cell in the image's spatial matrix.
t-SNE2 output of the raw dataset
Project ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
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).
Block type (either time-series or image)
"time-series"
Block name, will be used in menus
"Time series"
Block title, used in the impulse UI
"Time series"
Size of the sliding window in milliseconds
2004
We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step.
(Input only) Frequency of the input data in Hz
60
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.
Whether to zero pad data when a data item is too short
Width all images are resized to before training
28
Width all images are resized to before training
28
How to resize images before training
"squash"
Resize method to use when resizing images
"squash"
If images are resized using a crop, choose where to anchor the crop
"middle-center"
Whether this block is the primary version of its base block.
The version number of the original block this version was based on. If this is an original block, will be undefined.
The version number of the original tuner block this version was based on. If this is an original tuner block, will be undefined
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
Specifies if this block was copied from a tuner block when a tuner model variant was set as primary model
ID of block this block version was cloned from
Specifies if this block was updated after being cloned/created
Whether is block is enabled. A block is assumed to be enabled when unset.
Whether block is stored in database.
A short description of the block version, displayed in the block versioning UI
"Reduced learning rate and more layers"
The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.
"createImpulse"
The datetime that the block version was created. Cannot be set via API.
Retrieve all raw data by category.
Project ID
Which of the three acquisition categories to retrieve data from
Maximum number of results
Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
Whether to exclude sensors in the response (as these can slow down requests when you have large pages).
Only include samples with a label within the given list of labels, given as a JSON string
"[\"idle\", \"snake\"]"
Only include samples whose filename includes the given filename
Only include samples shorter than the given length, in milliseconds
Only include samples longer than the given length, in milliseconds
Only include samples with higher frequency than given frequency, in hertz
Only include samples with lower frequency than given frequency, in hertz
Include samples with either valid or invalid signatures
Include only enabled or disabled samples (or both)
Search query
"<id> <name>"
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
2
"idle01.d8Ae"
Whether signature validation passed
true
"HS256"
Either the shared key or the public key that was used to validate the sample
Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.
Timestamp when the sample was last modified.
"training"
"healthy-machine"
Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.
16
Frequency of the sample. If the data was resampled, then this lists the resampled frequency.
62.5
Interval between two windows (1000 / frequency) in the source data (before resampling).
16
Frequency of the sample in the source data (before resampling).
62.5
Name of the axis
"accX"
Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).
Number of readings in this file
Total length (in ms.) of this file
Timestamp when the sample was added to the current acquisition bucket.
True if the current sample is excluded from use
True if the current sample is still processing (e.g. for video)
Set when sample is processing and a job has picked up the request
Set when processing this sample failed
Error (only set when processing this sample failed)
Whether the sample is cropped from another sample (and has crop start / end info)
Sample free form associated metadata
Unique identifier of the project this sample belongs to
Name of the owner of the project this sample belongs to
Name of the project this sample belongs to
What labeling flow the project this sample belongs to uses
Data sample SHA 256 hash (including CBOR envelope if applicable)
Start index of the label (e.g. 0)
End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.
The label for this section.
t-SNE2 output of the raw dataset
Project ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Data by feature index for this window
"`{ 0: 9.81, 11: 0.32, 22: 0.79 }`"
Training label index
Training label string
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).
Block type (either time-series or image)
"time-series"
Block name, will be used in menus
"Time series"
Block title, used in the impulse UI
"Time series"
Size of the sliding window in milliseconds
2004
We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step.
(Input only) Frequency of the input data in Hz
60
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.
Whether to zero pad data when a data item is too short
Width all images are resized to before training
28
Width all images are resized to before training
28
How to resize images before training
"squash"
Resize method to use when resizing images
"squash"
If images are resized using a crop, choose where to anchor the crop
"middle-center"
Whether this block is the primary version of its base block.
The version number of the original block this version was based on. If this is an original block, will be undefined.
The version number of the original tuner block this version was based on. If this is an original tuner block, will be undefined
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
Specifies if this block was copied from a tuner block when a tuner model variant was set as primary model
ID of block this block version was cloned from
Specifies if this block was updated after being cloned/created
Whether is block is enabled. A block is assumed to be enabled when unset.
Whether block is stored in database.
A short description of the block version, displayed in the block versioning UI
"Reduced learning rate and more layers"
The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.
"createImpulse"
The datetime that the block version was created. Cannot be set via API.
Get info from a specific segment in an image. Pass in both sampleId and segmentId in the URL.
Project ID
Sample ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
2
"idle01.d8Ae"
Whether signature validation passed
true
"HS256"
Either the shared key or the public key that was used to validate the sample
Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.
Timestamp when the sample was last modified.
"training"
"healthy-machine"
Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.
16
Frequency of the sample. If the data was resampled, then this lists the resampled frequency.
62.5
Interval between two windows (1000 / frequency) in the source data (before resampling).
16
Frequency of the sample in the source data (before resampling).
62.5
Name of the axis
"accX"
Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).
Number of readings in this file
Total length (in ms.) of this file
Timestamp when the sample was added to the current acquisition bucket.
True if the current sample is excluded from use
True if the current sample is still processing (e.g. for video)
Set when sample is processing and a job has picked up the request
Set when processing this sample failed
Error (only set when processing this sample failed)
Whether the sample is cropped from another sample (and has crop start / end info)
Sample free form associated metadata
Unique identifier of the project this sample belongs to
Name of the owner of the project this sample belongs to
Name of the project this sample belongs to
What labeling flow the project this sample belongs to uses
Data sample SHA 256 hash (including CBOR envelope if applicable)
Start index of the label (e.g. 0)
End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.
The label for this section.
Obtain metrics that describe the similarity and diversity of a dataset. To calculate these metrics, use the calculateDataQualityMetrics
endpoint.
Project ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Unique index of the cluster
Indexes of all windows contained in the cluster (for debugging)
The sample ID and window start and end of every window in the cluster
Details of every sample in the cluster
2
"idle01.d8Ae"
Whether signature validation passed
true
"HS256"
Either the shared key or the public key that was used to validate the sample
Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.
Timestamp when the sample was last modified.
"training"
"healthy-machine"
Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.
16
Frequency of the sample. If the data was resampled, then this lists the resampled frequency.
62.5
Interval between two windows (1000 / frequency) in the source data (before resampling).
16
Frequency of the sample in the source data (before resampling).
62.5
Name of the axis
"accX"
Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).
Number of readings in this file
Total length (in ms.) of this file
Timestamp when the sample was added to the current acquisition bucket.
True if the current sample is excluded from use
True if the current sample is still processing (e.g. for video)
Set when sample is processing and a job has picked up the request
Set when processing this sample failed
Error (only set when processing this sample failed)
Whether the sample is cropped from another sample (and has crop start / end info)
Sample free form associated metadata
Unique identifier of the project this sample belongs to
Name of the owner of the project this sample belongs to
Name of the project this sample belongs to
What labeling flow the project this sample belongs to uses
Data sample SHA 256 hash (including CBOR envelope if applicable)
Start index of the label (e.g. 0)
End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.
The label for this section.
Raw vendi score
Vendi score expressed as ratio from 0 to 1
The number if windows in the cluster
The distance of the cluster from the origin
The cluster id on the left branch of the dendrogram
The cluster id on the right branch of the dendrogram
Get the original, uncropped, downsampled data.
Project ID
Sample ID
Limit the number of payload values in the response
Zoom into the sample, with the focus starting at this index
Zoom into the sample, with the focus ending at this index
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
2
"idle01.d8Ae"
Whether signature validation passed
true
"HS256"
Either the shared key or the public key that was used to validate the sample
Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.
Timestamp when the sample was last modified.
"training"
"healthy-machine"
Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.
16
Frequency of the sample. If the data was resampled, then this lists the resampled frequency.
62.5
Interval between two windows (1000 / frequency) in the source data (before resampling).
16
Frequency of the sample in the source data (before resampling).
62.5
Name of the axis
"accX"
Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).
Number of readings in this file
Total length (in ms.) of this file
Timestamp when the sample was added to the current acquisition bucket.
True if the current sample is excluded from use
True if the current sample is still processing (e.g. for video)
Set when sample is processing and a job has picked up the request
Set when processing this sample failed
Error (only set when processing this sample failed)
Whether the sample is cropped from another sample (and has crop start / end info)
Sample free form associated metadata
Unique identifier of the project this sample belongs to
Name of the owner of the project this sample belongs to
Name of the project this sample belongs to
What labeling flow the project this sample belongs to uses
Data sample SHA 256 hash (including CBOR envelope if applicable)
Start index of the label (e.g. 0)
End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.
The label for this section.
Sensor readings and metadata
Unique identifier for this device. Only set this when the device has a globally unique identifier (e.g. MAC address).
"ac:87:a3:0a:2d:1b"
Device type, for example the exact model of the device. Should be the same for all similar devices.
"DISCO-L475VG-IOT01A"
Array with sensor axes
Name of the axis
"accX"
Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).
Array of sensor values. One array item per interval, and as many items in this array as there are sensor axes. This type is returned if there are multiple axes.
New start index of the cropped sample
0
New end index of the cropped sample
128
Total number of payload values
Obtain metrics that describe potential label noise issues in the dataset. To calculate these metrics, use the calculateDataQualityMetrics
endpoint.
Project ID
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
Describes the results of running the cosine similarity label noise detection method.
A list of samples that have windows that are similar to windows of other samples that have a different label.
The ID of this sample
2
"idle01.d8Ae"
Whether signature validation passed
true
"HS256"
Either the shared key or the public key that was used to validate the sample
Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.
Timestamp when the sample was last modified.
"training"
"healthy-machine"
Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.
16
Frequency of the sample. If the data was resampled, then this lists the resampled frequency.
62.5
Interval between two windows (1000 / frequency) in the source data (before resampling).
16
Frequency of the sample in the source data (before resampling).
62.5
Name of the axis
"accX"
Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).
Number of readings in this file
Total length (in ms.) of this file
Timestamp when the sample was added to the current acquisition bucket.
True if the current sample is excluded from use
True if the current sample is still processing (e.g. for video)
Set when sample is processing and a job has picked up the request
Set when processing this sample failed
Error (only set when processing this sample failed)
Whether the sample is cropped from another sample (and has crop start / end info)
Sample free form associated metadata
Unique identifier of the project this sample belongs to
Name of the owner of the project this sample belongs to
Name of the project this sample belongs to
What labeling flow the project this sample belongs to uses
Data sample SHA 256 hash (including CBOR envelope if applicable)
Start index of the label (e.g. 0)
End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.
The label for this section.
The label of this sample, in index form
A list of samples that have windows that are symptomatic of this issue.
The ID of this sample
2
"idle01.d8Ae"
Whether signature validation passed
true
"HS256"
Either the shared key or the public key that was used to validate the sample
Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.
Timestamp when the sample was last modified.
"training"
"healthy-machine"
Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.
16
Frequency of the sample. If the data was resampled, then this lists the resampled frequency.
62.5
Interval between two windows (1000 / frequency) in the source data (before resampling).
16
Frequency of the sample in the source data (before resampling).
62.5
Name of the axis
"accX"
Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).
Number of readings in this file
Total length (in ms.) of this file
Timestamp when the sample was added to the current acquisition bucket.
True if the current sample is excluded from use
True if the current sample is still processing (e.g. for video)
Set when sample is processing and a job has picked up the request
Set when processing this sample failed
Error (only set when processing this sample failed)
Whether the sample is cropped from another sample (and has crop start / end info)
Sample free form associated metadata
Unique identifier of the project this sample belongs to
Name of the owner of the project this sample belongs to
Name of the project this sample belongs to
What labeling flow the project this sample belongs to uses
Data sample SHA 256 hash (including CBOR envelope if applicable)
Start index of the label (e.g. 0)
End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.
The label for this section.
The label of this sample, in index form
The windows in this sample that are symptomatic of this issue.
The start time of this window in milliseconds
The end time of this window in milliseconds
The cosine similarity score between this window and a window from the sample in the parent object.
A list of samples that have windows that are dissimilar to windows of other samples that have the same label.
The ID of this sample
2
"idle01.d8Ae"
Whether signature validation passed
true
"HS256"
Either the shared key or the public key that was used to validate the sample
Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.
Timestamp when the sample was last modified.
"training"
"healthy-machine"
Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.
16
Frequency of the sample. If the data was resampled, then this lists the resampled frequency.
62.5
Interval between two windows (1000 / frequency) in the source data (before resampling).
16
Frequency of the sample in the source data (before resampling).
62.5
Name of the axis
"accX"
Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).
Number of readings in this file
Total length (in ms.) of this file
Timestamp when the sample was added to the current acquisition bucket.
True if the current sample is excluded from use
True if the current sample is still processing (e.g. for video)
Set when sample is processing and a job has picked up the request
Set when processing this sample failed
Error (only set when processing this sample failed)
Whether the sample is cropped from another sample (and has crop start / end info)
Sample free form associated metadata
Unique identifier of the project this sample belongs to
Name of the owner of the project this sample belongs to
Name of the project this sample belongs to
What labeling flow the project this sample belongs to uses
Data sample SHA 256 hash (including CBOR envelope if applicable)
Start index of the label (e.g. 0)
End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.
The label for this section.
The label of this sample, in index form
A list of samples that have windows that are symptomatic of this issue.
The ID of this sample
2
"idle01.d8Ae"
Whether signature validation passed
true
"HS256"
Either the shared key or the public key that was used to validate the sample
Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.
Timestamp when the sample was last modified.
"training"
"healthy-machine"
Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.
16
Frequency of the sample. If the data was resampled, then this lists the resampled frequency.
62.5
Interval between two windows (1000 / frequency) in the source data (before resampling).
16
Frequency of the sample in the source data (before resampling).
62.5
Name of the axis
"accX"
Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).
Number of readings in this file
Total length (in ms.) of this file
Timestamp when the sample was added to the current acquisition bucket.
True if the current sample is excluded from use
True if the current sample is still processing (e.g. for video)
Set when sample is processing and a job has picked up the request
Set when processing this sample failed
Error (only set when processing this sample failed)
Whether the sample is cropped from another sample (and has crop start / end info)
Sample free form associated metadata
Unique identifier of the project this sample belongs to
Name of the owner of the project this sample belongs to
Name of the project this sample belongs to
What labeling flow the project this sample belongs to uses
Data sample SHA 256 hash (including CBOR envelope if applicable)
Start index of the label (e.g. 0)
End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.
The label for this section.
The label of this sample, in index form
The windows in this sample that are symptomatic of this issue.
The start time of this window in milliseconds
The end time of this window in milliseconds
The cosine similarity score between this window and a window from the sample in the parent object.
Describes the results of running the nearest neighbors label noise detection method.
The label noise score and nearest neighbors for each window of data in the project that shows a potential label noise issue.
The ID of the sample this window belongs to
2
"idle01.d8Ae"
Whether signature validation passed
true
"HS256"
Either the shared key or the public key that was used to validate the sample
Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.
Timestamp when the sample was last modified.
"training"
"healthy-machine"
Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.
16
Frequency of the sample. If the data was resampled, then this lists the resampled frequency.
62.5
Interval between two windows (1000 / frequency) in the source data (before resampling).
16
Frequency of the sample in the source data (before resampling).
62.5
Name of the axis
"accX"
Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).
Number of readings in this file
Total length (in ms.) of this file
Timestamp when the sample was added to the current acquisition bucket.
True if the current sample is excluded from use
True if the current sample is still processing (e.g. for video)
Set when sample is processing and a job has picked up the request
Set when processing this sample failed
Error (only set when processing this sample failed)
Whether the sample is cropped from another sample (and has crop start / end info)
Sample free form associated metadata
Unique identifier of the project this sample belongs to
Name of the owner of the project this sample belongs to
Name of the project this sample belongs to
What labeling flow the project this sample belongs to uses
Data sample SHA 256 hash (including CBOR envelope if applicable)
Start index of the label (e.g. 0)
End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.
The label for this section.
The start time of this window in milliseconds
The end time of this window in milliseconds
The label noise score for this window, from 0 to the total number of windows.
Details of the nearest neighbors to this window
The ID of the sample this window belongs to
2
"idle01.d8Ae"
Whether signature validation passed
true
"HS256"
Either the shared key or the public key that was used to validate the sample
Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.
Timestamp when the sample was last modified.
"training"
"healthy-machine"
Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.
16
Frequency of the sample. If the data was resampled, then this lists the resampled frequency.
62.5
Interval between two windows (1000 / frequency) in the source data (before resampling).
16
Frequency of the sample in the source data (before resampling).
62.5
Name of the axis
"accX"
Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).
Number of readings in this file
Total length (in ms.) of this file
Timestamp when the sample was added to the current acquisition bucket.
True if the current sample is excluded from use
True if the current sample is still processing (e.g. for video)
Set when sample is processing and a job has picked up the request
Set when processing this sample failed
Error (only set when processing this sample failed)
Whether the sample is cropped from another sample (and has crop start / end info)
Sample free form associated metadata
Unique identifier of the project this sample belongs to
Name of the owner of the project this sample belongs to
Name of the project this sample belongs to
What labeling flow the project this sample belongs to uses
Data sample SHA 256 hash (including CBOR envelope if applicable)
Start index of the label (e.g. 0)
End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.
The label for this section.
The start time of this window in milliseconds
The end time of this window in milliseconds
The number of neighbors used in the nearest neighbors algorithm.
Describes the results of running the cross validation label noise detection method.
The ID of the sample this window belongs to
2
"idle01.d8Ae"
Whether signature validation passed
true
"HS256"
Either the shared key or the public key that was used to validate the sample
Timestamp when the sample was created on device, or if no accurate time was known on device, the time that the file was processed by the ingestion service.
Timestamp when the sample was last modified.
"training"
"healthy-machine"
Interval between two windows (1000 / frequency). If the data was resampled, then this lists the resampled interval.
16
Frequency of the sample. If the data was resampled, then this lists the resampled frequency.
62.5
Interval between two windows (1000 / frequency) in the source data (before resampling).
16
Frequency of the sample in the source data (before resampling).
62.5
Name of the axis
"accX"
Type of data on this axis. Needs to comply to SenML units (see https://www.iana.org/assignments/senml/senml.xhtml).
Number of readings in this file
Total length (in ms.) of this file
Timestamp when the sample was added to the current acquisition bucket.
True if the current sample is excluded from use
True if the current sample is still processing (e.g. for video)
Set when sample is processing and a job has picked up the request
Set when processing this sample failed
Error (only set when processing this sample failed)
Whether the sample is cropped from another sample (and has crop start / end info)
Sample free form associated metadata
Unique identifier of the project this sample belongs to
Name of the owner of the project this sample belongs to
Name of the project this sample belongs to
What labeling flow the project this sample belongs to uses
Data sample SHA 256 hash (including CBOR envelope if applicable)
Start index of the label (e.g. 0)
End index of the label (e.g. 3). This value is inclusive, so { startIndex: 0, endIndex: 3 } covers 0, 1, 2, 3.
The label for this section.
The start time of this window in milliseconds
The end time of this window in milliseconds
The label of this window, in index form
The probability of this window being the label it was assigned, as estimated by a classifier trained on the whole dataset.
The z-score of the probability with respect to other class members, so that outliers (i.e. windows whose probability is low) can be easily spotted. This assumes that most correctly labelled class members will have a high probability.