azure.cognitiveservices.vision.customvision.prediction.models module

exception azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException(deserialize, response, *args)

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘CustomVisionError’.

Parameters

• deserialize – A deserializer

• response – Server response to be deserialized.

class azure.cognitiveservices.vision.customvision.prediction.models.BoundingBox(*, left: float, top: float, width: float, height: float, **kwargs)

Bases: msrest.serialization.Model

Bounding box that defines a region of an image.

All required parameters must be populated in order to send to Azure.

Parameters

• left (float) – Required. Coordinate of the left boundary.

• top (float) – Required. Coordinate of the top boundary.

• width (float) – Required. Width.

• height (float) – Required. Height.

class azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionError(*, code, message: str, **kwargs)

Bases: msrest.serialization.Model

CustomVisionError.

All required parameters must be populated in order to send to Azure.

Parameters

• code (str or CustomVisionErrorCodes) – Required. The error code. Possible values include: ‘NoError’, ‘BadRequest’, ‘BadRequestExceededBatchSize’, ‘BadRequestNotSupported’, ‘BadRequestInvalidIds’, ‘BadRequestProjectName’, ‘BadRequestProjectNameNotUnique’, ‘BadRequestProjectDescription’, ‘BadRequestProjectUnknownDomain’, ‘BadRequestProjectUnknownClassification’, ‘BadRequestProjectUnsupportedDomainTypeChange’, ‘BadRequestProjectUnsupportedExportPlatform’, ‘BadRequestProjectImagePreprocessingSettings’, ‘BadRequestProjectDuplicated’, ‘BadRequestIterationName’, ‘BadRequestIterationNameNotUnique’, ‘BadRequestIterationDescription’, ‘BadRequestIterationIsNotTrained’, ‘BadRequestIterationValidationFailed’, ‘BadRequestWorkspaceCannotBeModified’, ‘BadRequestWorkspaceNotDeletable’, ‘BadRequestTagName’, ‘BadRequestTagNameNotUnique’, ‘BadRequestTagDescription’, ‘BadRequestTagType’, ‘BadRequestMultipleNegativeTag’, ‘BadRequestMultipleGeneralProductTag’, ‘BadRequestImageTags’, ‘BadRequestImageRegions’, ‘BadRequestNegativeAndRegularTagOnSameImage’, ‘BadRequestUnsupportedDomain’, ‘BadRequestRequiredParamIsNull’, ‘BadRequestIterationIsPublished’, ‘BadRequestInvalidPublishName’, ‘BadRequestInvalidPublishTarget’, ‘BadRequestUnpublishFailed’, ‘BadRequestIterationNotPublished’, ‘BadRequestSubscriptionApi’, ‘BadRequestExceedProjectLimit’, ‘BadRequestExceedIterationPerProjectLimit’, ‘BadRequestExceedTagPerProjectLimit’, ‘BadRequestExceedTagPerImageLimit’, ‘BadRequestExceededQuota’, ‘BadRequestCannotMigrateProjectWithName’, ‘BadRequestNotLimitedTrial’, ‘BadRequestImageBatch’, ‘BadRequestImageStream’, ‘BadRequestImageUrl’, ‘BadRequestImageFormat’, ‘BadRequestImageSizeBytes’, ‘BadRequestImageDimensions’, ‘BadRequestImageExceededCount’, ‘BadRequestTrainingNotNeeded’, ‘BadRequestTrainingNotNeededButTrainingPipelineUpdated’, ‘BadRequestTrainingValidationFailed’, ‘BadRequestClassificationTrainingValidationFailed’, ‘BadRequestMultiClassClassificationTrainingValidationFailed’, ‘BadRequestMultiLabelClassificationTrainingValidationFailed’, ‘BadRequestDetectionTrainingValidationFailed’, ‘BadRequestTrainingAlreadyInProgress’, ‘BadRequestDetectionTrainingNotAllowNegativeTag’, ‘BadRequestInvalidEmailAddress’, ‘BadRequestDomainNotSupportedForAdvancedTraining’, ‘BadRequestExportPlatformNotSupportedForAdvancedTraining’, ‘BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining’, ‘BadRequestExportValidationFailed’, ‘BadRequestExportAlreadyInProgress’, ‘BadRequestPredictionIdsMissing’, ‘BadRequestPredictionIdsExceededCount’, ‘BadRequestPredictionTagsExceededCount’, ‘BadRequestPredictionResultsExceededCount’, ‘BadRequestPredictionInvalidApplicationName’, ‘BadRequestPredictionInvalidQueryParameters’, ‘BadRequestInvalidImportToken’, ‘BadRequestExportWhileTraining’, ‘BadRequestImageMetadataKey’, ‘BadRequestImageMetadataValue’, ‘BadRequestOperationNotSupported’, ‘BadRequestInvalidArtifactUri’, ‘BadRequestCustomerManagedKeyRevoked’, ‘BadRequestInvalid’, ‘UnsupportedMediaType’, ‘Forbidden’, ‘ForbiddenUser’, ‘ForbiddenUserResource’, ‘ForbiddenUserSignupDisabled’, ‘ForbiddenUserSignupAllowanceExceeded’, ‘ForbiddenUserDoesNotExist’, ‘ForbiddenUserDisabled’, ‘ForbiddenUserInsufficientCapability’, ‘ForbiddenDRModeEnabled’, ‘ForbiddenInvalid’, ‘NotFound’, ‘NotFoundProject’, ‘NotFoundProjectDefaultIteration’, ‘NotFoundIteration’, ‘NotFoundIterationPerformance’, ‘NotFoundTag’, ‘NotFoundImage’, ‘NotFoundDomain’, ‘NotFoundApimSubscription’, ‘NotFoundInvalid’, ‘Conflict’, ‘ConflictInvalid’, ‘ErrorUnknown’, ‘ErrorIterationCopyFailed’, ‘ErrorPreparePerformanceMigrationFailed’, ‘ErrorProjectInvalidWorkspace’, ‘ErrorProjectInvalidPipelineConfiguration’, ‘ErrorProjectInvalidDomain’, ‘ErrorProjectTrainingRequestFailed’, ‘ErrorProjectImportRequestFailed’, ‘ErrorProjectExportRequestFailed’, ‘ErrorFeaturizationServiceUnavailable’, ‘ErrorFeaturizationQueueTimeout’, ‘ErrorFeaturizationInvalidFeaturizer’, ‘ErrorFeaturizationAugmentationUnavailable’, ‘ErrorFeaturizationUnrecognizedJob’, ‘ErrorFeaturizationAugmentationError’, ‘ErrorExporterInvalidPlatform’, ‘ErrorExporterInvalidFeaturizer’, ‘ErrorExporterInvalidClassifier’, ‘ErrorPredictionServiceUnavailable’, ‘ErrorPredictionModelNotFound’, ‘ErrorPredictionModelNotCached’, ‘ErrorPrediction’, ‘ErrorPredictionStorage’, ‘ErrorRegionProposal’, ‘ErrorUnknownBaseModel’, ‘ErrorInvalid’

