Projects - Get

Service:

Cognitive Services - Custom Vision

Version d'API:

3.3

Obtient un projet spécifique.

GET {Endpoint}/customvision/v3.3/training/projects/{projectId}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
Endpoint	path	True	string	Points de terminaison Cognitive Services pris en charge.
projectId	path	True	string uuid	ID du projet à obtenir.

En-tête de la demande

Nom	Obligatoire	Type	Description
Training-Key	True	string

Réponses

Nom	Type	Description
200 OK	Project	Ok Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Réponse d’erreur Media Types: "application/json", "application/xml", "text/xml"

Sécurité

Training-Key

Type: apiKey
Dans: header

Exemples

Successful GetProject request

Exemple de requête

HTTP

GET https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects/bc3f7dad-5544-468c-8573-3ef04d55463e

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
Classifier	Obtient le type de classification du projet.
CustomVisionError
CustomVisionErrorCodes	Code d'erreur.
ImageProcessingSettings	Représente les paramètres de prétraitement d’image utilisés par l’augmentation d’image.
Project	Représente un projet.
ProjectSettings	Représente les paramètres associés à un projet.
ProjectStatus	Obtient la status du projet.
TargetExportPlatforms	Liste d’ExportPlatform que le modèle entraîné doit être en mesure de prendre en charge.

Classifier

Obtient le type de classification du projet.

Nom	Type	Description
Multiclass	string
Multilabel	string

CustomVisionError

Nom	Type	Description
code	CustomVisionErrorCodes	Code d'erreur.
message	string	Message expliquant l’erreur signalée par le service.

CustomVisionErrorCodes

Code d'erreur.

Nom	Type	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

Représente les paramètres de prétraitement d’image utilisés par l’augmentation d’image.

Nom	Type	Description
augmentationMethods	object	Obtient ou définit les transformations d’images activées. La clé correspond au nom de la transformation. Si la valeur est définie sur true, la transformation correspondante est activée. Sinon, cette transformation ne sera pas utilisée. L’augmentation sera répartie uniformément entre les transformations activées.

Project

Représente un projet.

Nom	Type	Description
created	string	Obtient la date de création de ce projet.
description	string	Obtient ou définit la description du projet.
drModeEnabled	boolean	Obtient si le mode de récupération d’urgence (DR) est activé, indiquant que le projet est temporairement en lecture seule.
id	string	Obtient l’ID de projet.
lastModified	string	Obtient la date de la dernière modification de ce projet.
name	string	Obtient ou définit le nom du projet.
settings	ProjectSettings	Obtient ou définit les paramètres du projet.
status	ProjectStatus	Obtient la status du projet.
thumbnailUri	string	Obtient l’URL miniature représentant l’image. Si la fonctionnalité de réseau virtuel est activée, il s’agit d’un chemin relatif à utiliser avec GetArtifact, sinon, il s’agit d’un URI absolu pour la ressource.

ProjectSettings

Représente les paramètres associés à un projet.

Nom	Type	Description
classificationType	Classifier	Obtient ou définit le type de classification du projet.
detectionParameters	string	Paramètres de détection utilisés, le cas échéant.
domainId	string	Obtient ou définit l’ID du domaine à utiliser avec ce projet.
imageProcessingSettings	ImageProcessingSettings	Obtient ou définit les paramètres de prétraitement d’image.
targetExportPlatforms	TargetExportPlatforms[]	Liste d’ExportPlatform que le modèle entraîné doit être en mesure de prendre en charge.
useNegativeSet	boolean	Indique si le jeu négatif est utilisé.

ProjectStatus

Obtient la status du projet.

Nom	Type	Description
Failed	string
Importing	string
Succeeded	string

TargetExportPlatforms

Liste d’ExportPlatform que le modèle entraîné doit être en mesure de prendre en charge.

Nom	Type	Description
CoreML	string
DockerFile	string
ONNX	string
TensorFlow	string
VAIDK	string