Images - Create From Data

Service:

Cognitive Services - Custom Vision

API Version:

3.3

此 API 接受主體內容做為 multipart/form-data 和 application/octet-stream。 一次使用多部分多個圖像檔時，最多可以傳送 64 個檔案。 如果成功建立所有映像，則會傳回 200 (OK) 狀態代碼。 否則，將會傳回 207 (多重狀態) 狀態代碼，而且每個影像的詳細狀態都會列在響應承載中。

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

With optional parameters:

POST {Endpoint}/customvision/v3.3/training/projects/{projectId}/images?tagIds={tagIds}

URI 參數

名稱	位於	必要	類型	Description
imageData	formData	True	file	二進位影像數據。 支援的格式包括 JPEG、GIF、PNG 和 BMP。 支援最多 6MB 的映像。
Endpoint	path	True	string	支援的認知服務端點。
projectId	path	True	string uuid	項目標識碼。
tagIds	query		string[]	標記標識碼，用來標記每個影像。 限制為 20。

要求標頭

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

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

回應

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

Type: apiKey
In: header

範例

Successful CreateImagesFromData request

Sample Request

HTTP

POST https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects/64b822c5-8082-4b36-a426-27225f4aa18c/images?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"
          }
        ]
      }
    },
    {
      "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"
          }
        ]
      }
    }
  ]
}

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": "\"hemlock_6.jpg\"",
      "status": "ErrorLimitExceed"
    }
  ]
}

定義

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

CustomVisionError

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

CustomVisionErrorCodes

錯誤碼。

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

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

名稱	類型	Description
created	string	建立映像的日期。
height	integer	影像的高度。
id	string	影像的標識碼。
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	影像的寬度。

ImageCreateResult

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

ImageCreateStatus

映射建立的狀態。

名稱	類型	Description
ErrorImageFormat	string
ErrorImageSize	string
ErrorLimitExceed	string
ErrorNegativeAndRegularTagOnSameImage	string
ErrorRegionLimitExceed	string
ErrorSource	string
ErrorStorage	string
ErrorTagLimitExceed	string
ErrorUnknown	string
OK	string
OKDuplicate	string

ImageCreateSummary

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

ImageRegion

名稱	類型	Description
created	string
height	number	高度。
left	number	左界限的座標。
regionId	string
tagId	string	與此區域相關聯的標記標識碼。
tagName	string
top	number	上邊界的座標。
width	number	寬度。

ImageTag

名稱	類型	Description
created	string
tagId	string
tagName	string