JobsApi
- api_client=None
Methods
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
build_on_device_model_job
downloadBuild
to download the artefacts. Updates are streamed over the websocket API.
Parameters
- 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
(viaGET /v1/api/{projectId}/deployment/targets
) and see theformat
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
build_organization_on_device_model_job
downloadBuild
to download the artefacts. Updates are streamed over the websocket API.
Parameters
- 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
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
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
create_ai_actions_job
updateAIAction
.
Parameters
- 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
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
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
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
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
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
generate_data_explorer_features
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- **kwargs
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
get_impulse_migration_job_status
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- **kwargs
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
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
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
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
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
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
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
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
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
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
retry_impulse_migration
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- **kwargs
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
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
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
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
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
start_keywords_noise_job
- self
- project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description=‘Project ID’, extra=)]
- **kwargs
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
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
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
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
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
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
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
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
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
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
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
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
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