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 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string	지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름, 예: https://.cognitiveservices.azure.com).
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

요청 본문

Name	필수	형식	Description
text	True	string	분석할 텍스트로, 보호된 자료가 포함될 수 있습니다. 문자는 유니코드 코드 포인트로 계산됩니다.

응답

Name	형식	Description
200 OK	DetectTextProtectedMaterialResult	요청이 성공했습니다.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	예기치 않은 오류 응답입니다. 헤더 x-ms-error-code: string

보안

Ocp-Apim-Subscription-Key

형식: apiKey
In(다음 안에): header

OAuth2Auth

형식: oauth2
Flow: application
토큰 URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

범위

Name	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
  }
}

정의

Name	Description
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

오류 개체입니다.

Name	형식	Description
code	string	서버에서 정의한 오류 코드 집합 중 하나입니다.
details	Azure.Core.Foundations.Error[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror	Azure.Core.Foundations.InnerError	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.
target	string	오류의 대상입니다.

Azure.Core.Foundations.ErrorResponse

오류 세부 정보가 포함된 응답입니다.

Name	형식	Description
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.

Name	형식	Description
code	string	서버에서 정의한 오류 코드 집합 중 하나입니다.
innererror	Azure.Core.Foundations.InnerError	내부 오류입니다.

DetectTextProtectedMaterialOptions

지정된 텍스트에 있는 잠재적인 보호된 자료 검색 요청입니다.

Name	형식	Description
text	string	분석할 텍스트로, 보호된 자료가 포함될 수 있습니다. 문자는 유니코드 코드 포인트로 계산됩니다.

DetectTextProtectedMaterialResult

잠재적인 보호된 재료의 결합된 검색 결과입니다.

Name	형식	Description
protectedMaterialAnalysis	TextProtectedMaterialAnalysisResult	지정된 텍스트에 대한 분석 결과입니다.

TextProtectedMaterialAnalysisResult

잠재적인 보호된 재료의 개별 검색 결과입니다.

Name	형식	Description
detected	boolean	잠재적인 보호된 물질이 검색되는지 여부입니다.