Describe Image - Describe Image

Dienst:

Azure AI Services

API-Version:

3.2

Dieser Vorgang generiert eine Beschreibung eines Bilds in lesbarer Sprache mit vollständigen Sätzen. Die Beschreibung basiert auf einer Sammlung von Inhaltstags, die auch vom Vorgang zurückgegeben werden. Für jedes Bild können mehrere Beschreibungen generiert werden. Beschreibungen werden nach ihrer Konfidenzbewertung sortiert. Beschreibungen können Ergebnisse aus Prominenten- und Landmark-Domänenmodellen enthalten, falls zutreffend. Zwei Eingabemethoden werden unterstützt : (1) Hochladen eines Bilds oder (2) Angeben einer Bild-URL. Eine erfolgreiche Antwort wird in JSON zurückgegeben. Wenn die Anforderung fehlgeschlagen ist, enthält die Antwort einen Fehlercode und eine Meldung, um zu verstehen, was nicht geklappt hat.

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

Mit optionalen Parametern:

POST {Endpoint}/vision/v3.2/describe?maxCandidates={maxCandidates}&language={language}&descriptionExclude={descriptionExclude}&model-version={model-version}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte.
descriptionExclude	query		DescriptionExclude[]	Deaktivieren Sie beim Generieren der Beschreibung angegebene Domänenmodelle.
language	query		string	Die gewünschte Sprache für die Ausgabegenerierung. Wenn dieser Parameter nicht angegeben ist, lautet der Standardwert "en". Eine Liste der unterstützten Sprachen finden Sie unter https://aka.ms/cv-languages.
maxCandidates	query		integer (int32)	Maximale Anzahl der zurückzugebenden Kandidatenbeschreibungen. Der Standardwert ist 1.
model-version	query		string pattern: ^(latest|\d{4}-\d{2}-\d{2})(-preview)?$	Optionaler Parameter zum Angeben der Version des KI-Modells. Akzeptierte Werte sind: "latest", "2021-04-01", "2021-05-01". Der Standardwert ist "latest".

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
url	True	string	Öffentlich erreichbare URL eines Bilds.

Antworten

Name	Typ	Beschreibung
200 OK	ImageDescription	Bildbeschreibungsobjekt.
Other Status Codes	ComputerVisionErrorResponse	Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

Beispiele

Successful DescribeImage request

Beispielanforderung

HTTP

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


{
  "url": "{url}"
}

Beispiel für eine Antwort

Statuscode:

200

{
  "description": {
    "tags": [
      "person",
      "man",
      "outdoor",
      "window",
      "glasses"
    ],
    "captions": [
      {
        "text": "Satya Nadella sitting on a bench",
        "confidence": 0.48293603002174407
      }
    ]
  },
  "requestId": "ed2de1c6-fb55-4686-b0da-4da6e05d283f",
  "metadata": {
    "width": 1500,
    "height": 1000,
    "format": "Jpeg"
  },
  "modelVersion": "2021-04-01"
}

Definitionen

Name	Beschreibung
ComputerVisionError	Der API-Anforderungsfehler.
ComputerVisionErrorCodes	Der Fehlercode.
ComputerVisionErrorResponse	Die API-Fehlerantwort.
ComputerVisionInnerError	Details zum API-Anforderungsfehler.
ComputerVisionInnerErrorCodeValue	Der Fehlercode.
DescriptionExclude	Deaktivieren Sie beim Generieren der Beschreibung angegebene Domänenmodelle.
ImageCaption	Eine Bildbeschriftung, d. h. eine kurze Beschreibung der Darstellung des Bilds.
ImageDescription	Eine Sammlung von Inhaltstags sowie eine Liste der Beschriftungen, sortiert nach Konfidenzniveau und Bildmetadaten.
ImageMetadata	Bildmetadaten.
ImageUrl

ComputerVisionError

Objekt

Der API-Anforderungsfehler.

Name	Typ	Beschreibung
code	ComputerVisionErrorCodes	Der Fehlercode.
innererror	ComputerVisionInnerError	Innerer Fehler enthält spezifischere Informationen.
message	string	Eine Meldung, die den vom Dienst gemeldeten Fehler erklärt.

ComputerVisionErrorCodes

Enumeration

Der Fehlercode.

Wert	Beschreibung
InternalServerError
InvalidArgument
InvalidRequest
ServiceUnavailable

ComputerVisionErrorResponse

Objekt

Die API-Fehlerantwort.

Name	Typ	Beschreibung
error	ComputerVisionError	Fehlerinhalte.

ComputerVisionInnerError

Objekt

Details zum API-Anforderungsfehler.

Name	Typ	Beschreibung
code	ComputerVisionInnerErrorCodeValue	Der Fehlercode.
message	string	Fehlermeldung.

ComputerVisionInnerErrorCodeValue

Enumeration

Der Fehlercode.

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

DescriptionExclude

Enumeration

Deaktivieren Sie beim Generieren der Beschreibung angegebene Domänenmodelle.

Wert	Beschreibung
Celebrities
Landmarks

ImageCaption

Objekt

Eine Bildbeschriftung, d. h. eine kurze Beschreibung der Darstellung des Bilds.

Name	Typ	Beschreibung
confidence	number (double)	Die Vertrauensstufe, die der Dienst in der Beschriftung hat.
text	string	Der Text der Beschriftung.

ImageDescription

Objekt

Eine Sammlung von Inhaltstags sowie eine Liste der Beschriftungen, sortiert nach Konfidenzniveau und Bildmetadaten.

Name	Typ	Beschreibung
description.captions	ImageCaption[]	Eine Liste der Beschriftungen, sortiert nach Konfidenzniveau.
description.tags	string[]	Eine Sammlung von Bildtags.
metadata	ImageMetadata	Bildmetadaten.
modelVersion	string pattern: ^(latest|\d{4}-\d{2}-\d{2})(-preview)?$	Version des KI-Modells.
requestId	string	ID der REST-API-Anforderung.

ImageMetadata

Objekt

Bildmetadaten.

Name	Typ	Beschreibung
format	string	Bildformat.
height	integer (int32)	Bildhöhe in Pixel.
width	integer (int32)	Bildbreite in Pixel.

ImageUrl

Objekt

Name	Typ	Beschreibung
url	string	Öffentlich erreichbare URL eines Bilds.