Describe Image - Describe Image

Service:

Azure AI Services

Version d'API:

3.1

Cette opération génère une description d’une image dans un langage lisible par l’homme avec des phrases complètes. La description est basée sur une collection d’étiquettes de contenu, qui sont également retournées par l’opération. Plusieurs descriptions peuvent être générées pour chaque image. Les descriptions sont classées par leur score de confiance. Les descriptions peuvent inclure les résultats des modèles de domaine de célébrité et de repère, le cas échéant. Deux méthodes d’entrée sont prises en charge : (1) Chargement d’une image ou (2) spécifiant une URL d’image. Une réponse réussie est retournée au format JSON. Si la demande a échoué, la réponse contient un code d’erreur et un message pour vous aider à comprendre ce qui s’est passé.

POST {Endpoint}/vision/v3.1/describe

Avec des paramètres facultatifs:

POST {Endpoint}/vision/v3.1/describe?maxCandidates={maxCandidates}&language={language}&descriptionExclude={descriptionExclude}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
Endpoint	path	True	string	Points de terminaison Cognitive Services pris en charge.
descriptionExclude	query		DescriptionExclude[]	Désactivez les modèles de domaine spécifiés lors de la génération de la description.
language	query		string	Langage souhaité pour la génération de sortie. Si ce paramètre n’est pas spécifié, la valeur par défaut est « en ». Langues prises en charge :en - anglais, par défaut. es - Espagnol, ja - Japonais, pt - Portugais, zh - Chinois simplifié.
maxCandidates	query		integer (int32)	Nombre maximal de descriptions candidates à renvoyer. La valeur par défaut est 1.

En-tête de la demande

Nom	Obligatoire	Type	Description
Ocp-Apim-Subscription-Key	True	string

Corps de la demande

Nom	Obligatoire	Type	Description
url	True	string	URL accessible publiquement d’une image.

Réponses

Nom	Type	Description
200 OK	ImageDescription	Objet description de l’image.
Other Status Codes	ComputerVisionError	Réponse d’erreur.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

Exemples

Successful DescribeImage request

Exemple de requête

HTTP

POST https://westus.api.cognitive.microsoft.com/vision/v3.1/describe?maxCandidates=1


{
  "url": "{url}"
}

Exemple de réponse

Code d’état:

200

{
  "description": {
    "tags": [
      "person",
      "man",
      "outdoor",
      "window",
      "glasses"
    ],
    "captions": [
      {
        "text": "Satya Nadella sitting on a bench",
        "confidence": 0.48293603002174407
      },
      {
        "text": "Satya Nadella is sitting on a bench",
        "confidence": 0.4003700681542283
      },
      {
        "text": "Satya Nadella sitting in front of a building",
        "confidence": 0.38035155997373377
      }
    ]
  },
  "requestId": "ed2de1c6-fb55-4686-b0da-4da6e05d283f",
  "metadata": {
    "width": 1500,
    "height": 1000,
    "format": "Jpeg"
  }
}

Définitions

Nom	Description
ComputerVisionError	Détails sur l’erreur de demande d’API.
ComputerVisionErrorCodes	Code d’erreur.
DescriptionExclude	Désactivez les modèles de domaine spécifiés lors de la génération de la description.
ImageCaption	Légende d’image, c’est-à-dire une brève description de ce que l’image représente.
ImageDescription	Collection de balises de contenu, ainsi qu’une liste de légendes triées par niveau de confiance et métadonnées d’image.
ImageMetadata	Métadonnées d’image.
ImageUrl

ComputerVisionError

Object

Détails sur l’erreur de demande d’API.

Nom	Type	Description
code	ComputerVisionErrorCodes	Code d’erreur.
message	string	Message expliquant l’erreur signalée par le service.
requestId	string	Identificateur de demande unique.

ComputerVisionErrorCodes

Énumération

Code d’erreur.

Valeur	Description
BadArgument
CancelledRequest
DetectFaceError
FailedToProcess
InternalServerError
InvalidDetails
InvalidImageFormat
InvalidImageSize
InvalidImageUrl
InvalidModel
InvalidThumbnailSize
NotSupportedFeature
NotSupportedImage
NotSupportedLanguage
NotSupportedVisualFeature
StorageException
Timeout
Unspecified
UnsupportedMediaType

DescriptionExclude

Énumération

Désactivez les modèles de domaine spécifiés lors de la génération de la description.

Valeur	Description
Celebrities
Landmarks

ImageCaption

Object

Légende d’image, c’est-à-dire une brève description de ce que l’image représente.

Nom	Type	Description
confidence	number (double)	Niveau de confiance du service dans la légende.
text	string	Texte de la légende.

ImageDescription

Object

Collection de balises de contenu, ainsi qu’une liste de légendes triées par niveau de confiance et métadonnées d’image.

Nom	Type	Description
description.captions	ImageCaption[]	Liste des légendes, triées par niveau de confiance.
description.tags	string[]	Collection de balises d’image.
metadata	ImageMetadata	Métadonnées d’image.
requestId	string	ID de la demande d’API REST.

ImageMetadata

Object

Métadonnées d’image.

Nom	Type	Description
format	string	Format d’image.
height	integer (int32)	Hauteur de l’image, en pixels.
width	integer (int32)	Largeur de l’image, en pixels.

ImageUrl

Object

Nom	Type	Description
url	string	URL accessible publiquement d’une image.