Text Operations - Detect Text Protected Material

Service:

Azure AI Services

Version d'API:

2024-09-01

Détecter le matériel protégé pour le texte
API synchrone permettant de détecter des éléments protégés dans le texte donné.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://.cognitiveservices.azure.com).
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
text	True	string	Texte à analyser, qui peut contenir des éléments protégés. Les caractères sont comptabilisés dans les points de code Unicode.

Réponses

Nom	Type	Description
200 OK	DetectTextProtectedMaterialResult	La demande a réussi.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: application
URL du jeton: https://login.microsoftonline.com/common/oauth2/v2.0/token

Étendues

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

Exemples

Detect Protected Material for Text

Exemple de requête

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

Exemple de réponse

Code d’état:

200

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

Définitions

Nom	Description
Azure.Core.Foundations.Error	Objet d’erreur.
Azure.Core.Foundations.ErrorResponse	Réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
DetectTextProtectedMaterialOptions	Demande de détection de matériel protégé potentiel présent dans le texte donné.
DetectTextProtectedMaterialResult	Résultats combinés de la détection de matériaux protégés potentiels.
TextProtectedMaterialAnalysisResult	Résultat de détection individuel d’un matériau protégé potentiel.

Azure.Core.Foundations.Error

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Réponse contenant les détails de l’erreur.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Objet d’erreur.

Azure.Core.Foundations.InnerError

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur interne.

DetectTextProtectedMaterialOptions

Demande de détection de matériel protégé potentiel présent dans le texte donné.

Nom	Type	Description
text	string	Texte à analyser, qui peut contenir des éléments protégés. Les caractères sont comptabilisés dans les points de code Unicode.

DetectTextProtectedMaterialResult

Résultats combinés de la détection de matériaux protégés potentiels.

Nom	Type	Description
protectedMaterialAnalysis	TextProtectedMaterialAnalysisResult	Résultat d’analyse pour le texte donné.

TextProtectedMaterialAnalysisResult

Résultat de détection individuel d’un matériau protégé potentiel.

Nom	Type	Description
detected	boolean	Indique si du matériel protégé potentiel est détecté ou non.