Detect Objects In Stream - Detect Objects In Stream

Dienst:

Azure AI Services

API-Version:

3.2

Führt die Objekterkennung für das angegebene Bild aus. 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/detect

Mit optionalen Parametern:

POST {Endpoint}/vision/v3.2/detect?overload=stream&model-version={model-version}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte.
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

Media Types: "application/octet-stream", "multipart/form-data"

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

Anforderungstext

Media Types: "application/octet-stream", "multipart/form-data"

Name	Typ	Beschreibung
Image	object (file)	Ein Bildstream.

Antworten

Name	Typ	Beschreibung
200 OK	DetectResult	Die Antwort enthält die erkannten Objekte im JSON-Format.
Other Status Codes	ComputerVisionErrorResponse	Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

Beispiele

Successful DetectObjects request

Beispielanforderung

HTTP

POST https://westus.api.cognitive.microsoft.com/vision/v3.2/detect?overload=stream


"{binary}"

Beispiel für eine Antwort

Statuscode:

200

{
  "objects": [
    {
      "rectangle": {
        "x": 0,
        "y": 0,
        "w": 50,
        "h": 50
      },
      "object": "tree",
      "confidence": 0.9,
      "parent": {
        "object": "plant",
        "confidence": 0.95
      }
    }
  ],
  "requestId": "1ad0e45e-b7b4-4be3-8042-53be96103337",
  "metadata": {
    "width": 100,
    "height": 100,
    "format": "Jpeg"
  },
  "modelVersion": "2021-04-01"
}

Definitionen

Name	Beschreibung
BoundingRect	Ein umgebendes Feld für einen Bereich innerhalb eines Bilds.
ComputerVisionError	Der API-Anforderungsfehler.
ComputerVisionErrorCodes	Der Fehlercode.
ComputerVisionErrorResponse	Die API-Fehlerantwort.
ComputerVisionInnerError	Details zum API-Anforderungsfehler.
ComputerVisionInnerErrorCodeValue	Der Fehlercode.
DetectedObject	Ein Objekt, das in einem Bild erkannt wurde.
DetectResult	Ergebnis eines DetectImage-Aufrufs.
ImageMetadata	Bildmetadaten.
ObjectHierarchy	Ein Objekt, das in einem Bild erkannt wurde.

BoundingRect

Objekt

Ein umgebendes Feld für einen Bereich innerhalb eines Bilds.

Name	Typ	Beschreibung
h	integer (int32)	Höhe gemessen vom linken oberen Punkt des Bereichs in Pixel.
w	integer (int32)	Breite gemessen vom oberen linken Punkt des Bereichs in Pixel.
x	integer (int32)	X-Koordinate des oberen linken Punkts des Bereichs in Pixel.
y	integer (int32)	Y-Koordinate des oberen linken Punkts des Bereichs in Pixel.

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

DetectedObject

Objekt

Ein Objekt, das in einem Bild erkannt wurde.

Name	Typ	Beschreibung
confidence	number (double)	Konfidenzbewertung, dass das Objekt im Bild als Wert zwischen 0 und 1 beobachtet wurde.
object	string	Bezeichnung für das Objekt.
parent	ObjectHierarchy	Das übergeordnete Objekt aus Taxonomieperspektive. Das übergeordnete Objekt ist eine allgemeinere Form dieses Objekts. Beispielsweise würde ein "Bulldog" ein Elternteil von "Hund" haben.
rectangle	BoundingRect	Ungefähre Position des erkannten Objekts.

DetectResult

Objekt

Ergebnis eines DetectImage-Aufrufs.

Name	Typ	Beschreibung
metadata	ImageMetadata	Bildmetadaten.
modelVersion	string pattern: ^(latest|\d{4}-\d{2}-\d{2})(-preview)?$	Version des KI-Modells.
objects	DetectedObject[]	Ein Array erkannter Objekte.
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.

ObjectHierarchy

Objekt

Ein Objekt, das in einem Bild erkannt wurde.

Name	Typ	Beschreibung
confidence	number (double)	Konfidenzbewertung, dass das Objekt im Bild als Wert zwischen 0 und 1 beobachtet wurde.
object	string	Bezeichnung für das Objekt.
parent	ObjectHierarchy	Das übergeordnete Objekt aus Taxonomieperspektive. Das übergeordnete Objekt ist eine allgemeinere Form dieses Objekts. Beispielsweise würde ein "Bulldog" ein Elternteil von "Hund" haben.