Images - Create From Data

Service:

Chaos Studio

Version d'API:

3.3

Cette API accepte le contenu du corps comme multipart/form-data et application/octet-stream. Lors de l’utilisation de plusieurs fichiers image en plusieurs parties, vous pouvez envoyer simultanément, avec un maximum de 64 fichiers. Si toutes les images sont créées avec succès, 200(OK) status code est retourné. Sinon, le code 207 (multiétat) status est retourné et les status détaillées pour chaque image sont répertoriées dans la charge utile de réponse.

POST {Endpoint}/customvision/v3.3/training/projects/{projectId}/images

Avec des paramètres facultatifs:

POST {Endpoint}/customvision/v3.3/training/projects/{projectId}/images?tagIds={tagIds}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
imageData	formData	True	file	Données d’image binaires. Les formats pris en charge sont JPEG, GIF, PNG et BMP. Prend en charge les images jusqu’à 6 Mo.
Endpoint	path	True	string	Points de terminaison Cognitive Services pris en charge.
projectId	path	True	string uuid	ID de projet.
tagIds	query		string[]	ID d’étiquettes avec lesquels baliser chaque image. Limité à 20.

En-tête de la demande

Media Types: "multipart/form-data", "application/octet-stream"

Nom	Obligatoire	Type	Description
Training-Key	True	string

Réponses

Nom	Type	Description
200 OK	ImageCreateSummary	Ok Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	ImageCreateSummary	207 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 CreateImagesFromData request

Exemple de requête

HTTP

POST https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects/64b822c5-8082-4b36-a426-27225f4aa18c/images?tagIds=b607964f-7bd6-4a3b-a869-6791fb6aab87

Exemple de réponse

Code d’état:

200

{
  "isBatchSuccessful": true,
  "images": [
    {
      "sourceUrl": "\"hemlock_10.jpg\"",
      "status": "OK",
      "image": {
        "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
        "created": "2017-12-19T15:56:10Z",
        "width": 1095,
        "height": 900,
        "resizedImageUri": "{Resized Image Uri}",
        "originalImageUri": "{Image Uri}",
        "thumbnailUri": "{Thumbnail Uri}",
        "tags": [
          {
            "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
            "created": "2017-12-19T15:56:09Z",
            "tagName": "tag 1"
          }
        ]
      }
    },
    {
      "sourceUrl": "\"hemlock_6.jpg\"",
      "status": "OK",
      "image": {
        "id": "f1855a92-b873-47e7-b513-f07a667ceda1",
        "created": "2017-12-19T15:56:10Z",
        "width": 900,
        "height": 1531,
        "resizedImageUri": "{Resized Image Uri}",
        "originalImageUri": "{Image Uri}",
        "thumbnailUri": "{Thumbnail Uri}",
        "tags": [
          {
            "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
            "created": "2017-12-19T15:56:09Z",
            "tagName": "tag 1"
          }
        ]
      }
    }
  ]
}

Code d’état:

207

{
  "isBatchSuccessful": false,
  "images": [
    {
      "sourceUrl": "\"hemlock_10.jpg\"",
      "status": "OK",
      "image": {
        "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
        "created": "2017-12-19T15:56:10Z",
        "width": 1095,
        "height": 900,
        "resizedImageUri": "{Resized Image Uri}",
        "originalImageUri": "{Image Uri}",
        "thumbnailUri": "{Thumbnail Uri}",
        "tags": [
          {
            "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
            "created": "2017-12-19T15:56:09Z",
            "tagName": "tag 1"
          }
        ]
      }
    },
    {
      "sourceUrl": "\"hemlock_6.jpg\"",
      "status": "ErrorLimitExceed"
    }
  ]
}

Définitions

Nom	Description
CustomVisionError
CustomVisionErrorCodes	Code d'erreur.
Image	Modèle d’image à envoyer au format JSON.
ImageCreateResult
ImageCreateStatus	État de la création de l’image.
ImageCreateSummary
ImageRegion
ImageTag

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

Image

Modèle d’image à envoyer au format JSON.

Nom	Type	Description
created	string	Date de création de l’image.
height	integer	Hauteur de l’image.
id	string	ID de l’image.
metadata	object	Métadonnées associées à cette image.
originalImageUri	string	URI de l’image chargée d’origine. 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 de la ressource.
regions	ImageRegion[]	Régions associées à cette image.
resizedImageUri	string	URI de l’image (redimensionnée) utilisée pour l’entraînement. 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 de la ressource.
tags	ImageTag[]	Balises associées à cette image.
thumbnailUri	string	URI de la miniature de l’image d’origine. 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 de la ressource.
width	integer	Largeur de l’image.

ImageCreateResult

Nom	Type	Description
image	Image	L’image.
sourceUrl	string	URL source de l’image.
status	ImageCreateStatus	État de la création de l’image.

ImageCreateStatus

État de la création de l’image.

Nom	Type	Description
ErrorImageFormat	string
ErrorImageSize	string
ErrorLimitExceed	string
ErrorNegativeAndRegularTagOnSameImage	string
ErrorRegionLimitExceed	string
ErrorSource	string
ErrorStorage	string
ErrorTagLimitExceed	string
ErrorUnknown	string
OK	string
OKDuplicate	string

ImageCreateSummary

Nom	Type	Description
images	ImageCreateResult[]	Liste des résultats de la création d’image.
isBatchSuccessful	boolean	True si toutes les images du lot ont été créées correctement, sinon false.

ImageRegion

Nom	Type	Description
created	string
height	number	Hauteur.
left	number	Coordonnée de la limite gauche.
regionId	string
tagId	string	ID de la balise associée à cette région.
tagName	string
top	number	Coordonnée de la limite supérieure.
width	number	Largeur.

ImageTag

Nom	Type	Description
created	string
tagId	string
tagName	string