api module

EdgeImpulseApi

class edgeimpulse.experimental.api.EdgeImpulseApi(
		host: Optional[str] = None,
		key: Optional[str] = None,
		key_type: str = 'api'
)

Initialize the Edge Impulse Api.

Parameters

• host: Optional[str] = None

• key: Optional[str] = None

• key_type: str = 'api'

Instance variables

• classify: edgeimpulse_api.api.classify_api.ClassifyApi Classify samples in your project.

• client: edgeimpulse_api.api_client.ApiClient The client used for initializing the apis, use set_client to update the client.

• deployment: edgeimpulse_api.api.deployment_api.DeploymentApi Work with your model deployment targets.

• devices: edgeimpulse_api.api.devices_api.DevicesApi Work with devices in your project.

• dsp: edgeimpulse_api.api.dsp_api.DSPApi Work with (DSP) digital signal processing and feature extraction blocks in your project.

• export: edgeimpulse_api.api.export_api.ExportApi Export your project.

• feature_flags: edgeimpulse_api.api.feature_flags_api.FeatureFlagsApi Enable and disable feature flags.

• host: Optional[str] Edge Impulse studio host (defaults to production).

• impulse: edgeimpulse_api.api.impulse_api.ImpulseApi Work and manage your Impulse (on-device feature extraction and classification pipeline).

• jobs: edgeimpulse_api.api.jobs_api.JobsApi Start and manage long running jobs.

• learn: edgeimpulse_api.api.learn_api.LearnApi Work with keras and pretrained models.

• login: edgeimpulse_api.api.login_api.LoginApi Login and authenticate.

• optimization: edgeimpulse_api.api.optimization_api.OptimizationApi Optimize and find a better model with the EON tuner.

• organization_blocks: edgeimpulse_api.api.organization_blocks_api.OrganizationBlocksApi Work with organization blocks.

• organization_create_project: edgeimpulse_api.api.organization_create_project_api.OrganizationCreateProjectApi Automate project creation for organizations.

• organization_data: edgeimpulse_api.api.organization_data_api.OrganizationDataApi Work with organization data.

• organization_data_campaigns: edgeimpulse_api.api.organization_data_campaigns_api.OrganizationDataCampaignsApi Work with organization data campaigns.

• organization_jobs: edgeimpulse_api.api.organization_jobs_api.OrganizationJobsApi Start and manage organization jobs.

• organization_pipelines: edgeimpulse_api.api.organization_pipelines_api.OrganizationPipelinesApi Work with organization pipelines.

• organization_portals: edgeimpulse_api.api.organization_portals_api.OrganizationPortalsApi Create and manage organization portals.

• organizations: edgeimpulse_api.api.organizations_api.OrganizationsApi Work with your organizations.

• performance_calibration: edgeimpulse_api.api.performance_calibration_api.PerformanceCalibrationApi Calibrate your model performance with real world data.

• projects: edgeimpulse_api.api.projects_api.ProjectsApi Create and manage your projects.

• raw_data: edgeimpulse_api.api.raw_data_api.RawDataApi Work with your project data.

• upload_portal: edgeimpulse_api.api.upload_portal_api.UploadPortalApi Create and manage data upload portals.

• user: edgeimpulse_api.api.user_api.UserApi Manage user activation, creation and updates.

Methods

authenticate

edgeimpulse.experimental.api.authenticate(
		self,
		key: str,
		key_type: str = 'api',
		host: Optional[str] = None
) ‑> None

Authenticate against Edge Impulse.

Parameters

• self

• key: str

• key_type: str = 'api'

• host: Optional[str] = None

Return

None

default_project_id

edgeimpulse.experimental.api.default_project_id(
		self
) ‑> int

Get the default project ID from the provided API key.

Returns: int: The project associated with the api key.

Parameters

• self

Return

int

run_organization_job_until_completion

edgeimpulse.experimental.api.run_organization_job_until_completion(
		self,
		organization_id: int,
		job_id: int,
		data_cb=None,
		client=None,
		timeout_sec: Optional[int] = None
) ‑> None

Runs an organization job until completion.

Parameters

• self

• organization_id: int

• job_id: int

• data_cb=None

• client=None

• timeout_sec: Optional[int] = None

Return

None

run_project_job_until_completion

edgeimpulse.experimental.api.run_project_job_until_completion(
		self,
		job_id: int,
		data_cb=None,
		client=None,
		project_id: Optional[int] = None,
		timeout_sec: Optional[int] = None
) ‑> None

Runs a project job until completion.

Parameters

• self

• job_id: int

• data_cb=None

• client=None

• project_id: Optional[int] = None

• timeout_sec: Optional[int] = None

Return

None

set_client

edgeimpulse.experimental.api.set_client(
		self,
		client: edgeimpulse_api.api_client.ApiClient
) ‑> None

Set the API client and initialize the APIs wit that client.

Parameters

• self

• client: edgeimpulse_api.api_client.ApiClient

Return

None