Get Image Performances - Get Image Performances

Получение изображения с прогнозом для заданной итерации проекта.
Этот 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

Name In Required Type Description
Endpoint
path True
  • string

Поддерживаемые конечные точки Cognitive Services.

iterationId
path True
  • string
uuid

Идентификатор итерации. По умолчанию используется рабочая область.

projectId
path True
  • string
uuid

Идентификатор проекта.

orderBy
query
  • string

Порядок. По умолчанию используется самая новая версия.

skip
query
  • integer
int32

Количество изображений, которые необходимо пропустить перед началом пакета образов. Значение по умолчанию — 0.

tagIds
query
  • array

Список идентификаторов тегов для фильтрации изображений. По умолчанию для всех помеченных изображений по умолчанию используется значение NULL. Ограничено до 20.

take
query
  • integer
int32

Максимальное количество возвращаемых изображений. Значение по умолчанию — 50, не более 256.

Заголовок запроса

Name Required Type Description
Training-Key True
  • string

Ответы

Name Type Description
200 OK

ОК

Media Types: "application/json", "application/xml", "text/xml"

Other Status Codes

Сообщение об ошибке

Media Types: "application/json", "application/xml", "text/xml"

Безопасность

Training-Key

Type: apiKey
In: header

Примеры

Successful GetImagePerformances request

Sample Request

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=&orderBy=Newest

Sample Response

[
  {
    "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": []
  }
]

Определения

BoundingBox

Ограничивающий прямоугольник, определяющий область изображения.

CustomVisionError
CustomVisionErrorCodes

Код ошибки.

ImagePerformance

Модель производительности изображений.

ImageRegion
ImageTag
Prediction

Результат прогнозирования.

TagType

Тип прогнозируемого тега.

BoundingBox

Ограничивающий прямоугольник, определяющий область изображения.

Name Type Description
height
  • number

Высота.

left
  • number

Координата левой границы.

top
  • number

Координата верхней границы.

width
  • number

Ширина.

CustomVisionError

Name Type Description
code

Код ошибки.

message
  • string

Сообщение, объясняющее ошибку, сообщаемую службой.

CustomVisionErrorCodes

Код ошибки.

Name Type 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

ImagePerformance

Модель производительности изображений.

Name Type Description
created
  • string
height
  • integer
id
  • string
imageUri
  • string
predictions

Результат прогнозирования.

regions
tags
thumbnailUri
  • string
width
  • integer

ImageRegion

Name Type Description
created
  • string
height
  • number

Высота.

left
  • number

Координата левой границы.

regionId
  • string
tagId
  • string

Идентификатор тега, связанного с этим регионом.

tagName
  • string
top
  • number

Координата верхней границы.

width
  • number

Ширина.

ImageTag

Name Type Description
created
  • string
tagId
  • string
tagName
  • string

Prediction

Результат прогнозирования.

Name Type Description
boundingBox

Ограничивающий прямоугольник прогноза.

probability
  • number

Вероятность тега.

tagId
  • string

Идентификатор прогнозируемого тега.

tagName
  • string

Имя прогнозируемого тега.

tagType

Тип прогнозируемого тега.

TagType

Тип прогнозируемого тега.

Name Type Description
GeneralProduct
  • string
Negative
  • string
Regular
  • string