Planogram Compliance - Match

Service:

Cognitive Services - Computer Vision

API-versie:

2023-04-01-preview

Voer de bewerking planogramkoppeling uit op basis van een planogram en een productbegripresultaat.

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

URI-parameters

Name	In	Vereist	Type	Description
api-version	query	True	string	Aangevraagde API-versie.

Aanvraagbody

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

Name	Vereist	Type	Description
detectedProducts	True	ProductRecognitionResultApiModel	Resultaten van de bewerking productkennis.
planogram	True	PlanogramApiModel	Beschrijft het planogram voor planogram-overeenkomende bewerkingen.

Antwoorden

Name	Type	Description
200 OK	PlanogramMatchingResultApiModel	Geslaagd
Other Status Codes	ErrorResponse	Fout Kopteksten x-ms-error-code: string

Voorbeelden

PlanogramCompliance_Match

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

200

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

Definities

Name	Description
BoundingBox	Een begrenzingsvak voor een gebied in een afbeelding.
DetectedObject	Beschrijft een gedetecteerd object in een afbeelding.
ErrorResponse	Antwoord geretourneerd wanneer er een fout optreedt.
ErrorResponseDetails	Foutinformatie.
ErrorResponseInnerError	Gedetailleerde fout.
FixtureApiModel	Beschrijft een armatuur in een planogram.
ImageMetadataApiModel	De metagegevens van de afbeelding, zoals hoogte en breedte.
PlanogramApiModel	Beschrijft het planogram voor planogram-overeenkomende bewerkingen.
PlanogramMatchingRequestApiModel	Invoer die moet worden doorgegeven aan de overeenkomende planogrambewerking.
PlanogramMatchingResultApiModel	Resultaten van de overeenkomende planogrambewerking.
PositionApiModel	Beschrijft een productpositie in een planogram.
PositionMatchingResultApiModel	Gekoppelde positie-id van planogram en het bijbehorende gedetecteerde object van productbegripresultaat.
ProductApiModel	Beschrijft een product in het planogram.
ProductRecognitionResultApiModel	Resultaten van de bewerking productkennis.
Tag	Een entiteitsobservatie in de afbeelding, samen met de betrouwbaarheidsscore.

BoundingBox

Een begrenzingsvak voor een gebied in een afbeelding.

Name	Type	Description
h	integer	Hoogte gemeten vanaf het punt linksboven in het gebied, in pixels.
w	integer	Breedte gemeten vanaf het punt linksboven in het gebied, in pixels.
x	integer	Linkercoördinaat van het punt linksboven in het gebied, in pixels.
y	integer	Bovenste coördinaat van het punt linksboven in het gebied, in pixels.

DetectedObject

Beschrijft een gedetecteerd object in een afbeelding.

Name	Type	Description
boundingBox	BoundingBox	Een begrenzingsvak voor een gebied in een afbeelding.
id	string	Id van het gedetecteerde object.
tags	Tag[]	Classificatievertrouwen van het gedetecteerde object.

ErrorResponse

Antwoord geretourneerd wanneer er een fout optreedt.

Name	Type	Description
error	ErrorResponseDetails	Foutinformatie.

ErrorResponseDetails

Foutinformatie.

Name	Type	Description
code	string	Foutcode.
details	ErrorResponseDetails[]	Lijst met gedetailleerde fouten.
innererror	ErrorResponseInnerError	Gedetailleerde fout.
message	string	Foutbericht.
target	string	Doel van de fout.

ErrorResponseInnerError

Gedetailleerde fout.

Name	Type	Description
code	string	Foutcode.
innererror	ErrorResponseInnerError	Gedetailleerde fout.
message	string	Foutbericht.

FixtureApiModel

Beschrijft een armatuur in een planogram.

Name	Type	Description
h	number	Hoogte van het armatuur.
id	string	Id van het armatuur.
w	number	Breedte van het armatuur.
x	number	Verschuiving links ten opzichte van de oorsprong, in eenheid van inches of centimeters.
y	number	Bovenste verschuiving ten opzichte van de oorsprong, in eenheid van inches of centimeters.

ImageMetadataApiModel

De metagegevens van de afbeelding, zoals hoogte en breedte.

Name	Type	Description
height	integer	De hoogte van de afbeelding in pixels.
width	integer	De breedte van de afbeelding in pixels.

PlanogramApiModel

Beschrijft het planogram voor planogram-overeenkomende bewerkingen.

Name	Type	Description
fixtures	FixtureApiModel[]	Lijst met armaturen in het planogram.
height	number	Hoogte van het planogram.
positions	PositionApiModel[]	Lijst met posities in het planogram.
products	ProductApiModel[]	Lijst met producten in het planogram.
width	number	Breedte van het planogram.

PlanogramMatchingRequestApiModel

Invoer die moet worden doorgegeven aan de overeenkomende planogrambewerking.

Name	Type	Description
detectedProducts	ProductRecognitionResultApiModel	Resultaten van de bewerking productkennis.
planogram	PlanogramApiModel	Beschrijft het planogram voor planogram-overeenkomende bewerkingen.

PlanogramMatchingResultApiModel

Resultaten van de overeenkomende planogrambewerking.

Name	Type	Description
matchingResultPerPosition	PositionMatchingResultApiModel[]	De overeenkomende gedetecteerde objectgegevens voor elke planogrampositie.

PositionApiModel

Beschrijft een productpositie in een planogram.

Name	Type	Description
fixtureId	string	Id van het armatuur waarop het product zich bevindt.
id	string	Id van de positie.
productId	string	Id van het product.
x	number	Verschuiving links ten opzichte van de oorsprong, in eenheid van inches of centimeters.
y	number	Bovenste verschuiving ten opzichte van de oorsprong, in eenheid van inches of centimeters.

PositionMatchingResultApiModel

Gekoppelde positie-id van planogram en het bijbehorende gedetecteerde object van productbegripresultaat.

Name	Type	Description
detectedObject	DetectedObject	Beschrijft een gedetecteerd object in een afbeelding.
positionId	string	De positie-id van het planogram die overeenkomt met het bijbehorende gedetecteerde object.

ProductApiModel

Beschrijft een product in het planogram.

Name	Type	Description
h	number	Hoogte van het armatuur.
id	string	Id van het product.
name	string	De naam van het product.
w	number	Breedte van het product.

ProductRecognitionResultApiModel

Resultaten van de bewerking productkennis.

Name	Type	Description
gaps	DetectedObject[]	Er zijn hiaten in de afbeelding gedetecteerd.
imageMetadata	ImageMetadataApiModel	De metagegevens van de afbeelding, zoals hoogte en breedte.
products	DetectedObject[]	Producten gedetecteerd in de afbeelding.

Tag

Een entiteitsobservatie in de afbeelding, samen met de betrouwbaarheidsscore.

Name	Type	Description
confidence	number	Het betrouwbaarheidsniveau dat de entiteit is waargenomen.
name	string	Naam van de entiteit.