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

Text Operations - Detect Text Protected Material

服务:

Azure AI Services

API 版本:

2024-09-01

检测文本的受保护材料
用于检测给定文本中受保护材料的同步 API。

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

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	支持的认知服务终结点（协议和主机名，例如：https://.cognitiveservices.azure.com).
api-version	query	True	string	用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
text	True	string	要分析的文本，可能包含受保护的材料。 字符将在 Unicode 码位中计数。

响应

名称	类型	说明
200 OK	DetectTextProtectedMaterialResult	请求已成功。
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

示例

Detect Protected Material for Text

示例请求

HTTP

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

{
  "text": "to everyone, the best things in life are free. the stars belong to everyone, they gleam there for you and me. the flowers in spring, the robins that sing, the sunbeams that shine"
}

示例响应

状态代码:

200

{
  "protectedMaterialAnalysis": {
    "detected": true
  }
}

定义

名称	说明
Azure.Core.Foundations.Error	错误对象。
Azure.Core.Foundations.ErrorResponse	包含错误详细信息的响应。
Azure.Core.Foundations.InnerError	包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
DetectTextProtectedMaterialOptions	检测给定文本中存在的潜在受保护材料的请求。
DetectTextProtectedMaterialResult	潜在受保护材料的组合检测结果。
TextProtectedMaterialAnalysisResult	潜在受保护材料的各个检测结果。

Azure.Core.Foundations.Error

错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	Azure.Core.Foundations.Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	Azure.Core.Foundations.InnerError	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

Azure.Core.Foundations.ErrorResponse

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

名称	类型	说明
error	Azure.Core.Foundations.Error	错误对象。

Azure.Core.Foundations.InnerError

包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
innererror	Azure.Core.Foundations.InnerError	内部错误。

DetectTextProtectedMaterialOptions

检测给定文本中存在的潜在受保护材料的请求。

名称	类型	说明
text	string	要分析的文本，可能包含受保护的材料。 字符将在 Unicode 码位中计数。

DetectTextProtectedMaterialResult

潜在受保护材料的组合检测结果。

名称	类型	说明
protectedMaterialAnalysis	TextProtectedMaterialAnalysisResult	给定文本的分析结果。

TextProtectedMaterialAnalysisResult

潜在受保护材料的各个检测结果。

名称	类型	说明
detected	boolean	是否检测到潜在的受保护材料。