Images - Create From Urls

Служба:: Azure AI Services

Версия API:: 3.3

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services.
projectId	path	True	string (uuid)	Идентификатор проекта.

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

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

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

Текст запроса

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

Имя	Тип	Описание
images	ImageUrlCreateEntry[]
metadata	object	Метаданные изображения. Ограничено 50 парами "ключ-значение" на изображение. Длина ключа ограничена 256. Длина значения ограничена 512.
tagIds	string[] (uuid)

Ответы

Имя	Тип	Описание
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"

Имя

Тип

Описание

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

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

HTTP

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


{
  "images": [
    {
      "url": "{url to image}"
    }
  ],
  "tagIds": [
    "b607964f-7bd6-4a3b-a869-6791fb6aab87"
  ]
}

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

Код состояния:: 200

{
  "isBatchSuccessful": true,
  "images": [
    {
      "sourceUrl": "{url to image}",
      "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 name"
          }
        ]
      }
    }
  ]
}

Код состояния:: 207

{
  "isBatchSuccessful": false,
  "images": [
    {
      "sourceUrl": "{url to image}",
      "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 name"
          }
        ]
      }
    },
    {
      "sourceUrl": "{url to image}",
      "status": "ErrorSource",
      "image": null
    }
  ]
}

Определения

Имя	Описание
CustomVisionError
CustomVisionErrorCodes	Код ошибки.
Image	Модель изображения, отправляемая в формате JSON.
ImageCreateResult
ImageCreateStatus	Состояние создания образа.
ImageCreateSummary
ImageRegion
ImageTag
ImageUrlCreateBatch
ImageUrlCreateEntry
Region

CustomVisionError

Object

Имя	Тип	Описание
code	CustomVisionErrorCodes	Код ошибки.
message	string	Сообщение, объясняющее ошибку, сообщаемую службой.

CustomVisionErrorCodes

Перечисление

Код ошибки.

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

Image

Object

Модель изображения, отправляемая в формате 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

Object

Имя	Тип	Описание
image	Image	Изображение.
sourceUrl	string	Исходный URL-адрес изображения.
status	ImageCreateStatus	Состояние создания образа.

ImageCreateStatus

Перечисление

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

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

ImageCreateSummary

Object

Имя	Тип	Описание
images	ImageCreateResult[]	Список результатов создания изображения.
isBatchSuccessful	boolean	Значение True, если все изображения в пакете были успешно созданы, в противном случае — значение false.

ImageRegion

Object

Имя	Тип	Описание
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

Object

Имя	Тип	Описание
created	string (date-time)
tagId	string (uuid)
tagName	string

ImageUrlCreateBatch

Object

Имя	Тип	Описание
images	ImageUrlCreateEntry[]
metadata	object	Метаданные изображения. Ограничено 50 парами "ключ-значение" на изображение. Длина ключа ограничена 256. Длина значения ограничена 512.
tagIds	string[] (uuid)

ImageUrlCreateEntry

Object

Имя	Тип	Описание
regions	Region[]
tagIds	string[] (uuid)
url	string	URL-адрес изображения.

Region

Object

Имя	Тип	Описание
height	number (float)	Высота.
left	number (float)	Координата левой границы.
tagId	string (uuid)	Идентификатор тега, связанного с этим регионом.
top	number (float)	Координата верхней границы.
width	number (float)	Ширина.

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

Images - Create From Urls

Параметры URI

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

Текст запроса

Ответы

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

Training-Key

Примеры

Successful CreateImagesFromUrls request

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

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

Определения

CustomVisionError

CustomVisionErrorCodes

Image

ImageCreateResult

ImageCreateStatus

ImageCreateSummary

ImageRegion

ImageTag

ImageUrlCreateBatch

ImageUrlCreateEntry

Region