allows_read_only_api

edgeimpulse_api v1.0.0

edgeimpulse_api.api.allows_read_only_api module

class edgeimpulse_api.api.allows_read_only_api.AllowsReadOnlyApi(api_client=None)

Bases: object

anomaly_trained_features(project_id: StrictInt, learn_id: StrictInt, feature_ax1: StrictInt, feature_ax2: StrictInt, **kwargs)

Trained features

Get a sample of trained features, this extracts a number of samples and their features.

  • Parameters

    • project_id (int) – Project ID (required)

    • learn_id (int) – Learn Block ID, use the impulse functions to retrieve the ID (required)

    • feature_ax1 (int) – Feature axis 1 (required)

    • feature_ax2 (int) – Feature axis 2 (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

anomaly_trained_features_per_sample(project_id: StrictInt, learn_id: StrictInt, sample_id: StrictInt, **kwargs)

Trained features for sample

Get trained features for a single sample. This runs both the DSP prerequisites and the anomaly classifier.

  • Parameters

    • project_id (int) – Project ID (required)

    • learn_id (int) – Learn Block ID, use the impulse functions to retrieve the ID (required)

    • sample_id (int) – Sample ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

classify_sample(project_id: StrictInt, sample_id: StrictInt, **kwargs)

Classify sample

Classify a complete file against the current impulse. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and classify for every window that is extracted.

  • Parameters

    • project_id (int) – Project ID (required)

    • sample_id (int) – Sample ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

classify_sample_by_learn_block(project_id: StrictInt, sample_id: StrictInt, block_id: StrictInt, **kwargs)

Classify sample by learn block

Classify a complete file against the specified learn block. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and classify for every window that is extracted.

  • Parameters

    • project_id (int) – Project ID (required)

    • sample_id (int) – Sample ID (required)

    • block_id (int) – Block ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

count_samples(project_id: StrictInt, category: StrictStr, labels: Optional[StrictStr] = None, filename: Optional[StrictStr] = None, max_length: Optional[StrictInt] = None, min_length: Optional[StrictInt] = None, min_frequency: Optional[float] = None, max_frequency: Optional[float] = None, signature_validity: Optional[StrictStr] = None, include_disabled: Optional[StrictStr] = None, **kwargs)

Count samples

Count all raw data by category.

  • Parameters

    • project_id (int) – Project ID (required)

    • category (str) – Which of the three acquisition categories to retrieve data from (required)

    • labels (str) – Only include samples with a label within the given list of labels, given as a JSON string

    • filename (str) – Only include samples whose filename includes the given filename

    • max_length (int) – Only include samples shorter than the given length, in milliseconds

    • min_length (int) – Only include samples longer than the given length, in milliseconds

    • min_frequency (float) – Only include samples with higher frequency than given frequency, in hertz

    • max_frequency (float) – Only include samples with lower frequency than given frequency, in hertz

    • signature_validity (str) – Include samples with either valid or invalid signatures

    • include_disabled (str) – Include only enabled or disabled samples (or both)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

download_build(project_id: StrictInt, type: StrictStr, model_type: Optional[KerasModelTypeEnum] = None, engine: Optional[DeploymentTargetEngine] = None, **kwargs)

Download

Download the build artefacts for a project

  • Parameters

    • project_id (int) – Project ID (required)

    • type (str) – The name of the built target. You can find this by listing all deployment targets through listDeploymentTargetsForProject (via GET /v1/api/{projectId}/deployment/targets) and see the format type. (required)

    • model_type (KerasModelTypeEnum) – Optional model type of the build (if not, it uses the settings in the Keras block)

    • engine (DeploymentTargetEngine) – Optional engine for the build (if not, it uses the default engine for the deployment target)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

  • Return type

    str

download_dsp_data(project_id: StrictInt, dsp_id: StrictInt, category: StrictStr, raw: Optional[StrictBool] = None, **kwargs)

Download DSP data

Download output from a DSP block over all data in the training set, already sliced in windows. In Numpy binary format.

  • Parameters

    • project_id (int) – Project ID (required)

    • dsp_id (int) – DSP Block ID, use the impulse functions to retrieve the ID (required)

    • category (str) – Which of the three acquisition categories to download data from (required)

    • raw (bool) – Whether to download raw data or processed data. Processed data is the default.

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

  • Return type

    str

download_dsp_labels(project_id: StrictInt, dsp_id: StrictInt, category: StrictStr, **kwargs)

Download DSP labels

Download labels for a DSP block over all data in the training set, already sliced in windows.

  • Parameters

    • project_id (int) – Project ID (required)

    • dsp_id (int) – DSP Block ID, use the impulse functions to retrieve the ID (required)

    • category (str) – Which of the three acquisition categories to download data from (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

  • Return type

    str

download_learn_model(project_id: StrictInt, learn_id: StrictInt, model_download_id: StrictStr, **kwargs)

Download trained model

Download a trained model for a learning block. Depending on the block this can be a TensorFlow model, or the cluster centroids.

  • Parameters

    • project_id (int) – Project ID (required)

    • learn_id (int) – Learn Block ID, use the impulse functions to retrieve the ID (required)

    • model_download_id (str) – Model download ID, which can be obtained from the project information (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

  • Return type

    str

dsp_get_features_for_sample(project_id: StrictInt, dsp_id: StrictInt, sample_id: StrictInt, **kwargs)

Features for sample

Runs the DSP block against a sample. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and run the DSP function for every window that is extracted.

  • Parameters

    • project_id (int) – Project ID (required)

    • dsp_id (int) – DSP Block ID, use the impulse functions to retrieve the ID (required)

    • sample_id (int) – Sample ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

dsp_sample_trained_features(project_id: StrictInt, dsp_id: StrictInt, feature_ax1: StrictInt, feature_ax2: StrictInt, feature_ax3: StrictInt, category: StrictStr, **kwargs)

Sample of trained features

Get a sample of trained features, this extracts a number of samples and their labels. Used to visualize the current training set.

  • Parameters

    • project_id (int) – Project ID (required)

    • dsp_id (int) – DSP Block ID, use the impulse functions to retrieve the ID (required)

    • feature_ax1 (int) – Feature axis 1 (required)

    • feature_ax2 (int) – Feature axis 2 (required)

    • feature_ax3 (int) – Feature axis 3 (required)

    • category (str) – Which of the three acquisition categories to download data from (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_anomaly_metadata(project_id: StrictInt, learn_id: StrictInt, **kwargs)

Anomaly metadata

Get metadata about a trained anomaly block. Use the impulse blocks to find the learnId.

  • Parameters

    • project_id (int) – Project ID (required)

    • learn_id (int) – Learn Block ID, use the impulse functions to retrieve the ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_classify_job_result(project_id: StrictInt, **kwargs)

Classify job result

Get classify job result, containing the result for the complete testing dataset.

  • Parameters

    • project_id (int) – Project ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_data_explorer_features(project_id: StrictInt, **kwargs)

Get data explorer features

t-SNE2 output of the raw dataset

  • Parameters

    • project_id (int) – Project ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_data_explorer_predictions(project_id: StrictInt, **kwargs)

Get data explorer predictions

Predictions for every data explorer point (only available when using current impulse to populate data explorer)

  • Parameters

    • project_id (int) – Project ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_dsp_metadata(project_id: StrictInt, dsp_id: StrictInt, **kwargs)

Get metadata

Retrieve the metadata from a generated DSP block.

  • Parameters

    • project_id (int) – Project ID (required)

    • dsp_id (int) – DSP Block ID, use the impulse functions to retrieve the ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_dsp_raw_sample(project_id: StrictInt, dsp_id: StrictInt, sample_id: StrictInt, limit_payload_values: Optional[StrictInt] = None, **kwargs)

Get raw sample

Get raw sample data, but with only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out. If you pass dspId = 0 this will return a raw graph without any processing.

  • Parameters

    • project_id (int) – Project ID (required)

    • dsp_id (int) – DSP Block ID, use the impulse functions to retrieve the ID (required)

    • sample_id (int) – Sample ID (required)

    • limit_payload_values (int) – Limit the number of payload values in the response

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_dsp_sample_slice(project_id: StrictInt, dsp_id: StrictInt, sample_id: StrictInt, slice_start: StrictInt, slice_end: StrictInt, **kwargs)

Get raw sample (slice)

Get slice of raw sample data, but with only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out.

  • Parameters

    • project_id (int) – Project ID (required)

    • dsp_id (int) – DSP Block ID, use the impulse functions to retrieve the ID (required)

    • sample_id (int) – Sample ID (required)

    • slice_start (int) – Begin index of the slice (required)

    • slice_end (int) – End index of the slice (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_keras_data_explorer_features(project_id: StrictInt, learn_id: StrictInt, **kwargs)

Get data explorer features

t-SNE2 output of the raw dataset using embeddings from this Keras block

  • Parameters

    • project_id (int) – Project ID (required)

    • learn_id (int) – Learn Block ID, use the impulse functions to retrieve the ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_keras_metadata(project_id: StrictInt, learn_id: StrictInt, **kwargs)

Keras metadata

Get metadata about a trained Keras block. Use the impulse blocks to find the learnId.

  • Parameters

    • project_id (int) – Project ID (required)

    • learn_id (int) – Learn Block ID, use the impulse functions to retrieve the ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_notes(project_id: StrictInt, **kwargs)

Get notes

Get all notes in project.

  • Parameters

    • project_id (int) – Project ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

  • Return type

    GetNotesResponse

get_performance_calibration_ground_truth(project_id: StrictInt, **kwargs)

Get ground truth

Get performance calibration ground truth data

  • Parameters

    • project_id (int) – Project ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_performance_calibration_parameter_sets(project_id: StrictInt, **kwargs)

Get parameter sets

Get performance calibration parameter sets

  • Parameters

    • project_id (int) – Project ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_performance_calibration_raw_result(project_id: StrictInt, **kwargs)

Get raw result

Get performance calibration raw result

  • Parameters

    • project_id (int) – Project ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_performance_calibration_saved_parameters(project_id: StrictInt, **kwargs)

Get parameters

Get performance calibration stored parameters

  • Parameters

    • project_id (int) – Project ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_performance_calibration_status(project_id: StrictInt, **kwargs)

Get status

Get performance calibration status

  • Parameters

    • project_id (int) – Project ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_project_info_summary(project_id: StrictInt, **kwargs)

Public project information

List a summary about this project - available for public projects.

  • Parameters

    • project_id (int) – Project ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_sample(project_id: StrictInt, sample_id: StrictInt, limit_payload_values: Optional[StrictInt] = None, **kwargs)

Get sample

Get a sample.

  • Parameters

    • project_id (int) – Project ID (required)

    • sample_id (int) – Sample ID (required)

    • limit_payload_values (int) – Limit the number of payload values in the response

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_sample_as_audio(project_id: StrictInt, sample_id: StrictInt, axis_ix: StrictInt, slice_start: Optional[StrictInt] = None, slice_end: Optional[StrictInt] = None, **kwargs)

Get WAV file

Get a sample as a WAV file. This only applies to samples with an audio axis.

  • Parameters

    • project_id (int) – Project ID (required)

    • sample_id (int) – Sample ID (required)

    • axis_ix (int) – Axis index (required)

    • slice_start (int) – Begin index of the slice

    • slice_end (int) – End index of the slice

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

  • Return type

    str

get_sample_as_image(project_id: StrictInt, sample_id: StrictInt, after_input_block: Optional[StrictBool] = None, **kwargs)

Get image file

Get a sample as an image file. This only applies to samples with RGBA data.

  • Parameters

    • project_id (int) – Project ID (required)

    • sample_id (int) – Sample ID (required)

    • after_input_block (bool) – Whether to process the image through the input block first

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

  • Return type

    str

get_sample_as_raw(project_id: StrictInt, sample_id: StrictInt, **kwargs)

Download file

Download a sample in it’s original format as uploaded to the ingestion service.

  • Parameters

    • project_id (int) – Project ID (required)

    • sample_id (int) – Sample ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

  • Return type

    str

get_sample_as_video(project_id: StrictInt, sample_id: StrictInt, after_input_block: Optional[StrictBool] = None, **kwargs)

Get video file

Get a sample as an video file. This only applies to samples with video data.

  • Parameters

    • project_id (int) – Project ID (required)

    • sample_id (int) – Sample ID (required)

    • after_input_block (bool) – Whether to process the image through the input block first

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

  • Return type

    str

get_sample_slice(project_id: StrictInt, sample_id: StrictInt, slice_start: StrictInt, slice_end: StrictInt, **kwargs)

Get sample slice

Get a slice of a sample.

  • Parameters

    • project_id (int) – Project ID (required)

    • sample_id (int) – Sample ID (required)

    • slice_start (int) – Begin index of the slice (required)

    • slice_end (int) – End index of the slice (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

get_wav_file(project_id: StrictInt, **kwargs)

Get WAV file

Get the synthetic sample as a WAV file

  • Parameters

    • project_id (int) – Project ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

  • Return type

    str

has_data_explorer_features(project_id: StrictInt, **kwargs)

Check data explorer features

t-SNE2 output of the raw dataset

  • Parameters

    • project_id (int) – Project ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

list_all_deployment_targets(**kwargs)

Deployment targets

List all deployment targets

  • Parameters

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

list_deployment_targets_for_project(project_id: StrictInt, **kwargs)

Deployment targets

List deployment targets for a project

  • Parameters

    • project_id (int) – Project ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

list_deployment_targets_for_project_data_sources(project_id: StrictInt, **kwargs)

Deployment targets (data sources)

List deployment targets for a project from data sources page (it shows some things like all Linux deploys, and hides ‘fake’ deploy targets like mobile phone / computer)

  • Parameters

    • project_id (int) – Project ID (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

list_samples(project_id: StrictInt, category: StrictStr, limit: Optional[StrictInt] = None, offset: Optional[StrictInt] = None, exclude_sensors: Optional[StrictBool] = None, labels: Optional[StrictStr] = None, filename: Optional[StrictStr] = None, max_length: Optional[StrictInt] = None, min_length: Optional[StrictInt] = None, min_frequency: Optional[float] = None, max_frequency: Optional[float] = None, signature_validity: Optional[StrictStr] = None, include_disabled: Optional[StrictStr] = None, **kwargs)

List samples

Retrieve all raw data by category.

  • Parameters

    • project_id (int) – Project ID (required)

    • category (str) – Which of the three acquisition categories to retrieve data from (required)

    • limit (int) – Maximum number of results

    • offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

    • exclude_sensors (bool) – Whether to exclude sensors in the response (as these can slow down requests when you have large pages).

    • labels (str) – Only include samples with a label within the given list of labels, given as a JSON string

    • filename (str) – Only include samples whose filename includes the given filename

    • max_length (int) – Only include samples shorter than the given length, in milliseconds

    • min_length (int) – Only include samples longer than the given length, in milliseconds

    • min_frequency (float) – Only include samples with higher frequency than given frequency, in hertz

    • max_frequency (float) – Only include samples with lower frequency than given frequency, in hertz

    • signature_validity (str) – Include samples with either valid or invalid signatures

    • include_disabled (str) – Include only enabled or disabled samples (or both)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

run_dsp_sample_slice_read_only(project_id: StrictInt, dsp_id: StrictInt, sample_id: StrictInt, slice_start: StrictInt, slice_end: StrictInt, **kwargs)

Get processed sample (slice)

Get slice of sample data, and run it through the DSP block. This only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out.

  • Parameters

    • project_id (int) – Project ID (required)

    • dsp_id (int) – DSP Block ID, use the impulse functions to retrieve the ID (required)

    • sample_id (int) – Sample ID (required)

    • slice_start (int) – Begin index of the slice (required)

    • slice_end (int) – End index of the slice (required)

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

test_pretrained_model(project_id: StrictInt, test_pretrained_model_request: Optional[TestPretrainedModelRequest] = None, **kwargs)

Test pretrained model

Test out a pretrained model (using raw features) - upload first via uploadPretrainedModel. If you want to deploy a pretrained model from the API, see startDeployPretrainedModelJob.

  • Parameters

    • project_id (int) – Project ID (required)

    • test_pretrained_model_request (TestPretrainedModelRequest) –

    • async_req (bool*, *optional) – Whether to execute the request asynchronously.

    • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

    • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • Returns

    Returns the result object. If the method is called asynchronously, returns the request thread.

Last updated

Was this helpful?