Planogram Compliance - Match

Dienst:: Azure AI Services

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

Führen Sie den Planogrammabgleichsvorgang mit einem Planogramm und einem Produktverständnisergebnis aus.

POST /planogramcompliance:match?api-version=2023-04-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
api-version	query	True	string	Angeforderte API-Version.

Anforderungstext

Media Types: "application/json-patch+json"

Name	Erforderlich	Typ	Beschreibung
detectedProducts	True	ProductRecognitionResultApiModel	Ergebnisse des Produktverständnisvorgangs.
planogram	True	PlanogramApiModel	Beschreibt das Planogramm für Planogrammabgleichvorgänge.

Antworten

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

Name

Typ

Beschreibung

200 OK

PlanogramMatchingResultApiModel

Erfolg

Other Status Codes

ErrorResponse

Fehler

Header

x-ms-error-code: string

Beispiele

PlanogramCompliance_Match

Beispielanforderung

HTTP

POST /planogramcompliance:match?api-version=2023-04-01-preview

{
  "detectedProducts": {
    "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
          }
        ]
      }
    ]
  },
  "planogram": {
    "width": 10,
    "height": 16,
    "products": [
      {
        "id": "1",
        "name": "product-1",
        "w": 8,
        "h": 25
      }
    ],
    "fixtures": [
      {
        "id": "1",
        "w": 20,
        "h": 4,
        "x": 0,
        "y": 0
      }
    ],
    "positions": [
      {
        "id": "1",
        "productId": "1",
        "fixtureId": "1",
        "x": 0,
        "y": 0
      }
    ]
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "matchingResultPerPosition": [
    {
      "positionId": "0",
      "detectedObject": {
        "id": "0",
        "boundingBox": {
          "x": 197,
          "y": 68,
          "w": 356,
          "h": 394
        },
        "tags": [
          {
            "name": "class1",
            "confidence": 0.92431640625
          }
        ]
      }
    }
  ]
}

Definitionen

Name	Beschreibung
BoundingBox	Ein umgebendes Feld für einen Bereich innerhalb eines Bilds.
DetectedObject	Beschreibt ein erkanntes Objekt in einem Bild.
ErrorResponse	Antwort, die zurückgegeben wird, wenn ein Fehler auftritt.
ErrorResponseDetails	Fehlerinformationen.
ErrorResponseInnerError	Detaillierter Fehler.
FixtureApiModel	Beschreibt eine Vorrichtung in einem Planogramm.
ImageMetadataApiModel	Die Bildmetadateninformationen wie Höhe und Breite.
PlanogramApiModel	Beschreibt das Planogramm für Planogrammabgleichvorgänge.
PlanogramMatchingRequestApiModel	Eingabe, die an den Planogrammabgleich übergeben werden soll.
PlanogramMatchingResultApiModel	Ergebnisse des Planogrammabgleichsvorgangs.
PositionApiModel	Beschreibt eine Produktposition in einem Planogramm.
PositionMatchingResultApiModel	Gekoppelte Planogrammpositions-ID und entsprechendes erkanntes Objekt aus dem Produktverständnisergebnis.
ProductApiModel	Beschreibt ein Produkt im Planogramm.
ProductRecognitionResultApiModel	Ergebnisse des Produktverständnisvorgangs.
Tag	Eine Entitätsbeobachtung im Bild zusammen mit der Konfidenzbewertung.

BoundingBox

Objekt

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

Name	Typ	Beschreibung
h	integer (int32) minimum: 1	Höhe gemessen vom linken oberen Punkt des Bereichs in Pixel.
w	integer (int32) minimum: 1	Breite gemessen vom oberen linken Punkt des Bereichs in Pixel.
x	integer (int32) minimum: 0	Linke Koordinate des linken oberen Punkts des Bereichs, in Pixeln.
y	integer (int32) minimum: 0	Oberste Koordinate des linken oberen Punkts des Bereichs, in Pixeln.

DetectedObject

Objekt

Beschreibt ein erkanntes Objekt in einem Bild.

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

