Create Images From Urls - Create Images From Urls

服務:: Azure AI Services

API 版本:: 3.4-preview

將提供的影像 URL 新增至定型影像集。
此 API 會接受一批 URL，以及選擇性標記來建立影像。有 64 個影像和 20 個標籤的限制。如果所有映像都成功建立，則會傳回 200（OK）狀態代碼。否則，將會傳回 207 （多重狀態）狀態代碼，並將每個影像的詳細狀態列在響應承載中。

POST {Endpoint}/customvision/v3.4-preview/training/projects/{projectId}/images/urls

URI 參數

名稱	位於	必要	類型	Description
Endpoint	path	True	string	支援的認知服務端點。
projectId	path	True	string (uuid)	項目標識碼。

要求標頭

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

名稱	必要	類型	Description
Training-Key	True	string

要求本文

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

名稱	類型	Description
images	ImageUrlCreateEntry[]
metadata	object	影像的元數據。每個映像的索引鍵/值組限制為10個。密鑰的長度限制為 128。值的長度限制為 256。
tagIds	string[] (uuid)

回應

名稱	類型	Description
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"

名稱

類型

Description

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.4-preview/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
    }
  ]
}

定義

名稱	Description
CustomVisionError
CustomVisionErrorCodes	錯誤碼。
Image	要以 JSON 形式傳送的影像模型。
ImageCreateResult
ImageCreateStatus	映射建立的狀態。
ImageCreateSummary
ImageRegion
ImageTag
ImageUrlCreateBatch
ImageUrlCreateEntry
Region

CustomVisionError

Object

名稱	類型	Description
code	CustomVisionErrorCodes	錯誤碼。
message	string	說明服務所回報錯誤的訊息。

CustomVisionErrorCodes

列舉型別

錯誤碼。

值	Description
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
BadRequestImageAspectRatio
BadRequestImageExceededCount
BadRequestTrainingNotNeeded
BadRequestTrainingNotNeededButTrainingPipelineUpdated
BadRequestTrainingValidationFailed
BadRequestClassificationTrainingValidationFailed
BadRequestMultiClassClassificationTrainingValidationFailed
BadRequestMultiLabelClassificationTrainingValidationFailed
BadRequestDetectionTrainingValidationFailed
BadRequestTrainingAlreadyInProgress
BadRequestDetectionTrainingNotAllowNegativeTag
BadRequestInvalidEmailAddress
BadRequestRetiredDomainNotSupportedForTraining
BadRequestDomainNotSupportedForAdvancedTraining
BadRequestExportPlatformNotSupportedForAdvancedTraining
BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining
BadRequestCustomBaseModelIterationStatusNotCompleted
BadRequestCustomBaseModelDomainNotCompatible
BadRequestCustomBaseModelArchitectureRetired
BadRequestExportValidationFailed
BadRequestExportAlreadyInProgress
BadRequestPredictionIdsMissing
BadRequestPredictionIdsExceededCount
BadRequestPredictionTagsExceededCount
BadRequestPredictionResultsExceededCount
BadRequestPredictionInvalidApplicationName
BadRequestPredictionInvalidQueryParameters
BadRequestInvalidImportToken
BadRequestExportWhileTraining
BadRequestImageMetadataKey
BadRequestImageMetadataValue
BadRequestOperationNotSupported
BadRequestInvalidArtifactUri
BadRequestCustomerManagedKeyRevoked
BadRequestInvalidUri
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
ErrorServerTimeOut
ErrorInvalid

Image

Object

要以 JSON 形式傳送的影像模型。

名稱	類型	Description
created	string (date-time)	建立映像的日期。
height	integer (int32)	影像的高度。
id	string (uuid)	影像的標識碼。
metadata	object	與此影像相關聯的元數據。
originalImageUri	string	原始上傳影像的 URI。如果啟用 VNET 功能，這會是要與 GetArtifact 搭配使用的相對路徑，否則這會是資源的絕對 URI。
regions	ImageRegion[]	與此映像相關聯的區域。
resizedImageUri	string	用於定型之（resized）影像的 URI。如果啟用 VNET 功能，這會是要與 GetArtifact 搭配使用的相對路徑，否則這會是資源的絕對 URI。
tags	ImageTag[]	與此影像相關聯的標記。
thumbnailUri	string	原始影像縮圖的 URI。如果啟用 VNET 功能，這會是要與 GetArtifact 搭配使用的相對路徑，否則這會是資源的絕對 URI。
width	integer (int32)	影像的寬度。

ImageCreateResult

Object

名稱	類型	Description
image	Image	影像。
sourceUrl	string	影像的來源 URL。
status	ImageCreateStatus	映射建立的狀態。

ImageCreateStatus

列舉型別

映射建立的狀態。

值	Description
OK
OKDuplicate
ErrorSource
ErrorImageFormat
ErrorImageSize
ErrorStorage
ErrorLimitExceed
ErrorTagLimitExceed
ErrorRegionLimitExceed
ErrorUnknown
ErrorNegativeAndRegularTagOnSameImage
ErrorImageDimensions
ErrorInvalidTag

ImageCreateSummary

Object

名稱	類型	Description
images	ImageCreateResult[]	映像建立結果的清單。
isBatchSuccessful	boolean	如果成功建立批次中的所有映像，則為 True，否則為 false。

ImageRegion

Object

名稱	類型	Description
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

名稱	類型	Description
created	string (date-time)
tagId	string (uuid)
tagName	string

ImageUrlCreateBatch

Object

名稱	類型	Description
images	ImageUrlCreateEntry[]
metadata	object	影像的元數據。每個映像的索引鍵/值組限制為10個。密鑰的長度限制為 128。值的長度限制為 256。
tagIds	string[] (uuid)

ImageUrlCreateEntry

Object

名稱	類型	Description
regions	Region[]
tagIds	string[] (uuid)
url	string	影像的 URL。

Region

Object

名稱	類型	Description
height	number (float)	高度。
left	number (float)	左邊界的座標。
tagId	string (uuid)	與此區域相關聯的標記標識碼。
top	number (float)	頂端界限的座標。
width	number (float)	寬度。

共用方式為

Create Images From Urls - Create Images From Urls

URI 參數

要求標頭

要求本文

回應

安全性

Training-Key

範例

Successful CreateImagesFromUrls request

範例要求

範例回覆

定義

CustomVisionError

CustomVisionErrorCodes

Image

ImageCreateResult

ImageCreateStatus

ImageCreateSummary

ImageRegion

ImageTag

ImageUrlCreateBatch

ImageUrlCreateEntry

Region