Predictions - Query

リファレンス

サービス:: Azure AI Services

API バージョン:: 3.3

予測エンドポイントに送信された画像を取得します。

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

URI パラメーター

名前	/	必須	型	説明
Endpoint	path	True	string	サポートされている Cognitive Services エンドポイント。
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"

名前	型	説明
application	string
continuation	string
endTime	string (date-time)
iterationId	string (uuid)
maxCount	integer (int32)
orderBy	OrderBy
session	string
startTime	string (date-time)
tags	PredictionQueryTag[]

応答

名前	型	説明
200 OK	PredictionQueryResult	わかりました Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	エラー応答 Media Types: "application/json", "application/xml", "text/xml"

名前

型

説明

200 OK

PredictionQueryResult

わかりました

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

要求のサンプル

HTTP

POST https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects/bc3f7dad-5544-468c-8573-3ef04d55463e/predictions/query


{
  "orderBy": "Newest",
  "tags": [
    {
      "id": "b5f7e6a2-a481-49a6-afec-a7cef1af3544",
      "maxThreshold": 1,
      "minThreshold": 0.9
    }
  ]
}

応答のサンプル

状態コード:: 200

{
  "results": [
    {
      "id": "dfd2d346-3ed5-4e1e-857d-af4e32cec042",
      "project": "8988643a-ae70-447d-9a22-15c4255e5ecb",
      "iteration": "b7b9d99c-a2c6-4658-9900-a98d2ff5bc66",
      "created": "2018-01-31T20:18:26Z",
      "predictions": [
        {
          "tagId": "b5f7e6a2-a481-49a6-afec-a7cef1af3544",
          "tagName": "Tag 1",
          "probability": 1
        },
        {
          "tagId": "45619cda-d1c9-4bc8-a3e1-87c5d81adbc3",
          "tagName": "Tag 2",
          "probability": 3.60627153E-12
        }
      ],
      "originalImageUri": "<image uri>",
      "thumbnailUri": "<thumbnail uri>",
      "resizedImageUri": "<resized image uri>",
      "domain": "b30a91ae-e3c1-4f73-a81e-c270bff27c39"
    }
  ],
  "token": {
    "session": "1:286613",
    "continuation": "",
    "maxCount": 0,
    "orderBy": "Newest",
    "tags": [
      {
        "id": "b5f7e6a2-a481-49a6-afec-a7cef1af3544",
        "minThreshold": 0.9,
        "maxThreshold": 1
      }
    ],
    "iterationId": null,
    "startTime": null,
    "endTime": null,
    "application": ""
  }
}

定義

名前	説明
BoundingBox	イメージの領域を定義する境界ボックス。
CustomVisionError
CustomVisionErrorCodes	エラーコード。
OrderBy
Prediction	予測結果。
PredictionQueryResult	予測エンドポイントに送信された予測画像のクエリ結果。
PredictionQueryTag
PredictionQueryToken
StoredImagePrediction	画像予測要求の結果。
TagType	予測されるタグの型。

BoundingBox

Object

イメージの領域を定義する境界ボックス。

名前	型	説明
height	number (float)	高さ。
left	number (float)	左側の境界の座標。
top	number (float)	上部の境界の座標。
width	number (float)	幅。

CustomVisionError

Object

名前	型	説明
code	CustomVisionErrorCodes	エラーコード。
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

OrderBy

列挙

値	説明
Newest
Oldest
Suggested

Prediction

Object

予測結果。

名前	型	説明
boundingBox	BoundingBox	予測の境界ボックス。
probability	number (float)	タグの確率。
tagId	string (uuid)	予測されるタグの ID。
tagName	string	予測されるタグの名前。
tagType	TagType	予測されるタグの型。

PredictionQueryResult

Object

予測エンドポイントに送信された予測画像のクエリ結果。

名前	型	説明
results	StoredImagePrediction[]	画像予測要求の結果。
token	PredictionQueryToken	予測クエリトークン。

PredictionQueryTag

Object

名前	型	説明
id	string (uuid)
maxThreshold	number (float)
minThreshold	number (float)

PredictionQueryToken

Object

名前	型	説明
application	string
continuation	string
endTime	string (date-time)
iterationId	string (uuid)
maxCount	integer (int32)
orderBy	OrderBy
session	string
startTime	string (date-time)
tags	PredictionQueryTag[]

StoredImagePrediction

Object

画像予測要求の結果。

名前	型	説明
created	string (date-time)	この予測が作成された日付。
domain	string (uuid)	予測に使用されるドメイン。
id	string (uuid)	予測 ID。
iteration	string (uuid)	イテレーション ID。
originalImageUri	string	元の予測イメージへの URI。 VNET 機能が有効になっている場合、これは GetArtifact で使用される相対パスになります。それ以外の場合は、リソースへの絶対 URI になります。
predictions	Prediction[]	予測の一覧。
project	string (uuid)	プロジェクト ID。
resizedImageUri	string	(サイズ変更された) 予測イメージへの URI。 VNET 機能が有効になっている場合、これは GetArtifact で使用される相対パスになります。それ以外の場合は、リソースへの絶対 URI になります。
thumbnailUri	string	元の予測画像のサムネイルへの URI。 VNET 機能が有効になっている場合、これは GetArtifact で使用される相対パスになります。それ以外の場合は、リソースへの絶対 URI になります。

TagType

列挙

予測されるタグの型。

値	説明
GeneralProduct
Negative
Regular

次の方法で共有

Predictions - Query

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

Training-Key

例

Successful QueryPredictions request

要求のサンプル

応答のサンプル

定義

BoundingBox

CustomVisionError

CustomVisionErrorCodes

OrderBy

Prediction

PredictionQueryResult

PredictionQueryTag

PredictionQueryToken

StoredImagePrediction

TagType

その他のリソース