通过

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

Image Operations - Analyze Image

服务:
Azure AI Services
API 版本:
2024-09-01

分析图像
用于分析潜在有害图像内容的同步 API。 目前，它支持四类：仇恨、自我哈姆、性与暴力。

POST {endpoint}/contentsafety/image:analyze?api-version=2024-09-01

URI 参数

名称 在 必需 类型 说明
endpoint
 path True

string

支持的认知服务终结点（协议和主机名，例如：https://< resource-name.cognitiveservices.azure.com>）。
api-version
 query True

string

minLength: 1

用于此操作的 API 版本。

请求正文

名称 必需 类型 说明
image True

ImageData

要分析的图像。
categories

ImageCategory[]

将分析类别。 如果未分配这些类别，将返回类别的默认分析结果集。
outputType

AnalyzeImageOutputType

这指的是图像分析输出的类型。 如果未分配任何值，则默认值将为“FourSeverityLevels”。

响应

名称 类型 说明
200 OK

AnalyzeImageResult

请求已成功。
Other Status Codes

Azure.Core.Foundations.ErrorResponse

意外的错误响应。

标头

x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: application
令牌 URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

作用域

名称 说明
https://cognitiveservices.azure.com/.default

示例

Analyze Image

示例请求

POST {endpoint}/contentsafety/image:analyze?api-version=2024-09-01

{
  "image": {
    "content": "Y29udGVudDE="
  }
}

示例响应

状态代码:
200 
{
  "categoriesAnalysis": [
    {
      "category": "Hate",
      "severity": 0
    },
    {
      "category": "SelfHarm",
      "severity": 0
    },
    {
      "category": "Sexual",
      "severity": 0
    },
    {
      "category": "Violence",
      "severity": 2
    }
  ]
}

定义

名称 说明
AnalyzeImageOptions

图像分析请求。
AnalyzeImageOutputType

这指的是图像分析输出的类型。 如果未分配任何值，则默认值将为“FourSeverityLevels”。
AnalyzeImageResult

图像分析响应。
Azure.Core.Foundations.Error

错误对象。
Azure.Core.Foundations.ErrorResponse

包含错误详细信息的响应。
Azure.Core.Foundations.InnerError

包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。
ImageCategoriesAnalysis

图像分析结果。
ImageCategory

图像内容分析中支持的危害类别。
ImageData

该图像可以是 base64 编码的字节或 Blob URL。 只能选择其中一个选项。 如果两者均已提供，将拒绝请求。 最大图像大小为 2048 x 2048 像素，不应超过 4 MB，最小图像大小为 50 x 50 像素。

AnalyzeImageOptions

Object

图像分析请求。

名称 类型 默认值 说明
categories

ImageCategory[]

将分析类别。 如果未分配这些类别，将返回类别的默认分析结果集。
image

ImageData

要分析的图像。
outputType

AnalyzeImageOutputType

FourSeverityLevels

这指的是图像分析输出的类型。 如果未分配任何值，则默认值将为“FourSeverityLevels”。

AnalyzeImageOutputType

枚举

这指的是图像分析输出的类型。 如果未分配任何值，则默认值将为“FourSeverityLevels”。

值 说明
FourSeverityLevels

四个级别的输出严重性，该值可以是 0,2,4,6。

AnalyzeImageResult

Object

图像分析响应。

名称 类型 说明
categoriesAnalysis

ImageCategoriesAnalysis[]

类别的分析结果。

Azure.Core.Foundations.Error

Object

错误对象。

名称 类型 说明
code

string

服务器定义的错误代码集之一。
details

Azure.Core.Foundations.Error[]

导致此报告错误的特定错误的详细信息数组。
innererror

Azure.Core.Foundations.InnerError

包含与当前对象有关错误的更具体信息的对象。
message

string

错误的人工可读表示形式。
target

string

错误的目标。

Azure.Core.Foundations.ErrorResponse

Object

包含错误详细信息的响应。

名称 类型 说明
error

Azure.Core.Foundations.Error

错误对象。

Azure.Core.Foundations.InnerError

Object

包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。

名称 类型 说明
code

string

服务器定义的错误代码集之一。
innererror

Azure.Core.Foundations.InnerError

内部错误。

ImageCategoriesAnalysis

Object

图像分析结果。

名称 类型 说明
category

ImageCategory

图像分析类别。
severity

integer (int32)

该值随输入内容的严重性而增加。 此字段的值由请求中指定的输出类型确定。 输出类型可以是“FourSeverityLevels”，输出值可以是 0、2、4、6。

ImageCategory

枚举

图像内容分析中支持的危害类别。

值 说明
Hate

图像 - 仇恨的危害类别。
SelfHarm

图像 - SelfHarm 的危害类别。
Sexual

图像 - 性伤害类别。
Violence

图像 - 暴力的危害类别。

ImageData

Object

该图像可以是 base64 编码的字节或 Blob URL。 只能选择其中一个选项。 如果两者均已提供，将拒绝请求。 最大图像大小为 2048 x 2048 像素，不应超过 4 MB，最小图像大小为 50 x 50 像素。

名称 类型 说明
blobUrl

string (uri)

图像的 blob URL。
content

string (byte)

图像的 Base64 编码。