impulse_api

edgeimpulse_api v1.0.0

edgeimpulse_api.api.impulse_api module

class edgeimpulse_api.api.impulse_api.ImpulseApi(api_client=None)

Bases: object

create_block_version(project_id: StrictInt, block_type: StrictStr, block_id: StrictInt, **kwargs)

Create new block version

Create a new version of a given block

• Parameters

  • project_id (int) – Project ID (required)

  • block_type (str) – Type of block (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

  CreateBlockVersionResponse

create_impulse(project_id: StrictInt, impulse: Impulse, **kwargs)

Create impulse

Sets the impulse for this project.

• Parameters

  • project_id (int) – Project ID (required)

  • impulse (Impulse) – (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

  GenericApiResponse

delete_impulse(project_id: StrictInt, **kwargs)

Delete impulse

Completely clears the impulse for this 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

  GenericApiResponse

get_impulse(project_id: StrictInt, **kwargs)

Get impulse

Retrieve the impulse for this 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

  GetImpulseResponse

get_impulse_all(project_id: StrictInt, **kwargs)

Get impulse including disabled blocks

Retrieve the impulse for this project including disabled blocks

• 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

  GetImpulseResponse

get_impulse_blocks(project_id: StrictInt, **kwargs)

Get impulse blocks

Lists all possible blocks that can be used in the impulse

• 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

  GetImpulseBlocksResponse

update_block_version(project_id: StrictInt, block_type: StrictStr, block_id: StrictInt, impulse_block_version: ImpulseBlockVersion, **kwargs)

Update block version details

Update the details of a block version

• Parameters

  • project_id (int) – Project ID (required)

  • block_type (str) – Type of block (required)

  • block_id (int) – Block ID (required)

  • impulse_block_version (ImpulseBlockVersion) – (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

  GenericApiResponse

verify_dsp_block_url(project_id: StrictInt, verify_dsp_block_url_request: VerifyDspBlockUrlRequest, **kwargs)

Verify custom DSP block

Verify the validity of a custom DSP block

• Parameters

  • project_id (int) – Project ID (required)

  • verify_dsp_block_url_request (VerifyDspBlockUrlRequest) – (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

  VerifyDspBlockUrlResponse