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 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	支援的認知服務端點（通訊協定和主機名，例如：https://.cognitiveservices.azure.com).
api-version	query	True	string	要用於這項作業的 API 版本。

要求本文

名稱	必要	類型	Description
text	True	string	要分析的文字，其中可能包含受保護的數據。 字元會在 Unicode 字碼點中計算。

回應

名稱	類型	Description
200 OK	DetectTextProtectedMaterialResult	要求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	未預期的錯誤回應。 標題 x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

OAuth2Auth

類型: oauth2
Flow: application
權杖 URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

範圍

名稱	Description
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
  }
}

定義

名稱	Description
Azure.Core.Foundations.Error	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

error 物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	Azure.Core.Foundations.Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	Azure.Core.Foundations.InnerError	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

Azure.Core.Foundations.ErrorResponse

包含錯誤詳細數據的回應。

名稱	類型	Description
error	Azure.Core.Foundations.Error	error 物件。

Azure.Core.Foundations.InnerError

物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
innererror	Azure.Core.Foundations.InnerError	內部錯誤。

DetectTextProtectedMaterialOptions

偵測指定文字中存在潛在受保護數據的要求。

名稱	類型	Description
text	string	要分析的文字，其中可能包含受保護的數據。 字元會在 Unicode 字碼點中計算。

DetectTextProtectedMaterialResult

潛在受保護材料的組合偵測結果。

名稱	類型	Description
protectedMaterialAnalysis	TextProtectedMaterialAnalysisResult	指定文字的分析結果。

TextProtectedMaterialAnalysisResult

潛在受保護數據的個別偵測結果。

名稱	類型	Description
detected	boolean	是否偵測到潛在的受保護數據。