Images - Create From Files

Référence

Service:: Azure AI Services

Version d'API:: 3.3

Cette API accepte un lot de fichiers, et éventuellement des balises, pour créer des images d’entraînement. Il existe une limite de 64 images et 20 balises. Si toutes les images ont réussi à être créées, le code d’état 200(OK) est retourné. Sinon, le code d’état 207 (multi-état) est retourné et l’état des détails de chaque image est répertorié dans la charge utile de réponse.

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

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.

En-tête de la demande

Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Nom	Obligatoire	Type	Description
Training-Key	True	string

Corps de la demande

Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Nom	Type	Description
images	ImageFileCreateEntry[]
metadata	object	Métadonnées de l’image. Limité à 50 paires clé-valeur par image. La longueur de la clé est limitée à 256. La longueur de la valeur est limitée à 512.
tagIds	string[] (uuid)

Réponses

Nom	Type	Description
200 OK	ImageCreateSummary	D’ACCORD 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"

Nom

Type

Description

200 OK

ImageCreateSummary

D’ACCORD

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 CreateImagesFromFiles request

Exemple de requête

HTTP

POST https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects/64b822c5-8082-4b36-a426-27225f4aa18c/images/files


{
  "images": [
    {
      "name": "hemlock_10.jpg",
      "contents": ""
    }
  ],
  "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"
          }
        ]
      }
    }
  ]
}

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": "{url}",
      "status": "ErrorLimitExceed"
    }
  ]
}

Définitions

Nom	Description
CustomVisionError
CustomVisionErrorCodes	Code d’erreur.
Image	Modèle d’image à envoyer en tant que JSON.
ImageCreateResult
ImageCreateStatus	État de la création de l’image.
ImageCreateSummary
ImageFileCreateBatch
ImageFileCreateEntry
ImageRegion
ImageTag
Region

CustomVisionError

Object

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

CustomVisionErrorCodes

Énumération

Code d’erreur.

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

Image

Object

Modèle d’image à envoyer en tant que JSON.

Nom	Type	Description
created	string (date-time)	Date de création de l’image.
height	integer (int32)	Hauteur de l’image.
id	string (uuid)	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 vers 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 vers 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 vers la ressource.
width	integer (int32)	Largeur de l’image.

ImageCreateResult

Object

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

ImageCreateStatus

Énumération

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

Valeur	Description
ErrorImageFormat
ErrorImageSize
ErrorLimitExceed
ErrorNegativeAndRegularTagOnSameImage
ErrorRegionLimitExceed
ErrorSource
ErrorStorage
ErrorTagLimitExceed
ErrorUnknown
OK
OKDuplicate

ImageCreateSummary

Object

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.

ImageFileCreateBatch

Object

Nom	Type	Description
images	ImageFileCreateEntry[]
metadata	object	Métadonnées de l’image. Limité à 50 paires clé-valeur par image. La longueur de la clé est limitée à 256. La longueur de la valeur est limitée à 512.
tagIds	string[] (uuid)

ImageFileCreateEntry

Object

Nom	Type	Description
contents	string (byte)
name	string
regions	Region[]
tagIds	string[] (uuid)

ImageRegion

Object

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

ImageTag

Object

Nom	Type	Description
created	string (date-time)
tagId	string (uuid)
tagName	string

Region

Object

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

Partager via

Images - Create From Files

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

Training-Key

Exemples

Successful CreateImagesFromFiles request

Exemple de requête

Exemple de réponse

Définitions

CustomVisionError

CustomVisionErrorCodes

Image

ImageCreateResult

ImageCreateStatus

ImageCreateSummary

ImageFileCreateBatch

ImageFileCreateEntry

ImageRegion

ImageTag

Region