Projects - Create

Service:

Cognitive Services - Custom Vision

API Version:

3.3

Создайте проект.

POST {Endpoint}/customvision/v3.3/training/projects?name={name}

With optional parameters:

POST {Endpoint}/customvision/v3.3/training/projects?name={name}&description={description}&domainId={domainId}&classificationType={classificationType}&targetExportPlatforms={targetExportPlatforms}

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services.
name	query	True	string	Имя проекта.
classificationType	query		string	Тип классификатора, создаваемого для этого проекта.
description	query		string	Описание проекта.
domainId	query		string uuid	Идентификатор домена, используемого для этого проекта. По умолчанию — Общие.
targetExportPlatforms	query		string[]	Список платформ, на которые планируется экспортировать обученная модель.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Training-Key	True	string

Ответы

Имя	Тип	Описание
200 OK	Project	ОК Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Сообщение об ошибке Media Types: "application/json", "application/xml", "text/xml"

Безопасность

Training-Key

Type: apiKey
In: header

Примеры

Successful CreateProject request

Sample Request

HTTP

POST https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects?name=My New Project&description=A test project&domainId=ee85a74c-405e-4adc-bb47-ffa8ca0c9f31

Sample Response

Status code:

200

{
  "id": "bc3f7dad-5544-468c-8573-3ef04d55463e",
  "name": "My New Project",
  "description": "A test project",
  "settings": {
    "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31"
  },
  "created": "2017-12-18T05:43:18Z",
  "lastModified": "2017-12-18T05:43:18Z",
  "thumbnailUri": ""
}

Определения

Имя	Описание
Classifier	Возвращает тип классификации проекта.
CustomVisionError
CustomVisionErrorCodes	Код ошибки.
ImageProcessingSettings	Представляет параметры предварительной обработки образа, используемые для расширения образа.
Project	Представляет проект.
ProjectSettings	Представляет параметры, связанные с проектом.
ProjectStatus	Возвращает состояние проекта.
TargetExportPlatforms	Список ExportPlatform, который должна поддерживать обученная модель.

Classifier

Возвращает тип классификации проекта.

Имя	Тип	Описание
Multiclass	string
Multilabel	string

CustomVisionError

Имя	Тип	Описание
code	CustomVisionErrorCodes	Код ошибки.
message	string	Сообщение с объяснением ошибки, о которую сообщила служба.

CustomVisionErrorCodes

Код ошибки.

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

ImageProcessingSettings

Представляет параметры предварительной обработки образа, используемые для расширения образа.

Имя	Тип	Описание
augmentationMethods	object	Возвращает или задает включенные преобразования изображений. Ключ соответствует имени преобразования. Если задано значение true, то включено соответствующее преобразование. В противном случае это преобразование не будет использоваться. Расширение будет равномерно распределено между включенными преобразованиями.

Project

Представляет проект.

Имя	Тип	Описание
created	string	Возвращает дату создания этого проекта.
description	string	Возвращает или задает описание проекта.
drModeEnabled	boolean	Возвращает значение , если режим аварийного восстановления (DR) включен, указывая, что проект временно доступен только для чтения.
id	string	Возвращает идентификатор проекта.
lastModified	string	Возвращает дату последнего изменения этого проекта.
name	string	Возвращает или задает имя проекта.
settings	ProjectSettings	Возвращает или задает параметры проекта.
status	ProjectStatus	Возвращает состояние проекта.
thumbnailUri	string	Возвращает URL-адрес эскиза, представляющий изображение. Если функция виртуальной сети включена, это будет относительный путь для использования с GetArtifact, в противном случае это будет абсолютный URI ресурса.

ProjectSettings

Представляет параметры, связанные с проектом.

Имя	Тип	Описание
classificationType	Classifier	Возвращает или задает тип классификации проекта.
detectionParameters	string	Используемые параметры обнаружения, если таковые есть.
domainId	string	Возвращает или задает идентификатор домена для использования с этим проектом.
imageProcessingSettings	ImageProcessingSettings	Возвращает или задает параметры предварительной обработки изображения.
targetExportPlatforms	TargetExportPlatforms[]	Список ExportPlatform, который должна поддерживать обученная модель.
useNegativeSet	boolean	Указывает, используется ли отрицательный набор.

ProjectStatus

Возвращает состояние проекта.

Имя	Тип	Описание
Failed	string
Importing	string
Succeeded	string

TargetExportPlatforms

Список ExportPlatform, который должна поддерживать обученная модель.

Имя	Тип	Описание
CoreML	string
DockerFile	string
ONNX	string
TensorFlow	string
VAIDK	string