• message (str) – Required. A message explaining the error reported by the service.

class azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes(value)

Bases: str, enum.Enum

An enumeration.

bad_request = 'BadRequest'

bad_request_cannot_migrate_project_with_name = 'BadRequestCannotMigrateProjectWithName'

bad_request_classification_training_validation_failed = 'BadRequestClassificationTrainingValidationFailed'

bad_request_customer_managed_key_revoked = 'BadRequestCustomerManagedKeyRevoked'

bad_request_detection_training_not_allow_negative_tag = 'BadRequestDetectionTrainingNotAllowNegativeTag'

bad_request_detection_training_validation_failed = 'BadRequestDetectionTrainingValidationFailed'

bad_request_domain_not_supported_for_advanced_training = 'BadRequestDomainNotSupportedForAdvancedTraining'

bad_request_exceed_iteration_per_project_limit = 'BadRequestExceedIterationPerProjectLimit'

bad_request_exceed_project_limit = 'BadRequestExceedProjectLimit'

bad_request_exceed_tag_per_image_limit = 'BadRequestExceedTagPerImageLimit'

bad_request_exceed_tag_per_project_limit = 'BadRequestExceedTagPerProjectLimit'

bad_request_exceeded_batch_size = 'BadRequestExceededBatchSize'

bad_request_exceeded_quota = 'BadRequestExceededQuota'

bad_request_export_already_in_progress = 'BadRequestExportAlreadyInProgress'

bad_request_export_platform_not_supported_for_advanced_training = 'BadRequestExportPlatformNotSupportedForAdvancedTraining'

bad_request_export_validation_failed = 'BadRequestExportValidationFailed'

bad_request_export_while_training = 'BadRequestExportWhileTraining'

bad_request_image_batch = 'BadRequestImageBatch'

bad_request_image_dimensions = 'BadRequestImageDimensions'

bad_request_image_exceeded_count = 'BadRequestImageExceededCount'

bad_request_image_format = 'BadRequestImageFormat'

bad_request_image_metadata_key = 'BadRequestImageMetadataKey'

bad_request_image_metadata_value = 'BadRequestImageMetadataValue'

bad_request_image_regions = 'BadRequestImageRegions'

bad_request_image_size_bytes = 'BadRequestImageSizeBytes'

