Planogram Compliance - Match

Služba:

Cognitive Services - Computer Vision

Verze rozhraní API:

2023-04-01-preview

Spusťte operaci porovnávání planogramu s planogramem a výsledkem, který rozumí produktu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
api-version	query	True	string	Požadovaná verze rozhraní API

Text požadavku

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

Name	Vyžadováno	Typ	Description
detectedProducts	True	ProductRecognitionResultApiModel	Výsledky operace porozumění produktu
planogram	True	PlanogramApiModel	Popisuje planogram pro operace porovnávání planogramů.

Odpovědi

Name	Typ	Description
200 OK	PlanogramMatchingResultApiModel	Success
Other Status Codes	ErrorResponse	Chybová Hlavičky x-ms-error-code: string

Příklady

PlanogramCompliance_Match

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
BoundingBox	Ohraničující rámeček pro oblast uvnitř obrázku.
DetectedObject	Popisuje rozpoznaný objekt na obrázku.
ErrorResponse	Odpověď vrácená, když dojde k chybě.
ErrorResponseDetails	Informace o chybě.
ErrorResponseInnerError	Podrobná chyba.
FixtureApiModel	Popisuje přípravek v planogramu.
ImageMetadataApiModel	Informace o metadatech obrázku, jako je výška a šířka.
PlanogramApiModel	Popisuje planogram pro operace porovnávání planogramů.
PlanogramMatchingRequestApiModel	Vstup, který se má předat do operace párování planogramů.
PlanogramMatchingResultApiModel	Výsledky operace párování planogramů
PositionApiModel	Popisuje pozici produktu v planogramu.
PositionMatchingResultApiModel	Spárované ID pozice planogramu a odpovídající detekovaný objekt z výsledku porozumění produktu.
ProductApiModel	Popisuje produkt v planogramu.
ProductRecognitionResultApiModel	Výsledky operace porozumění produktu
Tag	Pozorování entity na obrázku spolu se skóre spolehlivosti

BoundingBox

Ohraničující rámeček pro oblast uvnitř obrázku.

Name	Typ	Description
h	integer	Výška měřená od levého horního bodu oblasti v pixelech.
w	integer	Šířka měřená od levého horního bodu oblasti v pixelech.
x	integer	Levá souřadnice levého horního bodu oblasti v pixelech
y	integer	Souřadnice horního levého horního bodu oblasti v pixelech

DetectedObject

Popisuje rozpoznaný objekt na obrázku.

Name	Typ	Description
boundingBox	BoundingBox	Ohraničující rámeček pro oblast uvnitř obrázku.
id	string	ID zjištěného objektu.
tags	Tag[]	Spolehlivosti klasifikace zjištěného objektu.

ErrorResponse

Odpověď vrácená, když dojde k chybě.

Name	Typ	Description
error	ErrorResponseDetails	Informace o chybě.

ErrorResponseDetails

Informace o chybě.

Name	Typ	Description
code	string	Kód chyby
details	ErrorResponseDetails[]	Seznam podrobných chyb
innererror	ErrorResponseInnerError	Podrobná chyba.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponseInnerError

Podrobná chyba.

Name	Typ	Description
code	string	Kód chyby
innererror	ErrorResponseInnerError	Podrobná chyba.
message	string	Chybová zpráva.

FixtureApiModel

Popisuje přípravek v planogramu.

Name	Typ	Description
h	number	Výška upevňovacího zařízení.
id	string	ID přípravku.
w	number	Šířka uchycení.
x	number	Levý posun od počátku v jednotkách v palcích nebo centimetrech.
y	number	Horní odsazení od počátku v jednotkách v palcích nebo centimetrech.

ImageMetadataApiModel

Informace o metadatech obrázku, jako je výška a šířka.

Name	Typ	Description
height	integer	Výška obrázku v pixelech
width	integer	Šířka obrázku v pixelech

PlanogramApiModel

Popisuje planogram pro operace porovnávání planogramů.

Name	Typ	Description
fixtures	FixtureApiModel[]	Seznam přípravků v planogramu.
height	number	Výška planogramu
positions	PositionApiModel[]	Seznam pozic v planogramu
products	ProductApiModel[]	Seznam produktů v planogramu
width	number	Šířka planogramu

PlanogramMatchingRequestApiModel

Vstup, který se má předat do operace párování planogramů.

Name	Typ	Description
detectedProducts	ProductRecognitionResultApiModel	Výsledky operace porozumění produktu
planogram	PlanogramApiModel	Popisuje planogram pro operace porovnávání planogramů.

PlanogramMatchingResultApiModel

Výsledky operace párování planogramů

Name	Typ	Description
matchingResultPerPosition	PositionMatchingResultApiModel[]	Odpovídající zjištěné informace o objektu pro každou pozici planogramu.

PositionApiModel

Popisuje pozici produktu v planogramu.

Name	Typ	Description
fixtureId	string	Id přípravku, na které je výrobek.
id	string	ID pozice.
productId	string	ID produktu.
x	number	Levý posun od počátku v jednotkách v palcích nebo centimetrech.
y	number	Horní odsazení od počátku v jednotkách v palcích nebo centimetrech.

PositionMatchingResultApiModel

Spárované ID pozice planogramu a odpovídající detekovaný objekt z výsledku porozumění produktu.

Name	Typ	Description
detectedObject	DetectedObject	Popisuje rozpoznaný objekt na obrázku.
positionId	string	ID pozice z planogramu odpovídá odpovídajícímu zjištěnému objektu.

ProductApiModel

Popisuje produkt v planogramu.

Name	Typ	Description
h	number	Výška upevňovacího zařízení.
id	string	ID produktu.
name	string	Název produktu
w	number	Šířka produktu.

ProductRecognitionResultApiModel

Výsledky operace porozumění produktu

Name	Typ	Description
gaps	DetectedObject[]	Na obrázku byly zjištěny mezery.
imageMetadata	ImageMetadataApiModel	Informace o metadatech obrázku, jako je výška a šířka.
products	DetectedObject[]	Produkty zjištěné na obrázku.

Tag

Pozorování entity na obrázku spolu se skóre spolehlivosti

Name	Typ	Description
confidence	number	Úroveň spolehlivosti, kterou entita pozorovala.
name	string	Název entity.