Planogram Compliance - Match

リファレンス

サービス:: Azure AI Services

API バージョン:: 2023-04-01-preview

Planogram と製品の理解の結果に対して、Planogram 照合操作を実行します。

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

URI パラメーター

名前	/	必須	型	説明
api-version	query	True	string	要求された API バージョン。

要求本文

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

名前	必須	型	説明
detectedProducts	True	ProductRecognitionResultApiModel	製品理解操作の結果。
planogram	True	PlanogramApiModel	プラノグラム照合操作のプラノグラムについて記述します。

応答

名前	型	説明
200 OK	PlanogramMatchingResultApiModel	成功
Other Status Codes	ErrorResponse	エラーヘッダー x-ms-error-code: string

名前

型

説明

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

定義

名前	説明
BoundingBox	イメージ内の領域の境界ボックス。
DetectedObject	画像内で検出されたオブジェクトについての説明。
ErrorResponse	エラーが発生したときに返される応答。
ErrorResponseDetails	エラー情報。
ErrorResponseInnerError	詳細なエラー。
FixtureApiModel	プラノグラム内のフィクスチャについて説明します。
ImageMetadataApiModel	高さと幅などの画像メタデータ情報。
PlanogramApiModel	プラノグラム照合操作のプラノグラムについて記述します。
PlanogramMatchingRequestApiModel	Planogram 照合操作に渡す入力。
PlanogramMatchingResultApiModel	Planogram 照合操作の結果。
PositionApiModel	プラノグラム内の製品の位置について説明します。
PositionMatchingResultApiModel	プラノグラム位置 ID と、商品理解の結果から検出された対応する物体のペア。
ProductApiModel	プラノグラム内の商品について記述します。
ProductRecognitionResultApiModel	製品理解操作の結果。
Tag	信頼度スコアと共に、画像内のエンティティの観察。

BoundingBox

Object

イメージ内の領域の境界ボックス。

名前	型	説明
h	integer (int32) minimum: 1	領域の左上のポイントからピクセル単位で測定された高さ。
w	integer (int32) minimum: 1	領域の左上のポイントからピクセル単位で測定された幅。
x	integer (int32) minimum: 0	領域の左上の点の左座標 (ピクセル単位)。
y	integer (int32) minimum: 0	領域の左上の点の上座標 (ピクセル単位)。

DetectedObject

Object

画像内で検出されたオブジェクトについての説明。

名前	型	説明
boundingBox	BoundingBox	イメージ内の領域の境界ボックス。
id	string minLength: 1	検出されたオブジェクトの ID。
tags	Tag[]	検出されたオブジェクトの分類の信頼度。

ErrorResponse

Object

エラーが発生したときに返される応答。

名前	型	説明
error	ErrorResponseDetails	エラー情報。

ErrorResponseDetails

Object

エラー情報。

名前	型	説明
code	string	エラーコード。
details	ErrorResponseDetails[]	詳細なエラーの一覧。
innererror	ErrorResponseInnerError	詳細なエラー。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponseInnerError

Object

詳細なエラー。

名前	型	説明
code	string	エラーコード。
innererror	ErrorResponseInnerError	詳細なエラー。
message	string	エラーメッセージ。

FixtureApiModel

Object

プラノグラム内のフィクスチャについて説明します。

名前	型	説明
h	number (double)	備品の高さ。
id	string minLength: 1	フィクスチャの ID。
w	number (double)	備品の幅。
x	number (double) minimum: 0	原点からの左オフセット (インチまたはセンチメートル単位)。
y	number (double) minimum: 0	原点からの上端オフセット (インチまたはセンチメートル単位)。

ImageMetadataApiModel

Object

高さと幅などの画像メタデータ情報。

名前	型	説明
height	integer (int32) minimum: 1	イメージの高さ (ピクセル単位)。
width	integer (int32) minimum: 1	イメージの幅 (ピクセル単位)。

PlanogramApiModel

Object

プラノグラム照合操作のプラノグラムについて記述します。

名前	型	説明
fixtures	FixtureApiModel[]	プラノグラム内の備品のリスト。
height	number (double)	プラノグラムの高さ。
positions	PositionApiModel[]	プラノグラム内の位置のリスト。
products	ProductApiModel[]	プラノグラム内の商品のリスト。
width	number (double)	プラノグラムの幅。

PlanogramMatchingRequestApiModel

Object

Planogram 照合操作に渡す入力。

名前	型	説明
detectedProducts	ProductRecognitionResultApiModel	製品理解操作の結果。
planogram	PlanogramApiModel	プラノグラム照合操作のプラノグラムについて記述します。

PlanogramMatchingResultApiModel

Object

Planogram 照合操作の結果。

名前	型	説明
matchingResultPerPosition	PositionMatchingResultApiModel[]	各プラノグラム位置に対して検出された一致したオブジェクト情報。

PositionApiModel

Object

プラノグラム内の製品の位置について説明します。

名前	型	説明
fixtureId	string minLength: 1	製品がオンになっているフィクスチャの ID。
id	string minLength: 1	位置の ID。
productId	string minLength: 1	製品の ID。
x	number (double) minimum: 0	原点からの左オフセット (インチまたはセンチメートル単位)。
y	number (double) minimum: 0	原点からの上端オフセット (インチまたはセンチメートル単位)。

PositionMatchingResultApiModel

Object

プラノグラム位置 ID と、商品理解の結果から検出された対応する物体のペア。

名前	型	説明
detectedObject	DetectedObject	画像内で検出されたオブジェクトについての説明。
positionId	string minLength: 1	検出された対応するオブジェクトと照合されたプラノグラムからの位置 ID。

ProductApiModel

Object

プラノグラム内の商品について記述します。

名前	型	説明
h	number (double)	備品の高さ。
id	string minLength: 1	製品の ID。
name	string minLength: 1 maxLength: 255	製品の名前。
w	number (double)	商品の幅。

ProductRecognitionResultApiModel

Object

製品理解操作の結果。

名前	型	説明
gaps	DetectedObject[]	画像で検出された隙間。
imageMetadata	ImageMetadataApiModel	高さと幅などの画像メタデータ情報。
products	DetectedObject[]	画像で検出された製品。

Tag

Object

信頼度スコアと共に、画像内のエンティティの観察。

名前	型	説明
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