bad_request_image_stream = 'BadRequestImageStream'

bad_request_image_tags = 'BadRequestImageTags'

bad_request_image_url = 'BadRequestImageUrl'

bad_request_invalid = 'BadRequestInvalid'

bad_request_invalid_artifact_uri = 'BadRequestInvalidArtifactUri'

bad_request_invalid_email_address = 'BadRequestInvalidEmailAddress'

bad_request_invalid_ids = 'BadRequestInvalidIds'

bad_request_invalid_import_token = 'BadRequestInvalidImportToken'

bad_request_invalid_publish_name = 'BadRequestInvalidPublishName'

bad_request_invalid_publish_target = 'BadRequestInvalidPublishTarget'

bad_request_iteration_description = 'BadRequestIterationDescription'

bad_request_iteration_is_not_trained = 'BadRequestIterationIsNotTrained'

bad_request_iteration_is_published = 'BadRequestIterationIsPublished'

bad_request_iteration_name = 'BadRequestIterationName'

bad_request_iteration_name_not_unique = 'BadRequestIterationNameNotUnique'

bad_request_iteration_not_published = 'BadRequestIterationNotPublished'

bad_request_iteration_validation_failed = 'BadRequestIterationValidationFailed'

bad_request_multi_class_classification_training_validation_failed = 'BadRequestMultiClassClassificationTrainingValidationFailed'

bad_request_multi_label_classification_training_validation_failed = 'BadRequestMultiLabelClassificationTrainingValidationFailed'

bad_request_multiple_general_product_tag = 'BadRequestMultipleGeneralProductTag'

bad_request_multiple_negative_tag = 'BadRequestMultipleNegativeTag'

bad_request_negative_and_regular_tag_on_same_image = 'BadRequestNegativeAndRegularTagOnSameImage'

bad_request_not_limited_trial = 'BadRequestNotLimitedTrial'

bad_request_not_supported = 'BadRequestNotSupported'

bad_request_operation_not_supported = 'BadRequestOperationNotSupported'

bad_request_prediction_ids_exceeded_count = 'BadRequestPredictionIdsExceededCount'

bad_request_prediction_ids_missing = 'BadRequestPredictionIdsMissing'

bad_request_prediction_invalid_application_name = 'BadRequestPredictionInvalidApplicationName'

bad_request_prediction_invalid_query_parameters = 'BadRequestPredictionInvalidQueryParameters'

bad_request_prediction_results_exceeded_count = 'BadRequestPredictionResultsExceededCount'

bad_request_prediction_tags_exceeded_count = 'BadRequestPredictionTagsExceededCount'

bad_request_project_description = 'BadRequestProjectDescription'

bad_request_project_duplicated = 'BadRequestProjectDuplicated'

bad_request_project_image_preprocessing_settings = 'BadRequestProjectImagePreprocessingSettings'

bad_request_project_name = 'BadRequestProjectName'

bad_request_project_name_not_unique = 'BadRequestProjectNameNotUnique'

bad_request_project_unknown_classification = 'BadRequestProjectUnknownClassification'

bad_request_project_unknown_domain = 'BadRequestProjectUnknownDomain'

bad_request_project_unsupported_domain_type_change = 'BadRequestProjectUnsupportedDomainTypeChange'

bad_request_project_unsupported_export_platform = 'BadRequestProjectUnsupportedExportPlatform'

bad_request_required_param_is_null = 'BadRequestRequiredParamIsNull'

bad_request_reserved_budget_in_hours_not_enough_for_advanced_training = 'BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining'

bad_request_subscription_api = 'BadRequestSubscriptionApi'

bad_request_tag_description = 'BadRequestTagDescription'

bad_request_tag_name = 'BadRequestTagName'

bad_request_tag_name_not_unique = 'BadRequestTagNameNotUnique'

bad_request_tag_type = 'BadRequestTagType'

bad_request_training_already_in_progress = 'BadRequestTrainingAlreadyInProgress'

bad_request_training_not_needed = 'BadRequestTrainingNotNeeded'

bad_request_training_not_needed_but_training_pipeline_updated = 'BadRequestTrainingNotNeededButTrainingPipelineUpdated'

bad_request_training_validation_failed = 'BadRequestTrainingValidationFailed'

bad_request_unpublish_failed = 'BadRequestUnpublishFailed'

bad_request_unsupported_domain = 'BadRequestUnsupportedDomain'

bad_request_workspace_cannot_be_modified = 'BadRequestWorkspaceCannotBeModified'

bad_request_workspace_not_deletable = 'BadRequestWorkspaceNotDeletable'

conflict = 'Conflict'

conflict_invalid = 'ConflictInvalid'

