Planogram Compliance - Match

參考

服務:: Azure AI Services

API 版本:: 2023-04-01-preview

針對計劃投影和產品了解結果執行計劃投影比對作業。

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

URI 參數

名稱	位於	必要	類型	Description
api-version	query	True	string	要求的 API 版本。

要求本文

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

名稱	必要	類型	Description
detectedProducts	True	ProductRecognitionResultApiModel	產品瞭解作業的結果。
planogram	True	PlanogramApiModel	描述計畫投影比對作業的計畫投影。

回應

名稱	類型	Description
200 OK	PlanogramMatchingResultApiModel	成功
Other Status Codes	ErrorResponse	錯誤標題 x-ms-error-code: string

名稱

類型

Description

200 OK

PlanogramMatchingResultApiModel

成功

Other Status Codes

ErrorResponse

錯誤

標題

x-ms-error-code: string

範例

PlanogramCompliance_Match

範例要求

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

範例回覆

狀態碼:: 200

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

定義

名稱	Description
BoundingBox	影像內區域的周框方塊。
DetectedObject	描述影像中偵測到的物件。
ErrorResponse	發生錯誤時傳回的回應。
ErrorResponseDetails	錯誤資訊。
ErrorResponseInnerError	詳細的錯誤。
FixtureApiModel	描述計劃圖中的裝置。
ImageMetadataApiModel	影像元數據資訊，例如高度和寬度。
PlanogramApiModel	描述計畫投影比對作業的計畫投影。
PlanogramMatchingRequestApiModel	要傳入計劃投影比對作業的輸入。
PlanogramMatchingResultApiModel	計劃投影比對作業的結果。
PositionApiModel	描述計劃圖中的產品位置。
PositionMatchingResultApiModel	配對的計畫圖位置識別碼，以及來自產品了解結果的對應偵測到物件。
ProductApiModel	描述計畫投影中的產品。
ProductRecognitionResultApiModel	產品瞭解作業的結果。
Tag	影像中的實體觀察，以及信賴分數。

BoundingBox

Object

影像內區域的周框方塊。

名稱	類型	Description
h	integer (int32) minimum: 1	從區域左上方點測量的高度，以像素為單位。
w	integer (int32) minimum: 1	以像素為單位，從區域左上方點測量的寬度。
x	integer (int32) minimum: 0	區域左上方點的左座標，以像素為單位。
y	integer (int32) minimum: 0	區域左上方點的頂端座標，以像素為單位。

DetectedObject

Object

描述影像中偵測到的物件。

名稱	類型	Description
boundingBox	BoundingBox	影像內區域的周框方塊。
id	string minLength: 1	偵測到物件的標識碼。
tags	Tag[]	偵測到物件的分類信賴度。

ErrorResponse

Object

發生錯誤時傳回的回應。

名稱	類型	Description
error	ErrorResponseDetails	錯誤資訊。

ErrorResponseDetails

Object

錯誤資訊。

名稱	類型	Description
code	string	錯誤碼。
details	ErrorResponseDetails[]	詳細的錯誤清單。
innererror	ErrorResponseInnerError	詳細的錯誤。
message	string	錯誤資訊。
target	string	錯誤的目標。

ErrorResponseInnerError

Object

詳細的錯誤。

名稱	類型	Description
code	string	錯誤碼。
innererror	ErrorResponseInnerError	詳細的錯誤。
message	string	錯誤資訊。

FixtureApiModel

Object

描述計劃圖中的裝置。

名稱	類型	Description
h	number (double)	裝置的高度。
id	string minLength: 1	裝置的標識碼。
w	number (double)	裝置的寬度。
x	number (double) minimum: 0	左位移，以英吋或公分為單位的原點。
y	number (double) minimum: 0	原點上位移，單位單位為英吋或公分。

ImageMetadataApiModel

Object

影像元數據資訊，例如高度和寬度。

名稱	類型	Description
height	integer (int32) minimum: 1	影像的高度，以像素為單位。
width	integer (int32) minimum: 1	影像的寬度，以像素為單位。

PlanogramApiModel

Object

描述計畫投影比對作業的計畫投影。

名稱	類型	Description
fixtures	FixtureApiModel[]	計畫投影中的裝置清單。
height	number (double)	計畫投影的高度。
positions	PositionApiModel[]	計畫投影中的位置清單。
products	ProductApiModel[]	Planogram 中的產品清單。
width	number (double)	計畫投影的寬度。

PlanogramMatchingRequestApiModel

Object

要傳入計劃投影比對作業的輸入。

名稱	類型	Description
detectedProducts	ProductRecognitionResultApiModel	產品瞭解作業的結果。
planogram	PlanogramApiModel	描述計畫投影比對作業的計畫投影。

PlanogramMatchingResultApiModel

Object

計劃投影比對作業的結果。

名稱	類型	Description
matchingResultPerPosition	PositionMatchingResultApiModel[]	每個計劃投影位置的相符偵測到對象資訊。

PositionApiModel

Object

描述計劃圖中的產品位置。

名稱	類型	Description
fixtureId	string minLength: 1	產品開啟的裝置標識碼。
id	string minLength: 1	位置的標識碼。
productId	string minLength: 1	產品的標識碼。
x	number (double) minimum: 0	左位移，以英吋或公分為單位的原點。
y	number (double) minimum: 0	原點上位移，單位單位為英吋或公分。

PositionMatchingResultApiModel

Object

配對的計畫圖位置識別碼，以及來自產品了解結果的對應偵測到物件。

名稱	類型	Description
detectedObject	DetectedObject	描述影像中偵測到的物件。
positionId	string minLength: 1	計畫圖中與對應偵測到的物件相符的位置識別碼。

ProductApiModel

Object

描述計畫投影中的產品。

名稱	類型	Description
h	number (double)	裝置的高度。
id	string minLength: 1	產品的標識碼。
name	string minLength: 1 maxLength: 255	產品的名稱。
w	number (double)	產品的寬度。

ProductRecognitionResultApiModel

Object

產品瞭解作業的結果。

名稱	類型	Description
gaps	DetectedObject[]	在影像中偵測到間距。
imageMetadata	ImageMetadataApiModel	影像元數據資訊，例如高度和寬度。
products	DetectedObject[]	影像中偵測到的產品。

Tag

Object

影像中的實體觀察，以及信賴分數。

名稱	類型	Description
confidence	number (double) minimum: 0 maximum: 1	觀察到實體的信賴等級。
name	string minLength: 1	實體的名稱。

共用方式為

Planogram Compliance - Match

URI 參數

要求本文

回應

範例

PlanogramCompliance_Match

範例要求

範例回覆

定義

BoundingBox

DetectedObject

ErrorResponse

ErrorResponseDetails

ErrorResponseInnerError

FixtureApiModel

ImageMetadataApiModel

PlanogramApiModel

PlanogramMatchingRequestApiModel

PlanogramMatchingResultApiModel

PositionApiModel

PositionMatchingResultApiModel

ProductApiModel

ProductRecognitionResultApiModel

Tag

其他資源