Share via

Projects - Import

Service:
Azure AI Services
API Version:
3.3

Imports a project.

POST {Endpoint}/customvision/v3.3/training/projects/import?token={token}
With optional parameters: 
POST {Endpoint}/customvision/v3.3/training/projects/import?token={token}&name={name}

URI Parameters

Name In Required Type Description
Endpoint
 path True

string

Supported Cognitive Services endpoints.
token
 query True

string

Token generated from the export project call.
name
 query

string

Optional, name of the project to use instead of auto-generated name.

Request Header

Name Required Type Description
Training-Key True

string

Responses

Name Type Description
200 OK

Project

OK

Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes

CustomVisionError

Error response

Media Types: "application/json", "application/xml", "text/xml"

Security

Training-Key

Type: apiKey
In: header

Examples

Successful ImportProject request

Sample request

POST https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects/import?token=token

Sample response

Status code:
200 
{
  "id": "bc3f7dad-5544-468c-8573-3ef04d55463e",
  "name": "Import Project",
  "description": "",
  "settings": {
    "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31"
  },
  "created": "2019-10-06T05:43:18Z",
  "lastModified": "2019-10-06T05:43:18Z",
  "thumbnailUri": "",
  "status": "Importing"
}

Definitions

Name Description
Classifier

Gets the classification type of the project.
CustomVisionError
CustomVisionErrorCodes

The error code.
ImageProcessingSettings

Represents image preprocessing settings used by image augmentation.
Project

Represents a project.
ProjectSettings

Represents settings associated with a project.
ProjectStatus

Gets the status of the project.
TargetExportPlatforms

A list of ExportPlatform that the trained model should be able to support.

Classifier

Enumeration

Gets the classification type of the project.

Value Description
Multiclass
Multilabel

CustomVisionError

Object
Name Type Description
code

CustomVisionErrorCodes

The error code.
message

string

A message explaining the error reported by the service.

CustomVisionErrorCodes

Enumeration

The error code.

Value Description
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

ImageProcessingSettings

Object

Represents image preprocessing settings used by image augmentation.

Name Type Description
augmentationMethods

object

Gets or sets enabled image transforms. The key corresponds to the transform name. If value is set to true, then correspondent transform is enabled. Otherwise this transform will not be used. Augmentation will be uniformly distributed among enabled transforms.

Project

Object

Represents a project.

Name Type Description
created

string (date-time)

Gets the date this project was created.
description

string

Gets or sets the description of the project.
drModeEnabled

boolean

Gets if the Disaster Recovery (DR) mode is on, indicating the project is temporarily read-only.
id

string (uuid)

Gets the project id.
lastModified

string (date-time)

Gets the date this project was last modified.
name

string

Gets or sets the name of the project.
settings

ProjectSettings

Gets or sets the project settings.
status

ProjectStatus

Gets the status of the project.
thumbnailUri

string

Gets the thumbnail url representing the image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.

ProjectSettings

Object

Represents settings associated with a project.

Name Type Description
classificationType

Classifier

Gets or sets the classification type of the project.
detectionParameters

string

Detection parameters in use, if any.
domainId

string (uuid)

Gets or sets the id of the Domain to use with this project.
imageProcessingSettings

ImageProcessingSettings

Gets or sets image preprocessing settings.
targetExportPlatforms

TargetExportPlatforms[]

A list of ExportPlatform that the trained model should be able to support.
useNegativeSet

boolean

Indicates if negative set is being used.

ProjectStatus

Enumeration

Gets the status of the project.

Value Description
Succeeded
Importing
Failed

TargetExportPlatforms

Enumeration

A list of ExportPlatform that the trained model should be able to support.

Value Description
CoreML
TensorFlow
DockerFile
ONNX
VAIDK