error_exporter_invalid_classifier = 'ErrorExporterInvalidClassifier'

error_exporter_invalid_featurizer = 'ErrorExporterInvalidFeaturizer'

error_exporter_invalid_platform = 'ErrorExporterInvalidPlatform'

error_featurization_augmentation_error = 'ErrorFeaturizationAugmentationError'

error_featurization_augmentation_unavailable = 'ErrorFeaturizationAugmentationUnavailable'

error_featurization_invalid_featurizer = 'ErrorFeaturizationInvalidFeaturizer'

error_featurization_queue_timeout = 'ErrorFeaturizationQueueTimeout'

error_featurization_service_unavailable = 'ErrorFeaturizationServiceUnavailable'

error_featurization_unrecognized_job = 'ErrorFeaturizationUnrecognizedJob'

error_invalid = 'ErrorInvalid'

error_iteration_copy_failed = 'ErrorIterationCopyFailed'

error_prediction = 'ErrorPrediction'

error_prediction_model_not_cached = 'ErrorPredictionModelNotCached'

error_prediction_model_not_found = 'ErrorPredictionModelNotFound'

error_prediction_service_unavailable = 'ErrorPredictionServiceUnavailable'

error_prediction_storage = 'ErrorPredictionStorage'

error_prepare_performance_migration_failed = 'ErrorPreparePerformanceMigrationFailed'

error_project_export_request_failed = 'ErrorProjectExportRequestFailed'

error_project_import_request_failed = 'ErrorProjectImportRequestFailed'

error_project_invalid_domain = 'ErrorProjectInvalidDomain'

error_project_invalid_pipeline_configuration = 'ErrorProjectInvalidPipelineConfiguration'

error_project_invalid_workspace = 'ErrorProjectInvalidWorkspace'

error_project_training_request_failed = 'ErrorProjectTrainingRequestFailed'

error_region_proposal = 'ErrorRegionProposal'

error_unknown = 'ErrorUnknown'

error_unknown_base_model = 'ErrorUnknownBaseModel'

forbidden = 'Forbidden'

forbidden_dr_mode_enabled = 'ForbiddenDRModeEnabled'

forbidden_invalid = 'ForbiddenInvalid'

forbidden_user = 'ForbiddenUser'

forbidden_user_disabled = 'ForbiddenUserDisabled'

forbidden_user_does_not_exist = 'ForbiddenUserDoesNotExist'

forbidden_user_insufficient_capability = 'ForbiddenUserInsufficientCapability'

forbidden_user_resource = 'ForbiddenUserResource'

forbidden_user_signup_allowance_exceeded = 'ForbiddenUserSignupAllowanceExceeded'

forbidden_user_signup_disabled = 'ForbiddenUserSignupDisabled'

no_error = 'NoError'

not_found = 'NotFound'

not_found_apim_subscription = 'NotFoundApimSubscription'

not_found_domain = 'NotFoundDomain'

not_found_image = 'NotFoundImage'

not_found_invalid = 'NotFoundInvalid'

not_found_iteration = 'NotFoundIteration'

not_found_iteration_performance = 'NotFoundIterationPerformance'

not_found_project = 'NotFoundProject'

not_found_project_default_iteration = 'NotFoundProjectDefaultIteration'

not_found_tag = 'NotFoundTag'

unsupported_media_type = 'UnsupportedMediaType'

class azure.cognitiveservices.vision.customvision.prediction.models.ImagePrediction(**kwargs)

Bases: msrest.serialization.Model

Result of an image prediction request.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• id (str) – Prediction Id.

• project (str) – Project Id.

• iteration (str) – Iteration Id.

• created (datetime) – Date this prediction was created.

• predictions (list[Prediction]) – List of predictions.

class azure.cognitiveservices.vision.customvision.prediction.models.ImageUrl(*, url: str, **kwargs)

Bases: msrest.serialization.Model

Image url.

All required parameters must be populated in order to send to Azure.

Parameters

url (str) – Required. Url of the image.

class azure.cognitiveservices.vision.customvision.prediction.models.Prediction(**kwargs)

Bases: msrest.serialization.Model

Prediction result.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

• probability (float) – Probability of the tag.

• tag_id (str) – Id of the predicted tag.

• tag_name (str) – Name of the predicted tag.

• bounding_box (BoundingBox) – Bounding box of the prediction.

• tag_type (str or TagType) – Type of the predicted tag. Possible values include: ‘Regular’, ‘Negative’, ‘GeneralProduct’

class azure.cognitiveservices.vision.customvision.prediction.models.TagType(value)

Bases: str, enum.Enum

An enumeration.

general_product = 'GeneralProduct'

negative = 'Negative'

regular = 'Regular'