Predictions - Query

參考

服務:: Azure AI Services

API 版本:: 3.3

取得傳送至預測端點的影像。

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

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
application	string
continuation	string
endTime	string (date-time)
iterationId	string (uuid)
maxCount	integer (int32)
orderBy	OrderBy
session	string
startTime	string (date-time)
tags	PredictionQueryTag[]

回應

名稱	類型	Description
200 OK	PredictionQueryResult	還行 Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	錯誤回應 Media Types: "application/json", "application/xml", "text/xml"

名稱

類型

Description

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": ""
  }
}

定義

名稱	Description
BoundingBox	定義影像區域的周框方塊。
CustomVisionError
CustomVisionErrorCodes	錯誤碼。
OrderBy
Prediction	預測結果。
PredictionQueryResult	已傳送至預測端點的預測影像查詢結果。
PredictionQueryTag
PredictionQueryToken
StoredImagePrediction	影像預測要求的結果。
TagType	預測標記的類型。

BoundingBox

Object

定義影像區域的周框方塊。

名稱	類型	Description
height	number (float)	高度。
left	number (float)	左邊界的座標。
top	number (float)	頂端界限的座標。
width	number (float)	寬度。

CustomVisionError

Object

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

CustomVisionErrorCodes

列舉型別

錯誤碼。

值	Description
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

列舉型別

值	Description
Newest
Oldest
Suggested

Prediction

Object

預測結果。

名稱	類型	Description
boundingBox	BoundingBox	預測的周框方塊。
probability	number (float)	標記的機率。
tagId	string (uuid)	預測標記的標識碼。
tagName	string	預測標記的名稱。
tagType	TagType	預測標記的類型。

PredictionQueryResult

Object

已傳送至預測端點的預測影像查詢結果。

名稱	類型	Description
results	StoredImagePrediction[]	影像預測要求的結果。
token	PredictionQueryToken	預測查詢令牌。

PredictionQueryTag

Object

名稱	類型	Description
id	string (uuid)
maxThreshold	number (float)
minThreshold	number (float)

PredictionQueryToken

Object

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

影像預測要求的結果。

名稱	類型	Description
created	string (date-time)	建立此預測的日期。
domain	string (uuid)	用於預測的網域。
id	string (uuid)	預測標識碼。
iteration	string (uuid)	反覆項目標識碼。
originalImageUri	string	原始預測影像的 URI。如果啟用 VNET 功能，這會是要與 GetArtifact 搭配使用的相對路徑，否則這會是資源的絕對 URI。
predictions	Prediction[]	預測清單。
project	string (uuid)	項目標識碼。
resizedImageUri	string	[已重設大小] 預測影像的 URI。如果啟用 VNET 功能，這會是要與 GetArtifact 搭配使用的相對路徑，否則這會是資源的絕對 URI。
thumbnailUri	string	原始預測影像縮圖的URI。如果啟用 VNET 功能，這會是要與 GetArtifact 搭配使用的相對路徑，否則這會是資源的絕對 URI。

TagType

列舉型別

預測標記的類型。

值	Description
GeneralProduct
Negative
Regular

共用方式為

Predictions - Query

URI 參數

要求標頭

要求本文

回應

安全性

Training-Key

範例

Successful QueryPredictions request

範例要求

範例回覆

定義

BoundingBox

CustomVisionError

CustomVisionErrorCodes

OrderBy

Prediction

PredictionQueryResult

PredictionQueryTag

PredictionQueryToken

StoredImagePrediction

TagType

其他資源