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

Text Operations - Analyze Text

服务:: Azure AI Services

API 版本:: 2024-09-01

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

POST {endpoint}/contentsafety/text: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 版本。

请求正文

名称	必需	类型	说明
text	True	string maxLength: 10000	要分析的文本。在一个请求的文本中，我们最多支持 10k 个 Unicode 字符（Unicode 码位）。
blocklistNames		string[]	阻止列表的名称。
categories		TextCategory[]	将分析类别。如果未分配这些类别，将返回类别的默认分析结果集。
haltOnBlocklistHit		boolean	如果设置为 true，则不会在点击阻止列表的情况下进一步分析有害内容。设置为 false 时，将执行对有害内容的所有分析，无论是否命中阻止列表。
outputType		AnalyzeTextOutputType	这指的是文本分析输出的类型。如果未分配任何值，则默认值将为“FourSeverityLevels”。

响应

名称	类型	说明
200 OK	AnalyzeTextResult	请求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	意外的错误响应。标头 x-ms-error-code: string

名称

类型

说明

200 OK

AnalyzeTextResult

请求已成功。

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 Text

示例请求

HTTP

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

{
  "text": "This is text example"
}

示例响应

状态代码:: 200

{
  "blocklistsMatch": [],
  "categoriesAnalysis": [
    {
      "category": "Hate",
      "severity": 0
    },
    {
      "category": "SelfHarm",
      "severity": 0
    },
    {
      "category": "Sexual",
      "severity": 0
    },
    {
      "category": "Violence",
      "severity": 0
    }
  ]
}

定义

名称	说明
AnalyzeTextOptions	文本分析请求。
AnalyzeTextOutputType	这指的是文本分析输出的类型。如果未分配任何值，则默认值将为“FourSeverityLevels”。
AnalyzeTextResult	文本分析响应。
Azure.Core.Foundations.Error	错误对象。
Azure.Core.Foundations.ErrorResponse	包含错误详细信息的响应。
Azure.Core.Foundations.InnerError	包含有关错误的更具体信息的对象。根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。
TextBlocklistMatch	阻止列表匹配的结果。
TextCategoriesAnalysis	文本分析结果。
TextCategory	文本内容分析中支持的危害类别。

AnalyzeTextOptions

Object

文本分析请求。

名称	类型	默认值	说明
blocklistNames	string[]		阻止列表的名称。
categories	TextCategory[]		将分析类别。如果未分配这些类别，将返回类别的默认分析结果集。
haltOnBlocklistHit	boolean		如果设置为 true，则不会在点击阻止列表的情况下进一步分析有害内容。设置为 false 时，将执行对有害内容的所有分析，无论是否命中阻止列表。
outputType	AnalyzeTextOutputType	FourSeverityLevels	这指的是文本分析输出的类型。如果未分配任何值，则默认值将为“FourSeverityLevels”。
text	string maxLength: 10000		要分析的文本。在一个请求的文本中，我们最多支持 10k 个 Unicode 字符（Unicode 码位）。

AnalyzeTextOutputType

枚举

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

值	说明
FourSeverityLevels	四个级别的输出严重性，该值可以是 0,2,4,6。
EightSeverityLevels	八个级别的输出严重性，该值可以是 0,1,2,3,4,5,6,7。

AnalyzeTextResult

Object

文本分析响应。

名称	类型	说明
blocklistsMatch	TextBlocklistMatch[]	阻止列表匹配详细信息。
categoriesAnalysis	TextCategoriesAnalysis[]	类别的分析结果。

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	内部错误。

TextBlocklistMatch

Object

阻止列表匹配的结果。

名称	类型	说明
blocklistItemId	string maxLength: 64	匹配项的 ID。
blocklistItemText	string maxLength: 128	匹配项的内容。
blocklistName	string maxLength: 64	匹配的阻止列表的名称。

TextCategoriesAnalysis

Object

文本分析结果。

名称	类型	说明
category	TextCategory	文本分析类别。
severity	integer (int32)	该值随输入内容的严重性而增加。此字段的值由请求中指定的输出类型确定。输出类型可以是“FourSeverityLevels”或“八维级别”，输出值可以是 0、2、4、6 或 0、1、2、3、4、5、6 或 7。

TextCategory

枚举

文本内容分析中支持的危害类别。

值	说明
Hate	文本 - 仇恨的危害类别。
SelfHarm	文本 - SelfHarm 的危害类别。
Sexual	文本 - 性危害类别。
Violence	文本 - 暴力的危害类别。

通过

Text Operations - Analyze Text

URI 参数

请求正文

响应

安全性

Ocp-Apim-Subscription-Key

OAuth2Auth

作用域

示例

Analyze Text

示例请求

示例响应

定义

AnalyzeTextOptions

AnalyzeTextOutputType

AnalyzeTextResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

TextBlocklistMatch

TextCategoriesAnalysis

TextCategory