Udostępnij za pośrednictwem

Planogram Compliance - Match

  • Odwołanie
Usługa:
Cognitive Services - Computer Vision
Wersja interfejsu API:
2023-04-01-preview

Uruchom operację dopasowywania planogramu względem planogramu i wyniku zrozumienia produktu.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
api-version
 query True

string

Żądana wersja interfejsu API.

Treść żądania

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

Nazwa Wymagane Typ Opis
detectedProducts True

ProductRecognitionResultApiModel

Wyniki operacji zrozumienia produktu.
planogram True

PlanogramApiModel

Opisuje planogram operacji dopasowywania planogramu.

Odpowiedzi

Nazwa Typ Opis
200 OK

PlanogramMatchingResultApiModel

Powodzenie
Other Status Codes

ErrorResponse

Błąd

Nagłówki

x-ms-error-code: string

Przykłady

PlanogramCompliance_Match

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
BoundingBox

Pole ograniczenia obszaru wewnątrz obrazu.
DetectedObject

Opisuje wykryty obiekt na obrazie.
ErrorResponse

Odpowiedź zwrócona po wystąpieniu błędu.
ErrorResponseDetails

Informacje o błędzie.
ErrorResponseInnerError

Szczegółowy błąd.
FixtureApiModel

Opisuje oprawę w planogramie.
ImageMetadataApiModel

Informacje o metadanych obrazu, takie jak wysokość i szerokość.
PlanogramApiModel

Opisuje planogram operacji dopasowywania planogramu.
PlanogramMatchingRequestApiModel

Dane wejściowe przekazywane do operacji dopasowywania planogramu.
PlanogramMatchingResultApiModel

Wyniki z operacji dopasowania planogramu.
PositionApiModel

Opisuje pozycję produktu w planogramie.
PositionMatchingResultApiModel

Sparowany identyfikator położenia planogramu i odpowiadający mu obiekt wykryty z wyniku zrozumienia produktu.
ProductApiModel

Opisuje produkt w planogramie.
ProductRecognitionResultApiModel

Wyniki operacji zrozumienia produktu.
Tag

Obserwacja jednostki na obrazie wraz z wynikiem ufności.

BoundingBox

Pole ograniczenia obszaru wewnątrz obrazu.

Nazwa Typ Opis
h

integer

Wysokość mierzona od lewego górnego punktu obszaru w pikselach.
w

integer

Szerokość mierzona od lewego górnego punktu obszaru w pikselach.
x

integer

Współrzędna lewa w lewym górnym punkcie obszaru w pikselach.
y

integer

Górna współrzędna lewego górnego punktu obszaru w pikselach.

DetectedObject

Opisuje wykryty obiekt na obrazie.

Nazwa Typ Opis
boundingBox

BoundingBox

Pole ograniczenia obszaru wewnątrz obrazu.
id

string

Identyfikator wykrytego obiektu.
tags

Tag[]

Zaufania klasyfikacji wykrytego obiektu.

ErrorResponse

Odpowiedź zwrócona po wystąpieniu błędu.

Nazwa Typ Opis
error

ErrorResponseDetails

Informacje o błędzie.

ErrorResponseDetails

Informacje o błędzie.

Nazwa Typ Opis
code

string

Kod błędu.
details

ErrorResponseDetails[]

Lista szczegółowych błędów.
innererror

ErrorResponseInnerError

Szczegółowy błąd.
message

string

Komunikat o błędzie.
target

string

Element docelowy błędu.

ErrorResponseInnerError

Szczegółowy błąd.

Nazwa Typ Opis
code

string

Kod błędu.
innererror

ErrorResponseInnerError

Szczegółowy błąd.
message

string

Komunikat o błędzie.

FixtureApiModel

Opisuje oprawę w planogramie.

Nazwa Typ Opis
h

number

Wysokość oprawy.
id

string

Identyfikator oprawy.
w

number

Szerokość oprawy.
x

number

Lewe przesunięcie ze źródła, w jednostce cali lub centymetrów.
y

number

Przesunięcie górne od źródła, w jednostce cali lub centymetrów.

ImageMetadataApiModel

Informacje o metadanych obrazu, takie jak wysokość i szerokość.

Nazwa Typ Opis
height

integer

Wysokość obrazu w pikselach.
width

integer

Szerokość obrazu w pikselach.

PlanogramApiModel

Opisuje planogram operacji dopasowywania planogramu.

Nazwa Typ Opis
fixtures

FixtureApiModel[]

Lista opraw w planogramie.
height

number

Wysokość planogramu.
positions

PositionApiModel[]

Lista pozycji na planogramie.
products

ProductApiModel[]

Lista produktów na planogramie.
width

number

Szerokość planogramu.

PlanogramMatchingRequestApiModel

Dane wejściowe przekazywane do operacji dopasowywania planogramu.

Nazwa Typ Opis
detectedProducts

ProductRecognitionResultApiModel

Wyniki operacji zrozumienia produktu.
planogram

PlanogramApiModel

Opisuje planogram operacji dopasowywania planogramu.

PlanogramMatchingResultApiModel

Wyniki z operacji dopasowania planogramu.

Nazwa Typ Opis
matchingResultPerPosition

PositionMatchingResultApiModel[]

Dopasowane informacje o obiekcie wykryte dla każdej pozycji planogramu.

PositionApiModel

Opisuje pozycję produktu w planogramie.

Nazwa Typ Opis
fixtureId

string

Identyfikator urządzenia, na który jest włączony produkt.
id

string

Identyfikator pozycji.
productId

string

Identyfikator produktu.
x

number

Lewe przesunięcie ze źródła, w jednostce cali lub centymetrów.
y

number

Przesunięcie górne od źródła, w jednostce cali lub centymetrów.

PositionMatchingResultApiModel

Sparowany identyfikator położenia planogramu i odpowiadający mu obiekt wykryty z wyniku zrozumienia produktu.

Nazwa Typ Opis
detectedObject

DetectedObject

Opisuje wykryty obiekt na obrazie.
positionId

string

Identyfikator pozycji z planogramu dopasowany do odpowiedniego wykrytego obiektu.

ProductApiModel

Opisuje produkt w planogramie.

Nazwa Typ Opis
h

number

Wysokość oprawy.
id

string

Identyfikator produktu.
name

string

Nazwa produktu.
w

number

Szerokość produktu.

ProductRecognitionResultApiModel

Wyniki operacji zrozumienia produktu.

Nazwa Typ Opis
gaps

DetectedObject[]

Wykryto luki na obrazie.
imageMetadata

ImageMetadataApiModel

Informacje o metadanych obrazu, takie jak wysokość i szerokość.
products

DetectedObject[]

Produkty wykryte na obrazie.

Tag

Obserwacja jednostki na obrazie wraz z wynikiem ufności.

Nazwa Typ Opis
confidence

number

Poziom pewności, że zaobserwowano jednostkę.
name

string

Nazwa jednostki.