ErrorResponse

Objekt

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

Name	Typ	Beschreibung
error	ErrorResponseDetails	Fehlerinformationen.

ErrorResponseDetails

Objekt

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

Objekt

Detaillierter Fehler.

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

FixtureApiModel

Objekt

Beschreibt eine Vorrichtung in einem Planogramm.

Name	Typ	Beschreibung
h	number (double)	Höhe des Einrichtungsgegenstands.
id	string minLength: 1	ID der Vorrichtung.
w	number (double)	Breite des Einrichtungsgegenstands.
x	number (double) minimum: 0	Linker Abstand vom Ursprung in Zoll oder Zentimeter.
y	number (double) minimum: 0	Oberer Abstand vom Ursprung in Zoll oder Zentimeter.

ImageMetadataApiModel

Objekt

Die Bildmetadateninformationen wie Höhe und Breite.

Name	Typ	Beschreibung
height	integer (int32) minimum: 1	Die Höhe des Bilds in Pixel.
width	integer (int32) minimum: 1	Die Breite des Bilds in Pixeln.

PlanogramApiModel

Objekt

Beschreibt das Planogramm für Planogrammabgleichvorgänge.

Name	Typ	Beschreibung
fixtures	FixtureApiModel[]	Liste der Einrichtungsgegenstände im Planogramm.
height	number (double)	Höhe des Planogramms.
positions	PositionApiModel[]	Liste der Positionen im Planogramm.
products	ProductApiModel[]	Liste der Produkte im Planogramm.
width	number (double)	Breite des Planogramms.

PlanogramMatchingRequestApiModel

Objekt

Eingabe, die an den Planogrammabgleich übergeben werden soll.

Name	Typ	Beschreibung
detectedProducts	ProductRecognitionResultApiModel	Ergebnisse des Produktverständnisvorgangs.
planogram	PlanogramApiModel	Beschreibt das Planogramm für Planogrammabgleichvorgänge.

PlanogramMatchingResultApiModel

Objekt

Ergebnisse des Planogrammabgleichsvorgangs.

Name	Typ	Beschreibung
matchingResultPerPosition	PositionMatchingResultApiModel[]	Die übereinstimmend erkannten Objektinformationen für jede Planogrammposition.

PositionApiModel

Objekt

Beschreibt eine Produktposition in einem Planogramm.

Name	Typ	Beschreibung
fixtureId	string minLength: 1	Id der Vorrichtung, auf der das Produkt eingeschaltet ist.
id	string minLength: 1	ID der Position.
productId	string minLength: 1	ID des Produkts.
x	number (double) minimum: 0	Linker Abstand vom Ursprung in Zoll oder Zentimeter.
y	number (double) minimum: 0	Oberer Abstand vom Ursprung in Zoll oder Zentimeter.

PositionMatchingResultApiModel

Objekt

Gekoppelte Planogrammpositions-ID und entsprechendes erkanntes Objekt aus dem Produktverständnisergebnis.

Name	Typ	Beschreibung
detectedObject	DetectedObject	Beschreibt ein erkanntes Objekt in einem Bild.
positionId	string minLength: 1	Die Positions-ID aus dem Planogramm, die dem entsprechenden erkannten Objekt zugeordnet wurde.

ProductApiModel

Objekt

Beschreibt ein Produkt im Planogramm.

Name	Typ	Beschreibung
h	number (double)	Höhe des Einrichtungsgegenstands.
id	string minLength: 1	ID des Produkts.
name	string minLength: 1 maxLength: 255	Name des Produkts.
w	number (double)	Breite des Produkts.

ProductRecognitionResultApiModel

Objekt

Ergebnisse des Produktverständnisvorgangs.

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.

Tag

Objekt

Eine Entitätsbeobachtung im Bild zusammen mit der Konfidenzbewertung.

Name	Typ	Beschreibung
confidence	number (double) minimum: 0 maximum: 1	Die Vertrauensstufe, die die Entität beobachtet hat.
name	string minLength: 1	Name der Entität.