Text Operations - Detect Text Protected Material

Tjänst:

Azure AI Services

API-version:

2024-09-01

Identifiera skyddat material för text
Ett synkront API för att identifiera skyddat material i den angivna texten.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://.cognitiveservices.azure.com).
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
text	True	string	Texten som ska analyseras, som kan innehålla skyddat material. Tecknen räknas i Unicode-kodpunkter.

Svar

Name	Typ	Description
200 OK	DetectTextProtectedMaterialResult	Begäran har slutförts.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: application
Token-webbadress: https://login.microsoftonline.com/common/oauth2/v2.0/token

Omfattningar

Name	Description
https://cognitiveservices.azure.com/.default

Exempel

Detect Protected Material for Text

Exempelbegäran

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

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
Azure.Core.Foundations.Error	Felobjektet.
Azure.Core.Foundations.ErrorResponse	Ett svar som innehåller felinformation.
Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
DetectTextProtectedMaterialOptions	Begäran om identifiering av potentiellt skyddat material som finns i den angivna texten.
DetectTextProtectedMaterialResult	De kombinerade identifieringsresultaten av potentiellt skyddat material.
TextProtectedMaterialAnalysisResult	Det enskilda identifieringsresultatet av potentiellt skyddat material.

Azure.Core.Foundations.Error

Objekt

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	Azure.Core.Foundations.Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

Azure.Core.Foundations.ErrorResponse

Objekt

Ett svar som innehåller felinformation.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Felobjektet.

Azure.Core.Foundations.InnerError

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	Azure.Core.Foundations.InnerError	Inre fel.

DetectTextProtectedMaterialOptions

Objekt

Begäran om identifiering av potentiellt skyddat material som finns i den angivna texten.

Name	Typ	Description
text	string	Texten som ska analyseras, som kan innehålla skyddat material. Tecknen räknas i Unicode-kodpunkter.

DetectTextProtectedMaterialResult

Objekt

De kombinerade identifieringsresultaten av potentiellt skyddat material.

Name	Typ	Description
protectedMaterialAnalysis	TextProtectedMaterialAnalysisResult	Analysresultat för den angivna texten.

TextProtectedMaterialAnalysisResult

Objekt

Det enskilda identifieringsresultatet av potentiellt skyddat material.

Name	Typ	Description
detected	boolean	Om potentiellt skyddat material identifieras eller inte.