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	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など: 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
Token URL (トークン 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 One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
DetectTextProtectedMaterialOptions	特定のテキストに存在する潜在的な保護された素材を検出する要求。
DetectTextProtectedMaterialResult	潜在的な保護材料の結合された検出結果。
TextProtectedMaterialAnalysisResult	潜在的な保護材料の個々の検出結果。

Azure.Core.Foundations.Error

エラー オブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラー コードの 1 つ。
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 One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

名前	型	説明
code	string	サーバー定義の一連のエラー コードの 1 つ。
innererror	Azure.Core.Foundations.InnerError	内部エラー。

DetectTextProtectedMaterialOptions

特定のテキストに存在する潜在的な保護された素材を検出する要求。

名前	型	説明
text	string	分析するテキスト。保護された素材が含まれている可能性があります。 文字は Unicode コード ポイントでカウントされます。

DetectTextProtectedMaterialResult

潜在的な保護材料の結合された検出結果。

名前	型	説明
protectedMaterialAnalysis	TextProtectedMaterialAnalysisResult	指定されたテキストの分析結果。

TextProtectedMaterialAnalysisResult

潜在的な保護材料の個々の検出結果。

名前	型	説明
detected	boolean	潜在的な保護材料が検出されたかどうか。