你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Images - Create From Urls

服务:: Azure AI Services

API 版本:: 3.3

将提供的图像 URL 添加到训练图像集。此 API 接受一批 URL 和选择性标记来创建图像。有 64 个图像和 20 个标记的限制。如果所有映像都成功创建，将返回 200（OK）状态代码。否则，将返回 207（多状态）状态代码，并且每个图像的详细信息状态将列在响应有效负载中。

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

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string	支持的认知服务终结点。
projectId	path	True	string (uuid)	项目 ID。

请求头

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)	图像的 ID。
metadata	object	与此映像关联的元数据。
originalImageUri	string	原始上传图像的 URI。如果启用了 VNET 功能，则会是用于 GetArtifact 的相对路径，否则这是资源的绝对 URI。
regions	ImageRegion[]	与此映像关联的区域。
resizedImageUri	string	用于训练的（调整大小）图像的 URI。如果启用了 VNET 功能，则会是用于 GetArtifact 的相对路径，否则这是资源的绝对 URI。
tags	ImageTag[]	与此图像关联的标记。
thumbnailUri	string	原始图像缩略图的 URI。如果启用了 VNET 功能，则会是用于 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)	与此区域关联的标记的 ID。
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)	与此区域关联的标记的 ID。
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