organization_blocks_api

edgeimpulse_api v1.0.0

edgeimpulse_api.api.organization_blocks_api module

class edgeimpulse_api.api.organization_blocks_api.OrganizationBlocksApi(api_client=None)

Bases: object

add_organization_deploy_block(organization_id: StrictInt, name: StrictStr, docker_container: StrictStr, description: StrictStr, cli_arguments: StrictStr, requests_cpu: Optional[float] = None, requests_memory: Optional[StrictInt] = None, limits_cpu: Optional[float] = None, limits_memory: Optional[StrictInt] = None, photo: Optional[StrictStr] = None, integrate_url: Optional[StrictStr] = None, privileged: Optional[StrictBool] = None, mount_learn_block: Optional[StrictBool] = None, supports_eon_compiler: Optional[StrictBool] = None, show_optimizations: Optional[StrictBool] = None, category: Optional[StrictStr] = None, **kwargs)

Add deploy block

Adds a deploy block.

• Parameters

  • organization_id (int) – Organization ID (required)

  • name (str) – (required)

  • docker_container (str) – (required)

  • description (str) – (required)

  • cli_arguments (str) – (required)

  • requests_cpu (float) –

  • requests_memory (int) –

  • limits_cpu (float) –

  • limits_memory (int) –

  • photo (str) –

  • integrate_url (str) –

  • privileged (bool) –

  • mount_learn_block (bool) –

  • supports_eon_compiler (bool) –

  • show_optimizations (bool) –

  • category (str) –

  • 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

  AddOrganizationDeployBlockResponse

add_organization_dsp_block(organization_id: StrictInt, add_organization_dsp_block_request: AddOrganizationDspBlockRequest, **kwargs)

Add dsp block

Adds a dsp block.

