Images - Create From Urls
指定されたイメージ URL をトレーニング イメージのセットに追加します。 この API は、URL のバッチと、必要に応じてタグを受け取り、画像を作成します。 64 個の画像と 20 個のタグという制限があります。 すべてのイメージが正常に作成されると、200 (OK) 状態コードが返されます。 それ以外の場合は、207 (複数状態) 状態コードが返され、各画像の詳細状態が応答ペイロードに一覧表示されます。
POST {Endpoint}/customvision/v3.3/training/projects/{projectId}/images/urls
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
Endpoint
|
path | True |
string |
サポートされている Cognitive Services エンドポイント。 |
project
|
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 | ||
metadata |
object |
イメージのメタデータ。 イメージあたり 50 個のキーと値のペアに制限されています。 キーの長さは 256 に制限されています。 値の長さは 512 に制限されています。 |
tagIds |
string[] (uuid) |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
わかりました Media Types: "application/json", "application/xml", "text/xml" |
|
Other Status Codes |
207 Media Types: "application/json", "application/xml", "text/xml" |
|
Other Status Codes |
エラー応答 Media Types: "application/json", "application/xml", "text/xml" |
セキュリティ
Training-Key
型:
apiKey
/:
header
例
Successful CreateImagesFromUrls request
要求のサンプル
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"
]
}
応答のサンプル
{
"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"
}
]
}
}
]
}
{
"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
}
]
}
定義
名前 | 説明 |
---|---|
Custom |
|
Custom |
エラー コード。 |
Image |
JSON として送信されるイメージ モデル。 |
Image |
|
Image |
イメージ作成の状態。 |
Image |
|
Image |
|
Image |
|
Image |
|
Image |
|
Region |
CustomVisionError
名前 | 型 | 説明 |
---|---|---|
code |
エラー コード。 |
|
message |
string |
サービスによって報告されたエラーを説明するメッセージ。 |
CustomVisionErrorCodes
エラー コード。
値 | 説明 |
---|---|
BadRequest | |
BadRequestCannotMigrateProjectWithName | |
BadRequestClassificationTrainingValidationFailed | |
BadRequestCustomerManagedKeyRevoked | |
BadRequestDetectionTrainingNotAllowNegativeTag | |
BadRequestDetectionTrainingValidationFailed | |
BadRequestDomainNotSupportedForAdvancedTraining | |
BadRequestExceedIterationPerProjectLimit | |
BadRequestExceedProjectLimit | |
BadRequestExceedTagPerImageLimit | |
BadRequestExceedTagPerProjectLimit | |
BadRequestExceededBatchSize | |
BadRequestExceededQuota | |
BadRequestExportAlreadyInProgress | |
BadRequestExportPlatformNotSupportedForAdvancedTraining | |
BadRequestExportValidationFailed | |
BadRequestExportWhileTraining | |
BadRequestImageBatch | |
BadRequestImageDimensions | |
BadRequestImageExceededCount | |
BadRequestImageFormat | |
BadRequestImageMetadataKey | |
BadRequestImageMetadataValue | |
BadRequestImageRegions | |
BadRequestImageSizeBytes | |
BadRequestImageStream | |
BadRequestImageTags | |
BadRequestImageUrl | |
BadRequestInvalid | |
BadRequestInvalidArtifactUri | |
BadRequestInvalidEmailAddress | |
BadRequestInvalidIds | |
BadRequestInvalidImportToken | |
BadRequestInvalidPublishName | |
BadRequestInvalidPublishTarget | |
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 | |
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 | |
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) |
イメージの ID。 |
metadata |
object |
このイメージに関連付けられているメタデータ。 |
originalImageUri |
string |
アップロードされた元のイメージへの URI。 VNET 機能が有効になっている場合、これは GetArtifact で使用される相対パスになります。それ以外の場合は、リソースへの絶対 URI になります。 |
regions |
このイメージに関連付けられているリージョン。 |
|
resizedImageUri |
string |
トレーニングに使用される (サイズ変更された) イメージの URI。 VNET 機能が有効になっている場合、これは GetArtifact で使用される相対パスになります。それ以外の場合は、リソースへの絶対 URI になります。 |
tags |
Image |
この画像に関連付けられているタグ。 |
thumbnailUri |
string |
元の画像のサムネイルへの URI。 VNET 機能が有効になっている場合、これは GetArtifact で使用される相対パスになります。それ以外の場合は、リソースへの絶対 URI になります。 |
width |
integer (int32) |
イメージの幅。 |
ImageCreateResult
名前 | 型 | 説明 |
---|---|---|
image |
画像。 |
|
sourceUrl |
string |
イメージのソース URL。 |
status |
イメージ作成の状態。 |
ImageCreateStatus
イメージ作成の状態。
値 | 説明 |
---|---|
ErrorImageFormat | |
ErrorImageSize | |
ErrorLimitExceed | |
ErrorNegativeAndRegularTagOnSameImage | |
ErrorRegionLimitExceed | |
ErrorSource | |
ErrorStorage | |
ErrorTagLimitExceed | |
ErrorUnknown | |
OK | |
OKDuplicate |
ImageCreateSummary
名前 | 型 | 説明 |
---|---|---|
images |
イメージの作成結果の一覧。 |
|
isBatchSuccessful |
boolean |
バッチ内のすべてのイメージが正常に作成された場合は True、それ以外の場合は false。 |
ImageRegion
名前 | 型 | 説明 |
---|---|---|
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
名前 | 型 | 説明 |
---|---|---|
created |
string (date-time) |
|
tagId |
string (uuid) |
|
tagName |
string |
ImageUrlCreateBatch
名前 | 型 | 説明 |
---|---|---|
images | ||
metadata |
object |
イメージのメタデータ。 イメージあたり 50 個のキーと値のペアに制限されています。 キーの長さは 256 に制限されています。 値の長さは 512 に制限されています。 |
tagIds |
string[] (uuid) |
ImageUrlCreateEntry
名前 | 型 | 説明 |
---|---|---|
regions |
Region[] |
|
tagIds |
string[] (uuid) |
|
url |
string |
画像の URL。 |
Region
名前 | 型 | 説明 |
---|---|---|
height |
number (float) |
高さ。 |
left |
number (float) |
左側の境界の座標。 |
tagId |
string (uuid) |
このリージョンに関連付けられているタグの ID。 |
top |
number (float) |
上部の境界の座標。 |
width |
number (float) |
幅。 |