Поделиться через


Create Images From Data - Create Images From Data

Добавьте предоставленные изображения в набор обучающих образов.
Этот API принимает содержимое текста в виде многопартийных или форм-данных и приложения/octet-stream. При использовании нескольких частей несколько файлов изображений можно отправлять одновременно с не более чем 64 файлами. Если все изображения успешно созданы, возвращается код состояния 200(ОК). В противном случае код состояния 207 (Multi-Status) будет возвращен, а состояние сведений для каждого изображения будет указано в полезных данных ответа.

POST {Endpoint}/customvision/v3.4-preview/training/projects/{projectId}/images
POST {Endpoint}/customvision/v3.4-preview/training/projects/{projectId}/images?tagIds={tagIds}

Параметры URI

Имя В Обязательно Тип Описание
imageData
formData True

file

Двоичные данные изображения. Поддерживаются форматы JPEG, GIF, PNG и BMP. Поддерживает изображения до 6 МБ.

Endpoint
path True

string

Поддерживаемые конечные точки Cognitive Services.

projectId
path True

string (uuid)

Идентификатор проекта.

tagIds
query

string[]

Идентификаторы тегов, с которыми следует пометить каждое изображение. Ограничено 20.

Заголовок запроса

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

Имя Обязательно Тип Описание
Training-Key True

string

Ответы

Имя Тип Описание
200 OK

ImageCreateSummary

ХОРОШО

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

Ответ на ошибку

Media Types: "application/json", "application/xml", "text/xml"

Безопасность

Training-Key

Тип: apiKey
В: header

Примеры

Successful CreateImagesFromData request

Образец запроса

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

Пример ответа

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

Определения

Имя Описание
CustomVisionError
CustomVisionErrorCodes

Код ошибки.

Image

Модель изображения, отправляемая в формате JSON.

ImageCreateResult
ImageCreateStatus

Состояние создания образа.

ImageCreateSummary
ImageRegion
ImageTag

CustomVisionError

Имя Тип Описание
code

CustomVisionErrorCodes

Код ошибки.

message

string

Сообщение, объясняющее ошибку, сообщаемую службой.

CustomVisionErrorCodes

Код ошибки.

Значение Описание
BadRequest
BadRequestCannotMigrateProjectWithName
BadRequestClassificationTrainingValidationFailed
BadRequestCustomBaseModelArchitectureRetired
BadRequestCustomBaseModelDomainNotCompatible
BadRequestCustomBaseModelIterationStatusNotCompleted
BadRequestCustomerManagedKeyRevoked
BadRequestDetectionTrainingNotAllowNegativeTag
BadRequestDetectionTrainingValidationFailed
BadRequestDomainNotSupportedForAdvancedTraining
BadRequestExceedIterationPerProjectLimit
BadRequestExceedProjectLimit
BadRequestExceedTagPerImageLimit
BadRequestExceedTagPerProjectLimit
BadRequestExceededBatchSize
BadRequestExceededQuota
BadRequestExportAlreadyInProgress
BadRequestExportPlatformNotSupportedForAdvancedTraining
BadRequestExportValidationFailed
BadRequestExportWhileTraining
BadRequestImageAspectRatio
BadRequestImageBatch
BadRequestImageDimensions
BadRequestImageExceededCount
BadRequestImageFormat
BadRequestImageMetadataKey
BadRequestImageMetadataValue
BadRequestImageRegions
BadRequestImageSizeBytes
BadRequestImageStream
BadRequestImageTags
BadRequestImageUrl
BadRequestInvalid
BadRequestInvalidArtifactUri
BadRequestInvalidEmailAddress
BadRequestInvalidIds
BadRequestInvalidImportToken
BadRequestInvalidPublishName
BadRequestInvalidPublishTarget
BadRequestInvalidUri
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
BadRequestRetiredDomainNotSupportedForTraining
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
ErrorServerTimeOut
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

Модель изображения, отправляемая в формате JSON.

Имя Тип Описание
created

string (date-time)

Дата создания образа.

height

integer (int32)

Высота изображения.

id

string (uuid)

Идентификатор изображения.

metadata

object

Метаданные, связанные с этим изображением.

originalImageUri

string

Универсальный код ресурса (URI) для исходного отправленного образа. Если функция виртуальной сети включена, это будет относительный путь для использования с GetArtifact, в противном случае это будет абсолютный URI для ресурса.

regions

ImageRegion[]

Регионы, связанные с этим изображением.

resizedImageUri

string

Универсальный код ресурса (URI) для образа (измененного размера), используемого для обучения. Если функция виртуальной сети включена, это будет относительный путь для использования с GetArtifact, в противном случае это будет абсолютный URI для ресурса.

tags

ImageTag[]

Теги, связанные с этим изображением.

thumbnailUri

string

Универсальный код ресурса (URI) для эскиза исходного изображения. Если функция виртуальной сети включена, это будет относительный путь для использования с GetArtifact, в противном случае это будет абсолютный URI для ресурса.

width

integer (int32)

Ширина изображения.

ImageCreateResult

Имя Тип Описание
image

Image

Изображение.

sourceUrl

string

Исходный URL-адрес изображения.

status

ImageCreateStatus

Состояние создания образа.

ImageCreateStatus

Состояние создания образа.

Значение Описание
ErrorImageDimensions
ErrorImageFormat
ErrorImageSize
ErrorInvalidTag
ErrorLimitExceed
ErrorNegativeAndRegularTagOnSameImage
ErrorRegionLimitExceed
ErrorSource
ErrorStorage
ErrorTagLimitExceed
ErrorUnknown
OK
OKDuplicate

ImageCreateSummary

Имя Тип Описание
images

ImageCreateResult[]

Список результатов создания изображения.

isBatchSuccessful

boolean

Значение True, если все изображения в пакете были успешно созданы, в противном случае — значение false.

ImageRegion

Имя Тип Описание
created

string (date-time)

height

number (float)

Высота.

left

number (float)

Координата левой границы.

regionId

string (uuid)

tagId

string (uuid)

Идентификатор тега, связанного с этим регионом.

tagName

string

top

number (float)

Координата верхней границы.

width

number (float)

Ширина.

ImageTag

Имя Тип Описание
created

string (date-time)

tagId

string (uuid)

tagName

string