Product Recognition - List Runs

Dienst:

Cognitive Services - Computer Vision

API-Version:

2023-04-01-preview

Listet alle Produkterkennungsausführungen eines Modells auf.

GET /productrecognition/{modelName}/runs?api-version=2023-04-01-preview

Mit optionalen Parametern:

GET /productrecognition/{modelName}/runs?skip={skip}&top={top}&api-version=2023-04-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
modelName	path	True	string	Der Name des Modells, zu dem die Produkterkennung gehört. RegEx-Muster: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
api-version	query	True	string	Angeforderte API-Version.
skip	query		integer int32	Anzahl der zu überspringenden Produkterkennungsausführungen.
top	query		integer int32	Anzahl der Produkterkennungsläufe, die nach dem Überspringen zurückgegeben werden sollen. Der maximal zulässige Wert ist 30.

Antworten

Name	Typ	Beschreibung
200 OK	ProductRecognitionApiModelCollectionApiModel	Erfolg
Other Status Codes	ErrorResponse	Fehler Header x-ms-error-code: string

Beispiele

ProductRecognition_List

Beispielanforderung

HTTP

GET /productrecognition/model-1/runs?skip=0&top=10&api-version=2023-04-01-preview

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "runName": "run-1",
      "modelName": "model-1",
      "createdDateTime": "2023-04-12T21:56:42.827Z",
      "updatedDateTime": "2023-04-12T21:56:42.827Z",
      "status": "completed",
      "result": {
        "imageMetadata": {
          "width": 660,
          "height": 495
        },
        "products": [
          {
            "id": "1",
            "boundingBox": {
              "x": 197,
              "y": 68,
              "w": 356,
              "h": 394
            },
            "tags": [
              {
                "name": "class1",
                "confidence": 0.92431640625
              }
            ]
          }
        ],
        "gaps": [
          {
            "id": "1",
            "boundingBox": {
              "x": 197,
              "y": 68,
              "w": 356,
              "h": 394
            },
            "tags": [
              {
                "name": "gap",
                "confidence": 0.92431640625
              }
            ]
          }
        ]
      }
    }
  ]
}

Definitionen

Name	Beschreibung
BoundingBox	Ein Begrenzungsrahmen für einen Bereich innerhalb eines Bilds.
DetectedObject	Beschreibt ein erkanntes Objekt in einem Bild.
ErrorResponse	Die Antwort wird zurückgegeben, wenn ein Fehler auftritt.
ErrorResponseDetails	Fehlerinformationen.
ErrorResponseInnerError	Detaillierter Fehler.
ImageMetadataApiModel	Die Bildmetadateninformationen wie Höhe und Breite.
ProductRecognitionApiModel
ProductRecognitionApiModelCollectionApiModel	Enthält ein Array von Ergebnissen, die paginiert werden können.
ProductRecognitionResultApiModel	Ergebnisse aus dem Produktverständnisvorgang.
ProductRecognitionState	Schreibgeschützt. Der aktuelle Status der Produkterkennungsausführung.
Tag	Eine Entitätsbeobachtung im Bild zusammen mit der Konfidenzbewertung.

BoundingBox

Ein Begrenzungsrahmen für einen Bereich innerhalb eines Bilds.

Name	Typ	Beschreibung
h	integer	Gemessene Höhe des linken oberen Punkts des Bereichs, in Pixeln.
w	integer	Gemessene Breite des linken oberen Punkts des Bereichs, in Pixeln.
x	integer	Linke Koordinate des linken oberen Punkts des Bereichs, in Pixeln.
y	integer	Oberste Koordinate des linken oberen Punkts des Bereichs, in Pixeln.

DetectedObject

Beschreibt ein erkanntes Objekt in einem Bild.

Name	Typ	Beschreibung
boundingBox	BoundingBox	Ein Begrenzungsrahmen für einen Bereich innerhalb eines Bilds.
id	string	ID des erkannten Objekts.
tags	Tag[]	Klassifizierungskonfidenzen des erkannten Objekts.

ErrorResponse

Die Antwort wird zurückgegeben, wenn ein Fehler auftritt.

Name	Typ	Beschreibung
error	ErrorResponseDetails	Fehlerinformationen.

ErrorResponseDetails

Fehlerinformationen.

Name	Typ	Beschreibung
code	string	Fehlercode
details	ErrorResponseDetails[]	Liste der detaillierten Fehler.
innererror	ErrorResponseInnerError	Detaillierter Fehler.
message	string	Fehlermeldung.
target	string	Ziel des Fehlers.

ErrorResponseInnerError

Detaillierter Fehler.

Name	Typ	Beschreibung
code	string	Fehlercode
innererror	ErrorResponseInnerError	Detaillierter Fehler.
message	string	Fehlermeldung.

ImageMetadataApiModel

Die Bildmetadateninformationen wie Höhe und Breite.

Name	Typ	Beschreibung
height	integer	Die Höhe des Bilds in Pixeln.
width	integer	Die Breite des Bilds in Pixeln.

ProductRecognitionApiModel

Name	Typ	Beschreibung
createdDateTime	string	Schreibgeschützt. Datum und Uhrzeit der ersten Erstellung der Produkterkennung in UTC.
error	ErrorResponseDetails	Fehlerinformationen.
modelName	string	Schreibgeschützt. Das Modell, für das die Produkterkennung ausgeführt werden soll.
result	ProductRecognitionResultApiModel	Ergebnisse aus dem Produktverständnisvorgang.
runName	string	Schreibgeschützt. Der Name, der verwendet wird, um die Produkterkennungsausführung eindeutig zu identifizieren.
status	ProductRecognitionState	Schreibgeschützt. Der aktuelle Status der Produkterkennungsausführung.
updatedDateTime	string	Schreibgeschützt. Datum und Uhrzeit der letzten Aktualisierung der Produkterkennung in UTC.

ProductRecognitionApiModelCollectionApiModel

Enthält ein Array von Ergebnissen, die paginiert werden können.

Name	Typ	Beschreibung
nextLink	string	Ein Link zum nächsten Satz paginierter Ergebnisse, wenn weitere Ergebnisse verfügbar sind; andernfalls nicht vorhanden.
value	ProductRecognitionApiModel[]	Das Array der Ergebnisse.

ProductRecognitionResultApiModel

Ergebnisse aus dem Produktverständnisvorgang.

Name	Typ	Beschreibung
gaps	DetectedObject[]	Im Bild erkannte Lücken.
imageMetadata	ImageMetadataApiModel	Die Bildmetadateninformationen wie Höhe und Breite.
products	DetectedObject[]	Im Bild erkannte Produkte.

ProductRecognitionState

Schreibgeschützt. Der aktuelle Status der Produkterkennungsausführung.

Name	Typ	Beschreibung
failed	string
notStarted	string
running	string
succeeded	string

Tag

Eine Entitätsbeobachtung im Bild zusammen mit der Konfidenzbewertung.

Name	Typ	Beschreibung
confidence	number	Das Maß an Vertrauen, das die Entität beobachtet wurde.
name	string	Name der Entität.