Planogram Compliance - Match

Ссылка

Служба:: Azure AI Services

Версия API:: 2023-04-01-preview

Выполните операцию сопоставления планограммы с планограммой и результатом понимания продукта.

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	Входные данные для передачи в операцию сопоставления планограммы.
PlanogramMatchingResultApiModel	Результаты операции сопоставления планограммы.
PositionApiModel	Описывает положение продукта в планограмме.
PositionMatchingResultApiModel	Идентификатор спарной планограммы и соответствующий обнаруженный объект из результата понимания продукта.
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	Идентификатор обнаруженного объекта.
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	Идентификатор светильника.
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

Входные данные для передачи в операцию сопоставления планограммы.

Имя	Тип	Описание
detectedProducts	ProductRecognitionResultApiModel	Результаты операции понимания продукта.
planogram	PlanogramApiModel	Описывает планограмму для операций сопоставления планограмм.

PlanogramMatchingResultApiModel

Object

Результаты операции сопоставления планограммы.

Имя	Тип	Описание
matchingResultPerPosition	PositionMatchingResultApiModel[]	Соответствующие обнаруженные сведения об объекте для каждой позиции планограммы.

PositionApiModel

Object

Описывает положение продукта в планограмме.

Имя	Тип	Описание
fixtureId	string minLength: 1	Идентификатор светильника, на который находится продукт.
id	string minLength: 1	Идентификатор позиции.
productId	string minLength: 1	Идентификатор продукта.
x	number (double) minimum: 0	Левое смещение от источника, в единице в дюймах или сантиметрах.
y	number (double) minimum: 0	Верхнее смещение от источника в единицах в дюймах или сантиметрах.

PositionMatchingResultApiModel

Object

Идентификатор спарной планограммы и соответствующий обнаруженный объект из результата понимания продукта.

Имя	Тип	Описание
detectedObject	DetectedObject	Описывает обнаруженный объект на изображении.
positionId	string minLength: 1	Идентификатор позиции из планограммы, сопоставленной с соответствующим обнаруженным объектом.

ProductApiModel

Object

Описывает продукт в планограмме.

Имя	Тип	Описание
h	number (double)	Высота светильника.
id	string minLength: 1	Идентификатор продукта.
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