Planogram Compliance - Match

Layanan:

Cognitive Services - Computer Vision

Versi API:

2023-04-01-preview

Jalankan operasi pencocokan planogram terhadap planogram dan hasil pemahaman produk.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
api-version	query	True	string	Versi API yang diminta.

Isi Permintaan

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

Nama	Diperlukan	Jenis	Deskripsi
detectedProducts	True	ProductRecognitionResultApiModel	Hasil dari operasi pemahaman produk.
planogram	True	PlanogramApiModel	Menjelaskan planogram untuk operasi pencocokan planogram.

Respons

Nama	Jenis	Deskripsi
200 OK	PlanogramMatchingResultApiModel	Berhasil
Other Status Codes	ErrorResponse	Kesalahan Header x-ms-error-code: string

Contoh

PlanogramCompliance_Match

Permintaan sampel

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

Respon sampel

Kode status:

200

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

Definisi

Nama	Deskripsi
BoundingBox	Kotak pembatas untuk area di dalam gambar.
DetectedObject	Menjelaskan objek yang terdeteksi dalam gambar.
ErrorResponse	Respons dikembalikan saat terjadi kesalahan.
ErrorResponseDetails	Info kesalahan.
ErrorResponseInnerError	Kesalahan terperinci.
FixtureApiModel	Menjelaskan perlengkapan dalam planogram.
ImageMetadataApiModel	Informasi metadata gambar seperti tinggi dan lebar.
PlanogramApiModel	Menjelaskan planogram untuk operasi pencocokan planogram.
PlanogramMatchingRequestApiModel	Input untuk diteruskan ke operasi pencocokan planogram.
PlanogramMatchingResultApiModel	Hasil dari operasi pencocokan planogram.
PositionApiModel	Menjelaskan posisi produk dalam planogram.
PositionMatchingResultApiModel	ID posisi planogram yang dipasangkan dan objek yang terdeteksi terkait dari hasil pemahaman produk.
ProductApiModel	Menjelaskan produk dalam planogram.
ProductRecognitionResultApiModel	Hasil dari operasi pemahaman produk.
Tag	Pengamatan entitas dalam gambar, bersama dengan skor keyakinan.

BoundingBox

Kotak pembatas untuk area di dalam gambar.

Nama	Jenis	Deskripsi
h	integer	Tinggi diukur dari titik kiri atas area, dalam piksel.
w	integer	Lebar diukur dari titik kiri atas area, dalam piksel.
x	integer	Koordinat kiri titik kiri atas area, dalam piksel.
y	integer	Koordinat atas titik kiri atas area, dalam piksel.

DetectedObject

Menjelaskan objek yang terdeteksi dalam gambar.

Nama	Jenis	Deskripsi
boundingBox	BoundingBox	Kotak pembatas untuk area di dalam gambar.
id	string	Id objek yang terdeteksi.
tags	Tag[]	Keyakinan klasifikasi objek yang terdeteksi.

ErrorResponse

Respons dikembalikan saat terjadi kesalahan.

Nama	Jenis	Deskripsi
error	ErrorResponseDetails	Info kesalahan.

ErrorResponseDetails

Info kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode Kesalahan.
details	ErrorResponseDetails[]	Daftar kesalahan terperinci.
innererror	ErrorResponseInnerError	Kesalahan terperinci.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponseInnerError

Kesalahan terperinci.

Nama	Jenis	Deskripsi
code	string	Kode Kesalahan.
innererror	ErrorResponseInnerError	Kesalahan terperinci.
message	string	Pesan kesalahan.

FixtureApiModel

Menjelaskan perlengkapan dalam planogram.

Nama	Jenis	Deskripsi
h	number	Tinggi perlengkapan.
id	string	Id perlengkapan.
w	number	Lebar perlengkapan.
x	number	Offset kiri dari asal, dalam satuan inci atau sentimeter.
y	number	Offset teratas dari asal, dalam satuan inci atau sentimeter.

ImageMetadataApiModel

Informasi metadata gambar seperti tinggi dan lebar.

Nama	Jenis	Deskripsi
height	integer	Tinggi gambar dalam piksel.
width	integer	Lebar gambar dalam piksel.

PlanogramApiModel

Menjelaskan planogram untuk operasi pencocokan planogram.

Nama	Jenis	Deskripsi
fixtures	FixtureApiModel[]	Daftar perlengkapan dalam planogram.
height	number	Tinggi planogram.
positions	PositionApiModel[]	Daftar posisi dalam planogram.
products	ProductApiModel[]	Daftar produk dalam planogram.
width	number	Lebar planogram.

PlanogramMatchingRequestApiModel

Input untuk diteruskan ke operasi pencocokan planogram.

Nama	Jenis	Deskripsi
detectedProducts	ProductRecognitionResultApiModel	Hasil dari operasi pemahaman produk.
planogram	PlanogramApiModel	Menjelaskan planogram untuk operasi pencocokan planogram.

PlanogramMatchingResultApiModel

Hasil dari operasi pencocokan planogram.

Nama	Jenis	Deskripsi
matchingResultPerPosition	PositionMatchingResultApiModel[]	Informasi objek yang terdeteksi yang cocok untuk setiap posisi planogram.

PositionApiModel

Menjelaskan posisi produk dalam planogram.

Nama	Jenis	Deskripsi
fixtureId	string	Id dari perlengkapan tempat produk berada.
id	string	Id posisi.
productId	string	Id produk.
x	number	Offset kiri dari asal, dalam satuan inci atau sentimeter.
y	number	Offset teratas dari asal, dalam satuan inci atau sentimeter.

PositionMatchingResultApiModel

ID posisi planogram yang dipasangkan dan objek yang terdeteksi terkait dari hasil pemahaman produk.

Nama	Jenis	Deskripsi
detectedObject	DetectedObject	Menjelaskan objek yang terdeteksi dalam gambar.
positionId	string	ID posisi dari planogram yang cocok dengan objek yang terdeteksi terkait.

ProductApiModel

Menjelaskan produk dalam planogram.

Nama	Jenis	Deskripsi
h	number	Tinggi perlengkapan.
id	string	Id produk.
name	string	Nama produk.
w	number	Lebar produk.

ProductRecognitionResultApiModel

Hasil dari operasi pemahaman produk.

Nama	Jenis	Deskripsi
gaps	DetectedObject[]	Celah terdeteksi dalam gambar.
imageMetadata	ImageMetadataApiModel	Informasi metadata gambar seperti tinggi dan lebar.
products	DetectedObject[]	Produk yang terdeteksi dalam gambar.

Tag

Pengamatan entitas dalam gambar, bersama dengan skor keyakinan.

Nama	Jenis	Deskripsi
confidence	number	Tingkat keyakinan bahwa entitas diamati.
name	string	Nama entitas.