Text Operations - Analyze Text

Référence

Service:: Azure AI Services

Version d'API:: 2023-10-01

Analyser du texte
API synchrone pour l’analyse du contenu texte potentiellement dangereux. Actuellement, il prend en charge quatre catégories : Haine, SelfHarm, Sexual et Violence.

POST {endpoint}/contentsafety/text:analyze?api-version=2023-10-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. Nous prenons en charge un maximum de 10 000 caractères Unicode (points de code Unicode) dans le texte d’une requête.
blocklistNames		string[]	Noms des listes de blocs.
categories		TextCategory[]	Les catégories seront analysées. S’ils ne sont pas attribués, un ensemble par défaut de résultats d’analyse pour les catégories est retourné.
haltOnBlocklistHit		boolean	Lorsque la valeur est true, des analyses supplémentaires du contenu dangereux ne sont pas effectuées dans les cas où les listes de blocage sont atteintes. Lorsque la valeur est false, toutes les analyses de contenu dangereux sont effectuées, que les listes de blocage soient atteintes ou non.
outputType		AnalyzeTextOutputType	Cela fait référence au type de sortie d’analyse de texte. Si aucune valeur n’est affectée, la valeur par défaut est « FourSeverityLevels ».

Réponses

Nom	Type	Description
200 OK	AnalyzeTextResult	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

Nom

Type

Description

200 OK

AnalyzeTextResult

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

Analyze Text

Exemple de requête

HTTP

POST {endpoint}/contentsafety/text:analyze?api-version=2023-10-01

{
  "text": "This is text example"
}

Exemple de réponse

Code d’état:: 200

{
  "blocklistsMatch": [],
  "categoriesAnalysis": [
    {
      "category": "Hate",
      "severity": 0
    },
    {
      "category": "SelfHarm",
      "severity": 0
    },
    {
      "category": "Sexual",
      "severity": 0
    },
    {
      "category": "Violence",
      "severity": 0
    }
  ]
}

Définitions

Nom	Description
AnalyzeTextOptions	Demande d’analyse de texte.
AnalyzeTextOutputType	Cela fait référence au type de sortie d’analyse de texte. Si aucune valeur n’est affectée, la valeur par défaut est « FourSeverityLevels ».
AnalyzeTextResult	Réponse d’analyse de texte.
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.
TextBlocklistMatch	Résultat de la correspondance de liste de blocs.
TextCategoriesAnalysis	Résultat de l’analyse de texte.
TextCategory	Catégorie de préjudice prise en charge dans l’analyse du contenu texte.

AnalyzeTextOptions

Demande d’analyse de texte.

Nom	Type	Valeur par défaut	Description
blocklistNames	string[]		Noms des listes de blocs.
categories	TextCategory[]		Les catégories seront analysées. S’ils ne sont pas attribués, un ensemble par défaut de résultats d’analyse pour les catégories est retourné.
haltOnBlocklistHit	boolean		Lorsque la valeur est true, des analyses supplémentaires du contenu dangereux ne sont pas effectuées dans les cas où les listes de blocage sont atteintes. Lorsque la valeur est false, toutes les analyses de contenu dangereux sont effectuées, que les listes de blocage soient atteintes ou non.
outputType	AnalyzeTextOutputType	FourSeverityLevels	Cela fait référence au type de sortie d’analyse de texte. Si aucune valeur n’est affectée, la valeur par défaut est « FourSeverityLevels ».
text	string		Texte à analyser. Nous prenons en charge un maximum de 10 000 caractères Unicode (points de code Unicode) dans le texte d’une requête.

AnalyzeTextOutputType

Cela fait référence au type de sortie d’analyse de texte. Si aucune valeur n’est affectée, la valeur par défaut est « FourSeverityLevels ».

Nom	Type	Description
EightSeverityLevels	string	Gravités de sortie dans huit niveaux, la valeur peut être de 0,1,2,3,4,5,6,7.
FourSeverityLevels	string	Gravités de sortie dans quatre niveaux, la valeur peut être de 0,2,4,6.

AnalyzeTextResult

Réponse d’analyse de texte.

Nom	Type	Description
blocklistsMatch	TextBlocklistMatch[]	Détails de la correspondance de la liste de blocs.
categoriesAnalysis	TextCategoriesAnalysis[]	Résultat d’analyse pour les catégories.

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.

TextBlocklistMatch

Résultat de la correspondance de liste de blocs.

Nom	Type	Description
blocklistItemId	string	ID de l’élément correspondant.
blocklistItemText	string	Contenu de l’élément correspondant.
blocklistName	string	Nom de la liste de blocs correspondante.

TextCategoriesAnalysis

Résultat de l’analyse de texte.

Nom	Type	Description
category	TextCategory	Catégorie d’analyse de texte.
severity	integer	La valeur augmente avec la gravité du contenu d’entrée. La valeur de ce champ est déterminée par le type de sortie spécifié dans la requête. Le type de sortie peut être « FourSeverityLevels » ou « EightSeverity Levels », et la valeur de sortie peut être 0, 2, 4, 6 ou 0, 1, 2, 3, 4, 5, 6 ou 7.

TextCategory

Catégorie de préjudice prise en charge dans l’analyse du contenu texte.

Nom	Type	Description
Hate	string	Catégorie de préjudice pour Texte - Haine.
SelfHarm	string	Catégorie de préjudice pour Text - SelfHarm.
Sexual	string	Catégorie de préjudice pour Texte - Sexuel.
Violence	string	Catégorie de préjudice pour Texte - Violence.

Partager via

Text Operations - Analyze Text

Paramètres URI

Corps de la demande

Réponses

Sécurité

Ocp-Apim-Subscription-Key

OAuth2Auth

Étendues

Exemples

Analyze Text

Exemple de requête

Exemple de réponse

Définitions

AnalyzeTextOptions

AnalyzeTextOutputType

AnalyzeTextResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

TextBlocklistMatch

TextCategoriesAnalysis

TextCategory

Ressources supplémentaires