Iterations - List Performance Images

參考

服務:: Azure AI Services

API 版本:: 3.3

取得具有指定專案反覆項目預測的影像。此 API 支援批處理和範圍選取。根據預設，它只會傳回前 50 個符合影像的影像。使用 {take} 和 {skip} 参數來控制在指定批次中傳回多少個影像。篩選是在和/或關聯性上。例如，如果提供的標記標識碼適用於「Dog」和「Cat」標籤，則只會傳回以 Dog 和/或 Cat 標記的影像

GET {Endpoint}/customvision/v3.3/training/projects/{projectId}/iterations/{iterationId}/performance/images

含選擇性參數:

GET {Endpoint}/customvision/v3.3/training/projects/{projectId}/iterations/{iterationId}/performance/images?tagIds={tagIds}&orderBy={orderBy}&take={take}&skip={skip}

URI 參數

名稱	位於	必要	類型	Description
Endpoint	path	True	string	支援的認知服務端點。
iterationId	path	True	string (uuid)	反覆項目標識碼。默認為工作區。
projectId	path	True	string (uuid)	項目標識碼。
orderBy	query		string	排序。預設為最新。
skip	query		integer (int32)	開始映像批次之前要略過的映射數目。預設值為 0。
tagIds	query		string[]	用來篩選影像的標記標識碼清單。當 Null 時，預設為所有標記的影像。限制為 20。
take	query		integer (int32) minimum: 0 maximum: 256	要傳回的影像數目上限。默認值為 50，限制為 256。

要求標頭

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

回應

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

名稱

類型

Description

200 OK

ImagePerformance[]

還行

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

範例要求

HTTP

GET https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects/bc3f7dad-5544-468c-8573-3ef04d55463e/iterations/b7b9d99c-a2c6-4658-9900-a98d2ff5bc66/performance/images?tagIds=65c1de9c-3ee9-4b46-941f-66199b64d155&orderBy=Newest

範例回覆

狀態碼:: 200

[
  {
    "id": "dfd2d346-3ed5-4e1e-857d-af4e32cec042",
    "created": "2018-01-31T20:18:26Z",
    "predictions": [
      {
        "tagId": "b5f7e6a2-a481-49a6-afec-a7cef1af3544",
        "tagName": "Tag 1",
        "probability": 1,
        "boundingBox": {
          "left": 0.25,
          "top": 0.25,
          "width": 0.25,
          "height": 0.25
        }
      }
    ],
    "width": 600,
    "height": 1600,
    "imageUri": "<image uri>",
    "thumbnailUri": "<thumbnail uri>",
    "tags": [],
    "regions": []
  }
]

定義

名稱	Description
BoundingBox	定義影像區域的周框方塊。
CustomVisionError
CustomVisionErrorCodes	錯誤碼。
ImagePerformance	影像效能模型。
ImageRegion
ImageTag
Prediction	預測結果。
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

ImagePerformance

Object

影像效能模型。

名稱	類型	Description
created	string (date-time)
height	integer (int32)
id	string (uuid)
imageUri	string
predictions	Prediction[]	預測結果。
regions	ImageRegion[]
tags	ImageTag[]
thumbnailUri	string
width	integer (int32)

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

Prediction

Object

預測結果。

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

TagType

列舉型別

預測標記的類型。

值	Description
GeneralProduct
Negative
Regular

共用方式為

Iterations - List Performance Images

URI 參數

要求標頭

回應

安全性

Training-Key

範例

Successful GetImagePerformances request

範例要求

範例回覆

定義

BoundingBox

CustomVisionError

CustomVisionErrorCodes

ImagePerformance

ImageRegion

ImageTag

Prediction

TagType

其他資源