Image Operations - Analyze Image

Référence

Service:: Azure AI Services

Version d'API:: 2023-10-01

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

POST {endpoint}/contentsafety/image: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
image	True	ImageData	Image à analyser.
categories		ImageCategory[]	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é.
outputType		AnalyzeImageOutputType	Cela fait référence au type de sortie d’analyse d’image. Si aucune valeur n’est affectée, la valeur par défaut est « FourSeverityLevels ».

Réponses

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

AnalyzeImageResult

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 Image

Exemple de requête

HTTP

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

{
  "image": {
    "content": "Y29udGVudDE="
  }
}

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
AnalyzeImageOptions	Demande d’analyse d’image.
AnalyzeImageOutputType	Cela fait référence au type de sortie d’analyse d’image. Si aucune valeur n’est affectée, la valeur par défaut est « FourSeverityLevels ».
AnalyzeImageResult	Réponse d’analyse d’image.
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.
ImageCategoriesAnalysis	Résultat de l’analyse d’image.
ImageCategory	Catégorie de préjudice prise en charge dans l’analyse du contenu de l’image.
ImageData	L’image peut être encodée en base64 ou une URL d’objet blob. Vous ne pouvez choisir qu’une de ces options. Si les deux sont fournis, la demande sera refusée. La taille maximale de l’image est de 2048 x 2048 pixels et ne doit pas dépasser 4 Mo, tandis que la taille minimale de l’image est de 50 x 50 pixels.

AnalyzeImageOptions

Demande d’analyse d’image.

Nom	Type	Valeur par défaut	Description
categories	ImageCategory[]		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é.
image	ImageData		Image à analyser.
outputType	AnalyzeImageOutputType	FourSeverityLevels	Cela fait référence au type de sortie d’analyse d’image. Si aucune valeur n’est affectée, la valeur par défaut est « FourSeverityLevels ».

AnalyzeImageOutputType

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

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

AnalyzeImageResult

Réponse d’analyse d’image.

Nom	Type	Description
categoriesAnalysis	ImageCategoriesAnalysis[]	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.

ImageCategoriesAnalysis

Résultat de l’analyse d’image.

Nom	Type	Description
category	ImageCategory	Catégorie d’analyse d’image.
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 », et la valeur de sortie peut être 0, 2, 4, 6.

ImageCategory

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

Nom	Type	Description
Hate	string	Catégorie de préjudice pour Image - Haine.
SelfHarm	string	Catégorie de préjudice pour Image - SelfHarm.
Sexual	string	Catégorie de préjudice pour Image - Sexuelle.
Violence	string	Catégorie de préjudice pour Image - Violence.

ImageData

L’image peut être encodée en base64 ou une URL d’objet blob. Vous ne pouvez choisir qu’une de ces options. Si les deux sont fournis, la demande sera refusée. La taille maximale de l’image est de 2048 x 2048 pixels et ne doit pas dépasser 4 Mo, tandis que la taille minimale de l’image est de 50 x 50 pixels.

Nom	Type	Description
blobUrl	string	URL de l’objet blob de l’image.
content	string	Encodage Base64 de l’image.

Partager via

Image Operations - Analyze Image

Paramètres URI

Corps de la demande

Réponses

Sécurité

Ocp-Apim-Subscription-Key

OAuth2Auth

Étendues

Exemples

Analyze Image

Exemple de requête

Exemple de réponse

Définitions

AnalyzeImageOptions

AnalyzeImageOutputType

AnalyzeImageResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

ImageCategoriesAnalysis

ImageCategory

ImageData

Ressources supplémentaires