Create Images From Files - Create Images From Files

Service:

Cognitive Services - Custom Vision

API Version:

3.3

Dodaj podaną partię obrazów do zestawu obrazów szkoleniowych.
Ten interfejs API akceptuje partię plików i opcjonalnie tagi do tworzenia obrazów. Istnieje limit wynoszący 64 obrazy i 20 tagów. Jeśli wszystkie obrazy zostaną pomyślnie utworzone, zostanie zwrócony kod stanu 200(OK). W przeciwnym razie zostanie zwrócony kod stanu 207 (stan wielokrotny), a stan szczegółów każdego obrazu zostanie wyświetlony w ładunku odpowiedzi.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services.
projectId	path	True	string uuid	Identyfikator projektu.

Nagłówek żądania

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

Nazwa	Wymagane	Typ	Opis
Training-Key	True	string

Treść żądania

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

Nazwa	Typ	Opis
images	ImageFileCreateEntry[]
metadata	object	Metadane obrazu. Ograniczone do 50 par klucz-wartość na obraz. Długość klucza jest ograniczona do 256. Długość wartości jest ograniczona do 512.
tagIds	string[]

Odpowiedzi

Nazwa	Typ	Opis
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	Odpowiedź na błąd Media Types: "application/json", "application/xml", "text/xml"

Zabezpieczenia

Training-Key

Type: apiKey
In: header

Przykłady

Successful CreateImagesFromFiles request

Sample Request

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": "{image contents}"
    }
  ],
  "tagIds": [
    "b607964f-7bd6-4a3b-a869-6791fb6aab87"
  ]
}

Sample Response

Status code:

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

Status code:

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

Definicje

Nazwa	Opis
CustomVisionError
CustomVisionErrorCodes	Kod błędu.
Image	Model obrazu do wysłania jako kod JSON.
ImageCreateResult
ImageCreateStatus	Stan tworzenia obrazu.
ImageCreateSummary
ImageFileCreateBatch
ImageFileCreateEntry
ImageRegion
ImageTag
Region

CustomVisionError

Nazwa	Typ	Opis
code	CustomVisionErrorCodes	Kod błędu.
message	string	Komunikat wyjaśniający błąd zgłoszony przez usługę.

CustomVisionErrorCodes

Kod błędu.

Nazwa	Typ	Opis
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

Model obrazu do wysłania jako kod JSON.

Nazwa	Typ	Opis
created	string	Data utworzenia obrazu.
height	integer	Wysokość obrazu.
id	string	Identyfikator obrazu.
metadata	object	Metadane skojarzone z tym obrazem.
originalImageUri	string	Identyfikator URI do oryginalnego przekazanego obrazu. Jeśli funkcja sieci wirtualnej jest włączona, będzie to ścieżka względna do użycia z poleceniem GetArtifact. W przeciwnym razie będzie to bezwzględny identyfikator URI zasobu.
regions	ImageRegion[]	Regiony skojarzone z tym obrazem.
resizedImageUri	string	Identyfikator URI obrazu (zmieniany rozmiar) używany do trenowania. Jeśli funkcja sieci wirtualnej jest włączona, będzie to ścieżka względna do użycia z poleceniem GetArtifact. W przeciwnym razie będzie to bezwzględny identyfikator URI zasobu.
tags	ImageTag[]	Tagi skojarzone z tym obrazem.
thumbnailUri	string	Identyfikator URI do miniatury oryginalnego obrazu. Jeśli funkcja sieci wirtualnej jest włączona, będzie to ścieżka względna do użycia z poleceniem GetArtifact. W przeciwnym razie będzie to bezwzględny identyfikator URI zasobu.
width	integer	Szerokość obrazu.

ImageCreateResult

Nazwa	Typ	Opis
image	Image	Obraz.
sourceUrl	string	Źródłowy adres URL obrazu.
status	ImageCreateStatus	Stan tworzenia obrazu.

ImageCreateStatus

Stan tworzenia obrazu.

Nazwa	Typ	Opis
ErrorImageFormat	string
ErrorImageSize	string
ErrorLimitExceed	string
ErrorNegativeAndRegularTagOnSameImage	string
ErrorRegionLimitExceed	string
ErrorSource	string
ErrorStorage	string
ErrorTagLimitExceed	string
ErrorUnknown	string
OK	string
OKDuplicate	string

ImageCreateSummary

Nazwa	Typ	Opis
images	ImageCreateResult[]	Lista wyników tworzenia obrazu.
isBatchSuccessful	boolean	Wartość True, jeśli wszystkie obrazy w partii zostały utworzone pomyślnie, w przeciwnym razie wartość false.

ImageFileCreateBatch

Nazwa	Typ	Opis
images	ImageFileCreateEntry[]
metadata	object	Metadane obrazu. Ograniczone do 50 par klucz-wartość na obraz. Długość klucza jest ograniczona do 256. Długość wartości jest ograniczona do 512.
tagIds	string[]

ImageFileCreateEntry

Nazwa	Typ	Opis
contents	string
name	string
regions	Region[]
tagIds	string[]

ImageRegion

Nazwa	Typ	Opis
created	string
height	number	Wysokość.
left	number	Współrzędna lewej granicy.
regionId	string
tagId	string	Identyfikator tagu skojarzonego z tym regionem.
tagName	string
top	number	Współrzędna górnej granicy.
width	number	Szerokość.

ImageTag

Nazwa	Typ	Opis
created	string
tagId	string
tagName	string

Region

Nazwa	Typ	Opis
height	number	Wysokość.
left	number	Współrzędna lewej granicy.
tagId	string	Identyfikator tagu skojarzonego z tym regionem.
top	number	Współrzędna górnej granicy.
width	number	Szerokość.