impulse_api module

ImpulseApi

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

Parameters

api_client=None

Methods

create_block_version

edgeimpulse_api.api.impulse_api.create_block_version(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		block_type: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Type of block', extra={})],
		block_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Block ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.create_block_version_response.CreateBlockVersionResponse

Create new block version

Create a new version of a given block

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
block_type: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Type of block', extra={})]
block_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Block ID', extra={})]
**kwargs

Return

edgeimpulse_api.models.create_block_version_response.CreateBlockVersionResponse

create_impulse

edgeimpulse_api.api.impulse_api.create_impulse(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		impulse: edgeimpulse_api.models.impulse.Impulse,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Create impulse

Sets the impulse for this project.

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
impulse: edgeimpulse_api.models.impulse.Impulse
**kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

delete_impulse

edgeimpulse_api.api.impulse_api.delete_impulse(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Delete impulse

Completely clears the impulse for this project.

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

get_impulse

edgeimpulse_api.api.impulse_api.get_impulse(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_impulse_response.GetImpulseResponse

Get impulse

Retrieve the impulse for this project

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs

Return

edgeimpulse_api.models.get_impulse_response.GetImpulseResponse

get_impulse_all

edgeimpulse_api.api.impulse_api.get_impulse_all(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_impulse_response.GetImpulseResponse

Get impulse including disabled blocks

Retrieve the impulse for this project including disabled blocks

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs

Return

edgeimpulse_api.models.get_impulse_response.GetImpulseResponse

get_impulse_blocks

edgeimpulse_api.api.impulse_api.get_impulse_blocks(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_impulse_blocks_response.GetImpulseBlocksResponse

Get impulse blocks

Lists all possible blocks that can be used in the impulse

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
**kwargs

Return

edgeimpulse_api.models.get_impulse_blocks_response.GetImpulseBlocksResponse

update_block_version

edgeimpulse_api.api.impulse_api.update_block_version(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		block_type: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Type of block', extra={})],
		block_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Block ID', extra={})],
		impulse_block_version: edgeimpulse_api.models.impulse_block_version.ImpulseBlockVersion,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Update block version details

Update the details of a block version

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
block_type: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Type of block', extra={})]
block_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Block ID', extra={})]
impulse_block_version: edgeimpulse_api.models.impulse_block_version.ImpulseBlockVersion
**kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

verify_dsp_block_url

edgeimpulse_api.api.impulse_api.verify_dsp_block_url(
		self,
		project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		verify_dsp_block_url_request: edgeimpulse_api.models.verify_dsp_block_url_request.VerifyDspBlockUrlRequest,
		**kwargs
) ‑> edgeimpulse_api.models.verify_dsp_block_url_response.VerifyDspBlockUrlResponse

Verify custom DSP block

Verify the validity of a custom DSP block

Parameters

self
project_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})]
verify_dsp_block_url_request: edgeimpulse_api.models.verify_dsp_block_url_request.VerifyDspBlockUrlRequest
**kwargs

Return

edgeimpulse_api.models.verify_dsp_block_url_response.VerifyDspBlockUrlResponse

Previoushealth_api module Nextjobs_api module

Last updated 2 months ago