你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Get Tagged Images - Get Tagged Images

获取给定项目迭代的标记图像。
此 API 支持批处理和范围选择。 默认情况下,它只返回与图像匹配的前 50 个图像。 使用 {take} 和 {skip} 参数控制给定批处理中要返回的图像数。 筛选依据为某个字词和/或关系。 例如,如果提供的标记 ID 用于“Dog”和“Cat”标记,则只会返回带有 Dog 和/或 Cat 标记的图像

GET {Endpoint}/customvision/v3.4-preview/training/projects/{projectId}/images/tagged
GET {Endpoint}/customvision/v3.4-preview/training/projects/{projectId}/images/tagged?iterationId={iterationId}&tagIds={tagIds}&orderBy={orderBy}&take={take}&skip={skip}

URI 参数

Name In Required Type Description
Endpoint
path True
  • string

支持的认知服务终结点。

projectId
path True
  • string
uuid

项目 ID。

iterationId
query
  • string
uuid

迭代 ID。默认为工作区。

orderBy
query
  • string

排序。 默认为最新。

skip
query
  • integer
int32

在开始映像批处理之前要跳过的图像数。 默认值为 0。

tagIds
query
  • array

用于筛选图像的标记 ID 列表。 如果为 null,则默认为所有标记的图像。 限制为 20。

take
query
  • integer
int32

要返回的最大图像数。 默认值为 50,限制为 256。

请求头

Name Required Type Description
Training-Key True
  • string

响应

Name Type Description
200 OK

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

Sample Request

GET https://westus.api.cognitive.microsoft.com/customvision/v3.4-preview/training/projects/bc3f7dad-5544-468c-8573-3ef04d55463e/images/tagged?iterationId=cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12

Sample Response

[]

定义

CustomVisionError
CustomVisionErrorCodes

错误代码。

Image

要作为 JSON 发送的图像模型。

ImageRegion
ImageTag

CustomVisionError

Name Type Description
code

错误代码。

message
  • string

说明服务报告的错误的消息。

CustomVisionErrorCodes

错误代码。

Name Type Description
BadRequest
  • string
BadRequestCannotMigrateProjectWithName
  • string
BadRequestClassificationTrainingValidationFailed
  • string
BadRequestCustomBaseModelArchitectureRetired
  • string
BadRequestCustomBaseModelDomainNotCompatible
  • string
BadRequestCustomBaseModelIterationStatusNotCompleted
  • 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
BadRequestImageAspectRatio
  • 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
BadRequestInvalidUri
  • 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
BadRequestRetiredDomainNotSupportedForTraining
  • 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
ErrorServerTimeOut
  • 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

Image

要作为 JSON 发送的图像模型。

Name Type Description
created
  • string

创建映像的日期。

height
  • integer

图像的高度。

id
  • string

图像的 ID。

metadata
  • object

与此映像关联的元数据。

originalImageUri
  • string

原始上传图像的 URI。 如果启用了 VNET 功能,则会是用于 GetArtifact 的相对路径,否则这是资源的绝对 URI。

regions

与此映像关联的区域。

resizedImageUri
  • string

用于训练的 (调整大小) 图像的 URI。 如果启用了 VNET 功能,则会是用于 GetArtifact 的相对路径,否则这是资源的绝对 URI。

tags

与此映像关联的标记。

thumbnailUri
  • string

原始图像缩略图的 URI。 如果启用了 VNET 功能,则会是用于 GetArtifact 的相对路径,否则这是资源的绝对 URI。

width
  • integer

图像的宽度。

ImageRegion

Name Type Description
created
  • string
height
  • number

高度。

left
  • number

左边界的坐标。

regionId
  • string
tagId
  • string

与此区域关联的标记的 ID。

tagName
  • string
top
  • number

顶边界的坐标。

width
  • number

宽度。

ImageTag

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