Projects - Create

Service:

Cognitive Services - Custom Vision

API Version:

3.3

Crear un proyecto.

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}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Puntos de conexión de Cognitive Services admitidos.
name	query	True	string	Nombre del proyecto.
classificationType	query		string	Tipo de clasificador que se va a crear para este proyecto.
description	query		string	Descripción del proyecto.
domainId	query		string uuid	Identificador del dominio que se va a usar para este proyecto. El valor predeterminado es General.
targetExportPlatforms	query		string[]	Lista de plataformas a las que el modelo entrenado pretende exportar.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Training-Key	True	string

Respuestas

Nombre	Tipo	Description
200 OK	Project	Aceptar Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Respuesta de error Media Types: "application/json", "application/xml", "text/xml"

Seguridad

Training-Key

Type: apiKey
In: header

Ejemplos

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": ""
}

Definiciones

Nombre	Description
Classifier	Obtiene el tipo de clasificación del proyecto.
CustomVisionError
CustomVisionErrorCodes	Código de error.
ImageProcessingSettings	Representa la configuración de preprocesamiento de imágenes usada por el aumento de imágenes.
Project	Representa un proyecto.
ProjectSettings	Representa la configuración asociada a un proyecto.
ProjectStatus	Obtiene el estado del proyecto.
TargetExportPlatforms	Lista de ExportPlatform que el modelo entrenado debe ser compatible.

Classifier

Obtiene el tipo de clasificación del proyecto.

Nombre	Tipo	Description
Multiclass	string
Multilabel	string

CustomVisionError

Nombre	Tipo	Description
code	CustomVisionErrorCodes	Código de error.
message	string	Mensaje que explica el error notificado por el servicio.

CustomVisionErrorCodes

Código de error.

Nombre	Tipo	Description
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

Representa la configuración de preprocesamiento de imágenes usada por el aumento de imágenes.

Nombre	Tipo	Description
augmentationMethods	object	Obtiene o establece transformaciones de imagen habilitadas. La clave corresponde al nombre de la transformación. Si el valor se establece en true, se habilita la transformación correspondiente. De lo contrario, no se usará esta transformación. El aumento se distribuirá uniformemente entre las transformaciones habilitadas.

Project

Representa un proyecto.

Nombre	Tipo	Description
created	string	Obtiene la fecha en que se creó este proyecto.
description	string	Obtiene o establece la descripción del proyecto.
drModeEnabled	boolean	Obtiene si el modo de recuperación ante desastres (DR) está activado, lo que indica que el proyecto es de solo lectura temporalmente.
id	string	Obtiene el identificador del proyecto.
lastModified	string	Obtiene la fecha en que se modificó por última vez este proyecto.
name	string	Obtiene o establece el nombre del proyecto.
settings	ProjectSettings	Obtiene o establece la configuración del proyecto.
status	ProjectStatus	Obtiene el estado del proyecto.
thumbnailUri	string	Obtiene la dirección URL en miniatura que representa la imagen. Si la característica de red virtual está habilitada, será una ruta de acceso relativa que se usará con GetArtifact; de lo contrario, será un URI absoluto para el recurso.

ProjectSettings

Representa la configuración asociada a un proyecto.

Nombre	Tipo	Description
classificationType	Classifier	Obtiene o establece el tipo de clasificación del proyecto.
detectionParameters	string	Parámetros de detección en uso, si los hay.
domainId	string	Obtiene o establece el identificador del dominio que se va a usar con este proyecto.
imageProcessingSettings	ImageProcessingSettings	Obtiene o establece la configuración de preprocesamiento de imágenes.
targetExportPlatforms	TargetExportPlatforms[]	Lista de ExportPlatform que el modelo entrenado debe ser compatible.
useNegativeSet	boolean	Indica si se usa un conjunto negativo.

ProjectStatus

Obtiene el estado del proyecto.

Nombre	Tipo	Description
Failed	string
Importing	string
Succeeded	string

TargetExportPlatforms

Lista de ExportPlatform que el modelo entrenado debe ser compatible.

Nombre	Tipo	Description
CoreML	string
DockerFile	string
ONNX	string
TensorFlow	string
VAIDK	string