Freigeben über

Planogram Compliance - Match

  • Referenz
Dienst:
Cognitive Services - Computer Vision
API-Version:
2023-04-01-preview

Führen Sie den Planogrammabgleichsvorgang für ein Planogramm und ein Produktverständnisergebnis aus.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
api-version
 query True

string

Api-Version angefordert.

Anforderungstext

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

Name Erforderlich Typ Beschreibung
detectedProducts True

ProductRecognitionResultApiModel

Ergebnisse aus dem Produktverständnisvorgang.
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

Beispiele

PlanogramCompliance_Match

Sample request

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
      }
    ]
  }
}

Sample response

Status code:
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 Begrenzungsrahmen 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 Metadateninformationen des Bilds, z. B. Höhe und Breite.
PlanogramApiModel

Beschreibt das Planogramm für Planogrammabgleichvorgänge.
PlanogramMatchingRequestApiModel

Eingabe, die an den Planogrammabgleichsvorgang übergeben werden soll.
PlanogramMatchingResultApiModel

Ergebnis 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 aus dem Produktverständnisvorgang.
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

Antwort, die zurückgegeben wird, 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.

FixtureApiModel

Beschreibt eine Vorrichtung in einem Planogramm.

Name Typ Beschreibung
h

number

Höhe des Einrichtungsgegenstands.
id

string

ID der Vorrichtung.
w

number

Breite des Einrichtungsgegenstands.
x

number

Linker Offset vom Ursprung in der Einheit in Zoll oder Zentimetern.
y

number

Oberster Offset vom Ursprung, in Einheit von in Zoll oder Zentimetern.

ImageMetadataApiModel

Die Metadateninformationen des Bilds, z. B. Höhe und Breite.

Name Typ Beschreibung
height

integer

Die Höhe des Bilds in Pixeln.
width

integer

Die Breite des Bilds in Pixeln.

PlanogramApiModel

Beschreibt das Planogramm für Planogrammabgleichvorgänge.

Name Typ Beschreibung
fixtures

FixtureApiModel[]

Liste der Einrichtungsgegenstände im Planogramm.
height

number

Höhe des Planogramms.
positions

PositionApiModel[]

Liste der Positionen im Planogramm.
products

ProductApiModel[]

Liste der Produkte im Planogramm.
width

number

Breite des Planogramms.

PlanogramMatchingRequestApiModel

Eingabe, die an den Planogrammabgleichsvorgang übergeben werden soll.

Name Typ Beschreibung
detectedProducts

ProductRecognitionResultApiModel

Ergebnisse aus dem Produktverständnisvorgang.
planogram

PlanogramApiModel

Beschreibt das Planogramm für Planogrammabgleichvorgänge.

PlanogramMatchingResultApiModel

Ergebnis des Planogrammabgleichsvorgangs.

Name Typ Beschreibung
matchingResultPerPosition

PositionMatchingResultApiModel[]

Die übereinstimmend erkannten Objektinformationen für jede Planogrammposition.

PositionApiModel

Beschreibt eine Produktposition in einem Planogramm.

Name Typ Beschreibung
fixtureId

string

ID der Vorrichtung, auf der sich das Produkt befindet.
id

string

ID der Position.
productId

string

Id des Produkts.
x

number

Linker Offset vom Ursprung in der Einheit in Zoll oder Zentimetern.
y

number

Oberster Offset vom Ursprung, in Einheit von in Zoll oder Zentimetern.

PositionMatchingResultApiModel

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

Die Positions-ID aus dem Planogramm, die dem entsprechenden erkannten Objekt zugeordnet wurde.

ProductApiModel

Beschreibt ein Produkt im Planogramm.

Name Typ Beschreibung
h

number

Höhe des Einrichtungsgegenstands.
id

string

Id des Produkts.
name

string

Der Name des Produkts.
w

number

Breite des Produkts.

ProductRecognitionResultApiModel

Ergebnisse aus dem Produktverständnisvorgang.

Name Typ Beschreibung
gaps

DetectedObject[]

Im Bild erkannte Lücken.
imageMetadata

ImageMetadataApiModel

Die Metadateninformationen des Bilds, z. B. Höhe und Breite.
products

DetectedObject[]

Im Bild erkannte Produkte.

Tag

Eine Entitätsbeobachtung im Bild zusammen mit der Konfidenzbewertung.

Name Typ Beschreibung
confidence

number

Das Maß an Vertrauen, das die Entität beobachtet hat.
name

string

Name der Entität.