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