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

Get Images - Get Images

参考

服务:: Azure AI Services

API 版本:: 3.4-preview

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

GET {Endpoint}/customvision/v3.4-preview/training/projects/{projectId}/images

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string	支持的认知服务终结点。
projectId	path	True	string (uuid)	项目 ID。
$filter	query		string	一个表达式，用于根据图像元数据筛选图像。只有表达式计算结果为 true 的图像才会包含在响应中。表达式支持 eq （Equal）、ne （不相等）和（Logical and），或（Logical or）运算符。下面是一个示例，metadata=key1 eq 'value1' 和 key2 ne 'value2'。
iterationId	query		string (uuid)	迭代 ID。默认为工作区。
orderBy	query		string	排序。默认为最新。
skip	query		integer (int32)	在开始映像批处理之前要跳过的图像数。默认值为 0。
taggingStatus	query		string	标记状态筛选器。可以是“All”、“Tagged”或“Untagged”。默认值为“All”。
tagIds	query		string[]	用于筛选图像的标记 ID 的列表。如果为 null，则默认为所有标记的图像。限制为 20。
take	query		integer (int32) minimum: 0 maximum: 256	要返回的最大图像数。默认值为 50，限制为 256。

请求头

名称	必需	类型	说明
Training-Key	True	string

响应

名称	类型	说明
200 OK	Image[]	还行 Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	错误响应 Media Types: "application/json", "application/xml", "text/xml"

名称

类型

说明

200 OK

Image[]

还行

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

示例请求

HTTP

GET https://westus.api.cognitive.microsoft.com/customvision/v3.4-preview/training/projects/bc3f7dad-5544-468c-8573-3ef04d55463e/images

示例响应

状态代码:: 200

[
  {
    "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
    "created": "2017-12-19T15:56:10Z",
    "width": 1095,
    "height": 900,
    "resizedImageUri": "{Resized Image Uri}",
    "originalImageUri": "{Image Uri}",
    "thumbnailUri": "{Thumbnail Uri}",
    "tags": [
      {
        "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
        "created": "2017-12-19T15:56:09Z",
        "tagName": "tag 1"
      }
    ]
  },
  {
    "id": "f1855a92-b873-47e7-b513-f07a667ceda1",
    "created": "2017-12-19T15:56:10Z",
    "width": 900,
    "height": 1531,
    "resizedImageUri": "{Resized Image Uri}",
    "originalImageUri": "{Image Uri}",
    "thumbnailUri": "{Thumbnail Uri}",
    "tags": [
      {
        "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
        "created": "2017-12-19T15:56:09Z",
        "tagName": "tag 1"
      }
    ]
  }
]

定义

名称	说明
CustomVisionError
CustomVisionErrorCodes	错误代码。
Image	要作为 JSON 发送的图像模型。
ImageRegion
ImageTag

CustomVisionError

Object

名称	类型	说明
code	CustomVisionErrorCodes	错误代码。
message	string	说明服务报告的错误的消息。

CustomVisionErrorCodes

枚举

错误代码。

值	说明
BadRequest
BadRequestCannotMigrateProjectWithName
BadRequestClassificationTrainingValidationFailed
BadRequestCustomBaseModelArchitectureRetired
BadRequestCustomBaseModelDomainNotCompatible
BadRequestCustomBaseModelIterationStatusNotCompleted
BadRequestCustomerManagedKeyRevoked
BadRequestDetectionTrainingNotAllowNegativeTag
BadRequestDetectionTrainingValidationFailed
BadRequestDomainNotSupportedForAdvancedTraining
BadRequestExceedIterationPerProjectLimit
BadRequestExceedProjectLimit
BadRequestExceedTagPerImageLimit
BadRequestExceedTagPerProjectLimit
BadRequestExceededBatchSize
BadRequestExceededQuota
BadRequestExportAlreadyInProgress
BadRequestExportPlatformNotSupportedForAdvancedTraining
BadRequestExportValidationFailed
BadRequestExportWhileTraining
BadRequestImageAspectRatio
BadRequestImageBatch
BadRequestImageDimensions
BadRequestImageExceededCount
BadRequestImageFormat
BadRequestImageMetadataKey
BadRequestImageMetadataValue
BadRequestImageRegions
BadRequestImageSizeBytes
BadRequestImageStream
BadRequestImageTags
BadRequestImageUrl
BadRequestInvalid
BadRequestInvalidArtifactUri
BadRequestInvalidEmailAddress
BadRequestInvalidIds
BadRequestInvalidImportToken
BadRequestInvalidPublishName
BadRequestInvalidPublishTarget
BadRequestInvalidUri
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
BadRequestRetiredDomainNotSupportedForTraining
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
ErrorServerTimeOut
ErrorUnknown
ErrorUnknownBaseModel
Forbidden
ForbiddenDRModeEnabled
ForbiddenInvalid
ForbiddenUser
ForbiddenUserDisabled
ForbiddenUserDoesNotExist
ForbiddenUserInsufficientCapability
ForbiddenUserResource
ForbiddenUserSignupAllowanceExceeded
ForbiddenUserSignupDisabled
NoError
NotFound
NotFoundApimSubscription
NotFoundDomain
NotFoundImage
NotFoundInvalid
NotFoundIteration
NotFoundIterationPerformance
NotFoundProject
NotFoundProjectDefaultIteration
NotFoundTag
UnsupportedMediaType

Image

Object

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

名称	类型	说明
created	string (date-time)	创建映像的日期。
height	integer (int32)	图像的高度。
id	string (uuid)	图像的 ID。
metadata	object	与此映像关联的元数据。
originalImageUri	string	原始上传图像的 URI。如果启用了 VNET 功能，则会是用于 GetArtifact 的相对路径，否则这是资源的绝对 URI。
regions	ImageRegion[]	与此映像关联的区域。
resizedImageUri	string	用于训练的（调整大小）图像的 URI。如果启用了 VNET 功能，则会是用于 GetArtifact 的相对路径，否则这是资源的绝对 URI。
tags	ImageTag[]	与此图像关联的标记。
thumbnailUri	string	原始图像缩略图的 URI。如果启用了 VNET 功能，则会是用于 GetArtifact 的相对路径，否则这是资源的绝对 URI。
width	integer (int32)	图像的宽度。

ImageRegion

Object

名称	类型	说明
created	string (date-time)
height	number (float)	高度。
left	number (float)	左边界的坐标。
regionId	string (uuid)
tagId	string (uuid)	与此区域关联的标记的 ID。
tagName	string
top	number (float)	顶边界的坐标。
width	number (float)	宽度。

ImageTag

Object

名称	类型	说明
created	string (date-time)
tagId	string (uuid)
tagName	string

通过

Get Images - Get Images

URI 参数

请求头

响应

安全性

Training-Key

示例

Successful GetImages request

示例请求

示例响应

定义

CustomVisionError

CustomVisionErrorCodes

Image

ImageRegion

ImageTag