jobs_api

class edgeimpulse_api.api.jobs_api.JobsApi(
		api_client=None
)

edgeimpulse_api.api.jobs_api.autotune_dsp_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		autotune_dsp_request: edgeimpulse_api.models.autotune_dsp_request.AutotuneDspRequest,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.build_on_device_model_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		type: Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='The name of the built target. You can find this by listing all deployment targets through `listDeploymentTargetsForProject` (via `GET /v1/api/{projectId}/deployment/targets`) and see the `format` type.', extra={})],
		build_on_device_model_request: edgeimpulse_api.models.build_on_device_model_request.BuildOnDeviceModelRequest,
		impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.build_organization_on_device_model_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		build_organization_on_device_model_request: edgeimpulse_api.models.build_organization_on_device_model_request.BuildOrganizationOnDeviceModelRequest,
		impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.calculate_data_quality_metrics(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		calculate_data_quality_metrics_request: edgeimpulse_api.models.calculate_data_quality_metrics_request.CalculateDataQualityMetricsRequest,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.cancel_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		job_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})],
		force_cancel: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description="If set to 'true', we won't wait for the job cluster to cancel the job, and will mark the job as finished.", extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse

edgeimpulse_api.api.jobs_api.create_ai_actions_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		action_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='AI Action ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.create_preview_ai_actions_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		action_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='AI Action ID', extra={})],
		create_preview_ai_actions_job_request: edgeimpulse_api.models.create_preview_ai_actions_job_request.CreatePreviewAIActionsJobRequest,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.create_synthetic_data_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		create_synthetic_data_request: edgeimpulse_api.models.create_synthetic_data_request.CreateSyntheticDataRequest,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.download_jobs_logs(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		job_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})],
		limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		log_level: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Log level (error, warn, info, debug)', extra={})] = None,
		**kwargs
) ‑> str

edgeimpulse_api.api.jobs_api.export_keras_block(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		learn_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.export_keras_block_data(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		learn_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})],
		export_keras_block_data_request: edgeimpulse_api.models.export_keras_block_data_request.ExportKerasBlockDataRequest,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.generate_data_explorer_features(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.generate_features_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		generate_features_request: edgeimpulse_api.models.generate_features_request.GenerateFeaturesRequest,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.get_impulse_migration_job_status(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_job_response.GetJobResponse

edgeimpulse_api.api.jobs_api.get_impulse_migration_jobs_logs(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		log_level: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Log level (error, warn, info, debug)', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.log_stdout_response.LogStdoutResponse

edgeimpulse_api.api.jobs_api.get_job_status(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		job_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.get_job_response.GetJobResponse

edgeimpulse_api.api.jobs_api.get_jobs_logs(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		job_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})],
		limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		log_level: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Log level (error, warn, info, debug)', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.log_stdout_response.LogStdoutResponse

edgeimpulse_api.api.jobs_api.get_jobs_summary(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		start_date: Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='Start date', extra={})],
		end_date: Annotated[datetime.datetime, FieldInfo(default=Ellipsis, description='End date', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.job_summary_response.JobSummaryResponse

edgeimpulse_api.api.jobs_api.get_profile_tflite_job_result(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		job_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.profile_tf_lite_response.ProfileTfLiteResponse

edgeimpulse_api.api.jobs_api.get_profile_tflite_job_result_via_post_request(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		job_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.profile_tf_lite_response.ProfileTfLiteResponse

edgeimpulse_api.api.jobs_api.list_active_jobs(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		root_only: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to exclude jobs with a parent ID (so jobs started as part of another job)', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.list_jobs_response.ListJobsResponse

edgeimpulse_api.api.jobs_api.list_all_jobs(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		start_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description='Start date', extra={})] = None,
		end_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description='End date', extra={})] = None,
		limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None,
		root_only: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to exclude jobs with a parent ID (so jobs started as part of another job)', extra={})] = None,
		key: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Job key to filter on', extra={})] = None,
		category: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description='Job category to filter on', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.list_jobs_response.ListJobsResponse

edgeimpulse_api.api.jobs_api.list_finished_jobs(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		start_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description='Start date', extra={})] = None,
		end_date: Annotated[datetime.datetime | None, FieldInfo(default=PydanticUndefined, description='End date', extra={})] = None,
		limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
		offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None,
		root_only: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='Whether to exclude jobs with a parent ID (so jobs started as part of another job)', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.list_jobs_response.ListJobsResponse

edgeimpulse_api.api.jobs_api.optimize_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		extended_from_job_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Tuner coordinator job ID for the direct descendant job to extend this search from', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.retry_impulse_migration(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.set_tuner_primary_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		trial_id: Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='trial ID', extra={})],
		set_tuner_primary_job_request: edgeimpulse_api.models.set_tuner_primary_job_request.SetTunerPrimaryJobRequest | None = None,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.start_classify_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		start_classify_job_request: edgeimpulse_api.models.start_classify_job_request.StartClassifyJobRequest,
		impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.start_deploy_pretrained_model_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		deploy_pretrained_model_request: edgeimpulse_api.models.deploy_pretrained_model_request.DeployPretrainedModelRequest,
		impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.start_evaluate_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.start_import_data_from_project_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		import_data_from_another_project_job_request: edgeimpulse_api.models.import_data_from_another_project_job_request.ImportDataFromAnotherProjectJobRequest,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.start_keywords_noise_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.start_make_version_public_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		version_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Version ID', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.start_original_export_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		export_original_data_request: edgeimpulse_api.models.export_original_data_request.ExportOriginalDataRequest,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.start_performance_calibration_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		start_performance_calibration_request: edgeimpulse_api.models.start_performance_calibration_request.StartPerformanceCalibrationRequest,
		impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.start_post_processing_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		start_post_processing_request: edgeimpulse_api.models.start_post_processing_request.StartPostProcessingRequest,
		impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.start_profile_tflite_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		profile_tf_lite_request: edgeimpulse_api.models.profile_tf_lite_request.ProfileTfLiteRequest,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

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

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

edgeimpulse_api.api.jobs_api.start_retrain_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		impulse_id: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Impulse ID. If this is unset then the default impulse is used.', extra={})] = None,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.start_version_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		project_version_request: edgeimpulse_api.models.project_version_request.ProjectVersionRequest,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.start_wav_export_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		export_wav_data_request: edgeimpulse_api.models.export_wav_data_request.ExportWavDataRequest,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.train_anomaly_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		learn_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})],
		start_training_request_anomaly: edgeimpulse_api.models.start_training_request_anomaly.StartTrainingRequestAnomaly,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.train_keras_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		learn_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Learn Block ID, use the impulse functions to retrieve the ID', extra={})],
		set_keras_parameter_request: edgeimpulse_api.models.set_keras_parameter_request.SetKerasParameterRequest,
		**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse

edgeimpulse_api.api.jobs_api.update_job(
		self,
		project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Project ID', extra={})],
		job_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Job ID', extra={})],
		update_job_request: edgeimpulse_api.models.update_job_request.UpdateJobRequest,
		**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse