Image Analysis - Analyze Stream

Référence

Service:: Azure AI Services

Version d'API:: 2023-04-01-preview

Analysez l’image d’entrée. La requête contient soit un flux d’image avec n’importe quel type de contenu ['image/*', 'application/octet-stream'] ou une charge utile JSON qui inclut une propriété url à utiliser pour récupérer le flux d’image.

POST /imageanalysis:analyze?overload=stream&api-version=2023-04-01-preview

Avec des paramètres facultatifs:

POST /imageanalysis:analyze?overload=stream&features={features}&model-name={model-name}&language={language}&smartcrops-aspect-ratios={smartcrops-aspect-ratios}&gender-neutral-caption={gender-neutral-caption}&api-version=2023-04-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
api-version	query	True	string	Version de l’API demandée.
features	query		VisualFeature[]	Les fonctionnalités visuelles demandées : balises, objets, légende, denseCaptions, lecture, smartCrops, personnes. Ce paramètre doit être spécifié si le paramètre « model-name » n’est pas spécifié.
gender-neutral-caption	query		boolean	Indicateur booléen pour activer le sous-titrage sans sexe pour les fonctionnalités de légende et denseCaptions. Si ce paramètre n’est pas spécifié, la valeur par défaut est « false ».
language	query		string	Langue souhaitée pour la génération de sortie. Si ce paramètre n’est pas spécifié, la valeur par défaut est « en ». Consultez https://aka.ms/cv-languages la liste des langues prises en charge.
model-name	query		string	Nom du modèle entraîné personnalisé. Ce paramètre doit être spécifié si le paramètre « features » n’est pas spécifié.
smartcrops-aspect-ratios	query		string	Liste des proportions à utiliser pour la fonctionnalité smartCrops. Les proportions sont calculées en divisant la largeur du rognage cible par la hauteur. Les valeurs prises en charge sont comprises entre 0,75 et 1,8 (inclus). Plusieurs valeurs doivent être séparées par des virgules. Si ce paramètre n’est pas spécifié, le service retourne une suggestion de rognage avec un rapport d’aspect compris entre 0,5 et 2,0 (inclus).

Corps de la demande

Media Types: "application/octet-stream", "image/jpeg", "image/gif", "image/tiff", "image/bmp", "image/png"

Nom	Type	Description
body	string	Flux d’images.

Réponses

Nom	Type	Description
200 OK	ImageAnalysisResult	Succès
Other Status Codes	ErrorResponse	Error En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

ImageAnalysisResult

Succès

Other Status Codes

ErrorResponse

Error

En-têtes

x-ms-error-code: string

Exemples

AnalyzeImageFromImageStream_CustomModel

Exemple de requête

HTTP

POST /imageanalysis:analyze?overload=stream&model-name=my_model_name&api-version=2023-04-01-preview

"Ynl0ZXM="

Exemple de réponse

Code d’état:: 200

{
  "modelVersion": "2023-04-01-preview",
  "customModelResult": {
    "objectsResult": {
      "values": [
        {
          "id": "1",
          "boundingBox": {
            "x": 197,
            "y": 68,
            "w": 356,
            "h": 394
          },
          "tags": [
            {
              "name": "class1",
              "confidence": 0.92431640625
            }
          ]
        },
        {
          "id": "2",
          "boundingBox": {
            "x": 0,
            "y": 77,
            "w": 241,
            "h": 359
          },
          "tags": [
            {
              "name": "class1",
              "confidence": 0.87890625
            }
          ]
        }
      ]
    }
  },
  "metadata": {
    "width": 660,
    "height": 495
  }
}

Définitions

Nom	Description
AdultMatch	Objet décrivant la correspondance de contenu pour adultes.
AdultResult	Objet décrivant si l’image contient du contenu destiné aux adultes et/ou si elle est racé.
BoundingBox	Cadre englobant pour une zone à l’intérieur d’une image.
CaptionResult	Brève description de ce que l’image représente.
CropRegion	Région identifiée pour le rognage intelligent. Une région sera retournée pour chaque proportion demandée.
DenseCaption	Brève description de ce que l’image représente.
DenseCaptionsResult	Liste de légendes.
DetectedObject	Décrit un objet détecté dans une image.
DetectedPerson	Personne détectée dans une image.
DocumentLine	Objet de ligne de contenu constitué d’une séquence adjacente d’éléments de contenu, tels que des mots et des marques de sélection.
DocumentPage	Éléments de contenu et de disposition extraits d’une page à partir de l’entrée.
DocumentSpan	Région contiguë de la propriété de contenu concaténé, spécifiée sous forme de décalage et de longueur.
DocumentStyle	Objet représentant les styles de texte observés.
DocumentWord	Objet word constitué d’une séquence contiguë de caractères. Pour les langues non délimitées par l’espace, telles que le chinois, le japonais et le coréen, chaque caractère est représenté comme son propre mot.
ErrorResponse	Réponse retournée lorsqu’une erreur se produit.
ErrorResponseDetails	Informations sur l’erreur.
ErrorResponseInnerError	Erreur détaillée.
ImageAnalysisResult	Décrire les résultats combinés de différents types d’analyse d’images.
ImageMetadataApiModel	Informations de métadonnées d’image telles que la hauteur et la largeur.
ImagePredictionResult	Décrit le résultat de prédiction d’une image.
ObjectsResult	Décrit les objets détectés dans une image.
PeopleResult	Objet indiquant si l’image contient des personnes.
ReadResult	Résultats d’une opération de lecture.
SmartCropsResult	Résultat du rognage intelligent.
Tag	Une observation d’entité dans l’image, ainsi que le score de confiance.
TagsResult	Liste d’étiquettes avec un niveau de confiance.
VisualFeature	Les fonctionnalités visuelles demandées : balises, objets, légende, denseCaptions, lecture, smartCrops, personnes. Ce paramètre doit être spécifié si le paramètre « model-name » n’est pas spécifié.

AdultMatch

Objet décrivant la correspondance de contenu pour adultes.

Nom	Type	Description
confidence	number	Valeur indiquant le niveau de confiance du contenu pour adultes correspondant.
isMatch	boolean	Valeur indiquant si l’image correspond au contenu pour adultes.

AdultResult

Objet décrivant si l’image contient du contenu destiné aux adultes et/ou si elle est racé.

Nom	Type	Description
adult	AdultMatch	Objet décrivant la correspondance de contenu pour adultes.
gore	AdultMatch	Objet décrivant la correspondance de contenu pour adultes.
racy	AdultMatch	Objet décrivant la correspondance de contenu pour adultes.

BoundingBox

Cadre englobant pour une zone à l’intérieur d’une image.

Nom	Type	Description
h	integer	Hauteur mesurée à partir du point supérieur gauche de la zone, en pixels.
w	integer	Largeur mesurée à partir du point supérieur gauche de la zone, en pixels.
x	integer	Coordonnée gauche du point supérieur gauche de la zone, en pixels.
y	integer	Coordonnée supérieure du point supérieur gauche de la zone, en pixels.

CaptionResult

Brève description de ce que l’image représente.

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

CropRegion

Région identifiée pour le rognage intelligent. Une région sera retournée pour chaque proportion demandée.

Nom	Type	Description
aspectRatio	number	Proportions de la région de rognage.
boundingBox	BoundingBox	Cadre englobant pour une zone à l’intérieur d’une image.

DenseCaption

Brève description de ce que l’image représente.

Nom	Type	Description
boundingBox	BoundingBox	Cadre englobant pour une zone à l’intérieur d’une image.
confidence	number	Niveau de confiance du service dans la légende.
text	string	Texte de la légende.

DenseCaptionsResult

Liste de légendes.

Nom	Type	Description
values	DenseCaption[]	Liste de légendes.

DetectedObject

Décrit un objet détecté dans une image.

Nom	Type	Description
boundingBox	BoundingBox	Cadre englobant pour une zone à l’intérieur d’une image.
id	string	ID de l’objet détecté.
tags	Tag[]	Confiances de classification de l’objet détecté.

DetectedPerson

Personne détectée dans une image.

Nom	Type	Description
boundingBox	BoundingBox	Cadre englobant pour une zone à l’intérieur d’une image.
confidence	number	Score de confiance d’avoir observé la personne dans l’image, sous la forme d’une valeur comprise entre 0 et 1.

DocumentLine

Objet de ligne de contenu constitué d’une séquence adjacente d’éléments de contenu, tels que des mots et des marques de sélection.

Nom	Type	Description
boundingBox	number[]	Zone englobante de la ligne.
content	string	Contenu concaténé des éléments contenus dans l’ordre de lecture.
spans	DocumentSpan[]	Emplacement de la ligne dans le contenu concaténé de l’ordre de lecture.

DocumentPage

Éléments de contenu et de disposition extraits d’une page à partir de l’entrée.

Nom	Type	Description
angle	number	Orientation générale du contenu dans le sens des aiguilles d’une montre, mesurée en degrés compris entre (-180, 180).
height	number	Hauteur de l’image/PDF en pixels/pouces, respectivement.
lines	DocumentLine[]	Lignes extraites de la page, contenant potentiellement des éléments textuels et visuels.
pageNumber	integer	Numéro de page basé sur 1 dans le document d’entrée.
spans	DocumentSpan[]	Emplacement de la page dans le contenu concaténé dans l’ordre de lecture.
width	number	Largeur de l’image/PDF en pixels/pouces, respectivement.
words	DocumentWord[]	Mots extraits de la page.

DocumentSpan

Région contiguë de la propriété de contenu concaténé, spécifiée sous forme de décalage et de longueur.

Nom	Type	Description
length	integer	Nombre de caractères dans le contenu représenté par l’étendue.
offset	integer	Index de base zéro du contenu représenté par l’étendue.

DocumentStyle

Objet représentant les styles de texte observés.

Nom	Type	Description
confidence	number	Confiance d’identifier correctement le style.
isHandwritten	boolean	Contenu manuscrit ou non.
spans	DocumentSpan[]	Emplacement des éléments de texte dans le contenu concaténé auquel le style s’applique.

DocumentWord

Objet word constitué d’une séquence contiguë de caractères. Pour les langues non délimitées par l’espace, telles que le chinois, le japonais et le coréen, chaque caractère est représenté comme son propre mot.

Nom	Type	Description
boundingBox	number[]	Cadre englobant du mot.
confidence	number	Confiance de l’extraction correcte du mot.
content	string	Contenu textuel du mot.
span	DocumentSpan	Zone contiguë de la propriété de contenu concaténé, spécifiée en tant que décalage et longueur.

ErrorResponse

Réponse retournée lorsqu’une erreur se produit.

Nom	Type	Description
error	ErrorResponseDetails	Informations sur l’erreur.

ErrorResponseDetails

Informations sur l’erreur.

Nom	Type	Description
code	string	Code d’erreur.
details	ErrorResponseDetails[]	Liste des erreurs détaillées.
innererror	ErrorResponseInnerError	Erreur détaillée.
message	string	Message d’erreur.
target	string	Cible de l’erreur.

ErrorResponseInnerError

Erreur détaillée.

Nom	Type	Description
code	string	Code d’erreur.
innererror	ErrorResponseInnerError	Erreur détaillée.
message	string	Message d’erreur.

ImageAnalysisResult

Décrire les résultats combinés de différents types d’analyse d’images.

Nom	Type	Description
adultResult	AdultResult	Objet décrivant si l’image contient du contenu destiné aux adultes et/ou si elle est racé.
captionResult	CaptionResult	Brève description de ce que l’image représente.
customModelResult	ImagePredictionResult	Décrit le résultat de prédiction d’une image.
denseCaptionsResult	DenseCaptionsResult	Liste de légendes.
metadata	ImageMetadataApiModel	Informations de métadonnées d’image telles que la hauteur et la largeur.
modelVersion	string	Version de modèle.
objectsResult	ObjectsResult	Décrit les objets détectés dans une image.
peopleResult	PeopleResult	Objet indiquant si l’image contient des personnes.
readResult	ReadResult	Résultats d’une opération de lecture.
smartCropsResult	SmartCropsResult	Résultat du rognage intelligent.
tagsResult	TagsResult	Liste d’étiquettes avec un niveau de confiance.

ImageMetadataApiModel

Informations de métadonnées d’image telles que la hauteur et la largeur.

Nom	Type	Description
height	integer	La hauteur de l’image est en pixels.
width	integer	La largeur de l’image est en pixels.

ImagePredictionResult

Décrit le résultat de prédiction d’une image.

Nom	Type	Description
objectsResult	ObjectsResult	Décrit les objets détectés dans une image.
tagsResult	TagsResult	Liste d’étiquettes avec un niveau de confiance.

ObjectsResult

Décrit les objets détectés dans une image.

Nom	Type	Description
values	DetectedObject[]	Tableau d’objets détectés.

PeopleResult

Objet indiquant si l’image contient des personnes.

Nom	Type	Description
values	DetectedPerson[]	Tableau de personnes détectées.

ReadResult

Résultats d’une opération de lecture.

Nom	Type	Description
content	string	Concaténer une représentation sous forme de chaîne de tous les éléments textuels et visuels dans l’ordre de lecture.
pages	DocumentPage[]	Liste des pages analysées.
stringIndexType	string	Méthode utilisée pour calculer le décalage et la longueur de chaîne, les valeurs possibles sont « textElements », « unicodeCodePoint », « utf16CodeUnit », etc.
styles	DocumentStyle[]	Styles de police extraits.

SmartCropsResult

Résultat du rognage intelligent.

Nom	Type	Description
values	CropRegion[]	Régions recommandées pour le rognage de l’image.

Tag

Une observation d’entité dans l’image, ainsi que le score de confiance.

Nom	Type	Description
confidence	number	Niveau de confiance que l’entité a été observée.
name	string	Nom de l’entité.

TagsResult

Liste d’étiquettes avec un niveau de confiance.

Nom	Type	Description
values	Tag[]	Liste d’étiquettes avec un niveau de confiance.

VisualFeature

Les fonctionnalités visuelles demandées : balises, objets, légende, denseCaptions, lecture, smartCrops, personnes. Ce paramètre doit être spécifié si le paramètre « model-name » n’est pas spécifié.

Nom	Type	Description
caption	string
denseCaptions	string
objects	string
people	string
read	string
smartCrops	string
tags	string

Partager via

Image Analysis - Analyze Stream

Paramètres URI

Corps de la demande

Réponses

Exemples

AnalyzeImageFromImageStream_CustomModel

Exemple de requête

Exemple de réponse

Définitions

AdultMatch

AdultResult

BoundingBox

CaptionResult

CropRegion

DenseCaption

DenseCaptionsResult

DetectedObject

DetectedPerson

DocumentLine

DocumentPage

DocumentSpan

DocumentStyle

DocumentWord

ErrorResponse

ErrorResponseDetails

ErrorResponseInnerError

ImageAnalysisResult

ImageMetadataApiModel

ImagePredictionResult

ObjectsResult

PeopleResult

ReadResult

SmartCropsResult

Tag

TagsResult

VisualFeature

Ressources supplémentaires