• Parameters

  • organization_id (int) – Organization ID (required)

  • add_organization_dsp_block_request (AddOrganizationDspBlockRequest) – (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

  AddOrganizationDspBlockResponse

add_organization_secret(organization_id: StrictInt, add_organization_secret_request: AddOrganizationSecretRequest, **kwargs)

Add secret

Adds a secret.

• Parameters

  • organization_id (int) – Organization ID (required)

  • add_organization_secret_request (AddOrganizationSecretRequest) – (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

  AddOrganizationSecretResponse

add_organization_transfer_learning_block(organization_id: StrictInt, add_organization_transfer_learning_block_request: AddOrganizationTransferLearningBlockRequest, **kwargs)

Add transfer learning block

Adds a transfer learning block.

• Parameters

  • organization_id (int) – Organization ID (required)

  • add_organization_transfer_learning_block_request (AddOrganizationTransferLearningBlockRequest) – (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

  AddOrganizationTransferLearningBlockResponse

add_organization_transformation_block(organization_id: StrictInt, add_organization_transformation_block_request: AddOrganizationTransformationBlockRequest, **kwargs)

Add transformation block

Adds a transformation block.

• Parameters

  • organization_id (int) – Organization ID (required)

  • add_organization_transformation_block_request (AddOrganizationTransformationBlockRequest) – (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

  AddOrganizationTransformationBlockResponse

delete_organization_deploy_block(organization_id: StrictInt, deploy_id: StrictInt, **kwargs)

Delete deploy block

Deletes a deploy block.

• Parameters

  • organization_id (int) – Organization ID (required)

  • deploy_id (int) – Deploy 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

  GenericApiResponse

delete_organization_dsp_block(organization_id: StrictInt, dsp_id: StrictInt, **kwargs)

Delete dsp block

Deletes a dsp block.

• Parameters

  • organization_id (int) – Organization 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.

• Return type

  GenericApiResponse

delete_organization_secret(organization_id: StrictInt, secret_id: StrictInt, **kwargs)

Delete transfer learning block

Deletes a transfer learning block.

• Parameters

  • organization_id (int) – Organization ID (required)

  • secret_id (int) – Secret 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

delete_organization_transfer_learning_block(organization_id: StrictInt, transfer_learning_id: StrictInt, **kwargs)

Delete transfer learning block

Deletes a transfer learning block.

• Parameters

  • organization_id (int) – Organization ID (required)

  • transfer_learning_id (int) – Transfer learning 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

delete_organization_transformation_block(organization_id: StrictInt, transformation_id: StrictInt, **kwargs)

Delete transformation block

Deletes a transformation block.

• Parameters

  • organization_id (int) – Organization ID (required)

  • transformation_id (int) – Transformation 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

  GenericApiResponse

list_organization_deploy_blocks(organization_id: StrictInt, **kwargs)

Get deploy blocks

Retrieve all deploy blocks.

• Parameters

  • organization_id (int) – Organization 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

  ListOrganizationDeployBlocksResponse

list_organization_dsp_blocks(organization_id: StrictInt, **kwargs)

Get dsp blocks

Retrieve all dsp blocks.

• Parameters

  • organization_id (int) – Organization 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

  ListOrganizationDspBlocksResponse

list_organization_secrets(organization_id: StrictInt, **kwargs)

Get secrets

Retrieve all secrets.

• Parameters

  • organization_id (int) – Organization 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

  ListOrganizationSecretsResponse

list_organization_transfer_learning_blocks(organization_id: StrictInt, **kwargs)

Get transfer learning blocks

Retrieve all transfer learning blocks.

• Parameters

  • organization_id (int) – Organization 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

  ListOrganizationTransferLearningBlocksResponse

list_organization_transformation_blocks(organization_id: StrictInt, **kwargs)

Get transformation blocks

Retrieve all transformation blocks.

• Parameters

  • organization_id (int) – Organization 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

  ListOrganizationTransformationBlocksResponse

retry_organization_dsp_block(organization_id: StrictInt, dsp_id: StrictInt, **kwargs)

Retry connection to dsp block

Retry launch a dsp block.

• Parameters

  • organization_id (int) – Organization 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.

• Return type

  GenericApiResponse

update_organization_deploy_block(organization_id: StrictInt, deploy_id: StrictInt, name: Optional[StrictStr] = None, docker_container: Optional[StrictStr] = None, description: Optional[StrictStr] = None, cli_arguments: Optional[StrictStr] = None, requests_cpu: Optional[float] = None, requests_memory: Optional[StrictInt] = None, limits_cpu: Optional[float] = None, limits_memory: Optional[StrictInt] = None, photo: Optional[StrictStr] = None, integrate_url: Optional[StrictStr] = None, privileged: Optional[StrictBool] = None, mount_learn_block: Optional[StrictBool] = None, supports_eon_compiler: Optional[StrictBool] = None, show_optimizations: Optional[StrictBool] = None, category: Optional[StrictStr] = None, **kwargs)

Update deploy block

Updates a deploy block. Only values in the body will be updated.

• Parameters

  • organization_id (int) – Organization ID (required)

  • deploy_id (int) – Deploy block ID. (required)

  • name (str) –

  • docker_container (str) –

  • description (str) –

  • cli_arguments (str) –

  • requests_cpu (float) –

  • requests_memory (int) –

  • limits_cpu (float) –

  • limits_memory (int) –

  • photo (str) –

  • integrate_url (str) –

  • privileged (bool) –

  • mount_learn_block (bool) –

  • supports_eon_compiler (bool) –

  • show_optimizations (bool) –

  • category (str) –

  • 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

update_organization_dsp_block(organization_id: StrictInt, dsp_id: StrictInt, update_organization_dsp_block_request: UpdateOrganizationDspBlockRequest, **kwargs)

Update dsp block

Updates a dsp block. Only values in the body will be updated.

• Parameters

  • organization_id (int) – Organization ID (required)

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

  • update_organization_dsp_block_request (UpdateOrganizationDspBlockRequest) – (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

update_organization_transfer_learning_block(organization_id: StrictInt, transfer_learning_id: StrictInt, update_organization_transfer_learning_block_request: UpdateOrganizationTransferLearningBlockRequest, **kwargs)

Update transfer learning block

Updates a transfer learning block. Only values in the body will be updated.

• Parameters

  • organization_id (int) – Organization ID (required)

  • transfer_learning_id (int) – Transfer learning ID (required)

  • update_organization_transfer_learning_block_request (UpdateOrganizationTransferLearningBlockRequest) – (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

update_organization_transformation_block(organization_id: StrictInt, transformation_id: StrictInt, update_organization_transformation_block_request: UpdateOrganizationTransformationBlockRequest, **kwargs)

Update transformation block

Updates a transformation block. Only values in the body will be updated.

• Parameters

  • organization_id (int) – Organization ID (required)

  • transformation_id (int) – Transformation block ID. (required)

  • update_organization_transformation_block_request (UpdateOrganizationTransformationBlockRequest) – (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