classify_api

edgeimpulse_api v1.0.0

edgeimpulse_api.api.classify_api module

class edgeimpulse_api.api.classify_api.ClassifyApi(api_client=None)

Bases: object

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.

• Return type

  ClassifySampleResponse

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.

• Return type

  ClassifySampleResponse

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.

• Return type

  ClassifyJobResponse