Tag Image - Tag Image

服务:

Azure AI Services

API 版本:

3.2

此作将生成与提供的图像内容相关的字词或标记列表。 计算机视觉 API 可以根据图像中找到的对象、生物、风景或作返回标记。 与类别不同，标记不是根据分层分类系统组织的，而是对应于图像内容。 标记可能包含提示以避免歧义或提供上下文，例如标记“ascomycete”可能附带提示“fungus”。 支持两种输入方法 - （1） 上传图像或指定图像 URL（2）。 成功响应将以 JSON 形式返回。 如果请求失败，响应将包含错误代码和一条消息，以帮助了解出了什么问题。

POST {Endpoint}/vision/v3.2/tag

具有可选参数:

POST {Endpoint}/vision/v3.2/tag?language={language}&model-version={model-version}

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string	支持的认知服务终结点。
language	query		string	输出生成所需的语言。 如果未指定此参数，则默认值为“en”。 有关支持的语言列表，请参阅 https://aka.ms/cv-languages。
model-version	query		string pattern: ^(latest|\d{4}-\d{2}-\d{2})(-preview)?$	用于指定 AI 模型的版本的可选参数。 接受的值为：“latest”、“2021-04-01”、“2021-05-01”。 默认值为“latest”。

请求头

名称	必需	类型	说明
Ocp-Apim-Subscription-Key	True	string

请求正文

名称	必需	类型	说明
url	True	string	图像的可公开访问 URL。

响应

名称	类型	说明
200 OK	TagResult	图像标记对象。
Other Status Codes	ComputerVisionErrorResponse	错误响应。

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

示例

Successful TagImage request

示例请求

HTTP

POST https://westus.api.cognitive.microsoft.com/vision/v3.2/tag


{
  "url": "{url}"
}

示例响应

状态代码:

200

{
  "tags": [
    {
      "name": "grass",
      "confidence": 0.9999997615814209
    },
    {
      "name": "outdoor",
      "confidence": 0.9999706745147705
    },
    {
      "name": "sky",
      "confidence": 0.9992897510528564
    },
    {
      "name": "building",
      "confidence": 0.9964632391929626
    },
    {
      "name": "house",
      "confidence": 0.9927980303764343
    },
    {
      "name": "lawn",
      "confidence": 0.8226802945137024
    },
    {
      "name": "green",
      "confidence": 0.6412225365638733
    },
    {
      "name": "residential",
      "confidence": 0.31403225660324097
    }
  ],
  "requestId": "1ad0e45e-b7b4-4be3-8042-53be96103337",
  "metadata": {
    "width": 400,
    "height": 400,
    "format": "Jpeg"
  },
  "modelVersion": "2021-04-01"
}

定义

名称	说明
ComputerVisionError	API 请求错误。
ComputerVisionErrorCodes	错误代码。
ComputerVisionErrorResponse	API 错误响应。
ComputerVisionInnerError	有关 API 请求错误的详细信息。
ComputerVisionInnerErrorCodeValue	错误代码。
ImageMetadata	图像元数据。
ImageTag	图像中的实体观察以及置信度分数。
ImageUrl
TagResult	图像标记作的结果，包括任何标记和图像元数据。

ComputerVisionError

Object

API 请求错误。

名称	类型	说明
code	ComputerVisionErrorCodes	错误代码。
innererror	ComputerVisionInnerError	内部错误包含更具体的信息。
message	string	说明服务报告的错误的消息。

ComputerVisionErrorCodes

枚举

错误代码。

值	说明
InternalServerError
InvalidArgument
InvalidRequest
ServiceUnavailable

ComputerVisionErrorResponse

Object

API 错误响应。

名称	类型	说明
error	ComputerVisionError	错误内容。

ComputerVisionInnerError

Object

有关 API 请求错误的详细信息。

名称	类型	说明
code	ComputerVisionInnerErrorCodeValue	错误代码。
message	string	错误信息。

ComputerVisionInnerErrorCodeValue

枚举

错误代码。

值	说明
BadArgument
CancelledRequest
DetectFaceError
FailedToProcess
InternalServerError
InvalidDetails
InvalidImageFormat
InvalidImageSize
InvalidImageUrl
InvalidModel
InvalidThumbnailSize
NotSupportedFeature
NotSupportedImage
NotSupportedLanguage
NotSupportedVisualFeature
StorageException
Timeout
Unspecified
UnsupportedMediaType

ImageMetadata

Object

图像元数据。

名称	类型	说明
format	string	图像格式。
height	integer (int32)	图像高度（以像素为单位）。
width	integer (int32)	图像宽度（以像素为单位）。

ImageTag

Object

图像中的实体观察以及置信度分数。

名称	类型	说明
confidence	number (double)	观察到实体的置信度级别。
hint	string	此标记的可选提示/详细信息。
name	string	实体的名称。

ImageUrl

Object

名称	类型	说明
url	string	图像的可公开访问 URL。

TagResult

Object

图像标记作的结果，包括任何标记和图像元数据。

名称	类型	说明
metadata	ImageMetadata	图像元数据。
modelVersion	string pattern: ^(latest|\d{4}-\d{2}-\d{2})(-preview)?$	AI 模型的版本。
requestId	string	REST API 请求的 ID。
tags	ImageTag[]	具有置信度标记的列表。