Planogram Compliance - Match

Referencia

Servicio:: Cognitive Services - Computer Vision

Versión de la API:: 2023-04-01-preview

Ejecute la operación de coincidencia de planogramas con un planograma y un resultado de comprensión del producto.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
api-version	query	True	string	Versión de API solicitada.

Cuerpo de la solicitud

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

Nombre	Requerido	Tipo	Description
detectedProducts	True	ProductRecognitionResultApiModel	Resultados de la operación de descripción del producto.
planogram	True	PlanogramApiModel	Describe el planograma para las operaciones de coincidencia de planogramas.

Respuestas

Nombre	Tipo	Description
200 OK	PlanogramMatchingResultApiModel	Correcto
Other Status Codes	ErrorResponse	Error Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

PlanogramMatchingResultApiModel

Correcto

Other Status Codes

ErrorResponse

Error

Encabezados

x-ms-error-code: string

Ejemplos

PlanogramCompliance_Match

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
BoundingBox	Un rectángulo delimitador para un área dentro de una imagen.
DetectedObject	Describe un objeto detectado en una imagen.
ErrorResponse	Respuesta devuelta cuando se produce un error.
ErrorResponseDetails	Información de error.
ErrorResponseInnerError	Error detallado.
FixtureApiModel	Describe un accesorio en un planograma.
ImageMetadataApiModel	La información de metadatos de la imagen, como el alto y el ancho.
PlanogramApiModel	Describe el planograma para las operaciones de coincidencia de planogramas.
PlanogramMatchingRequestApiModel	Entrada para pasar a la operación de coincidencia de planogramas.
PlanogramMatchingResultApiModel	Resultados de la operación de coincidencia de planogramas.
PositionApiModel	Describe una posición de producto en un planograma.
PositionMatchingResultApiModel	Identificador de posición del planograma coincidente y el objeto detectado correspondiente del resultado de reconocimiento del producto.
ProductApiModel	Describe un producto en el planograma.
ProductRecognitionResultApiModel	Resultados de la operación de descripción del producto.
Tag	Observación de entidad en la imagen, junto con la puntuación de confianza.

BoundingBox

Un rectángulo delimitador para un área dentro de una imagen.

Nombre	Tipo	Description
h	integer	Alto medido desde el punto superior izquierdo del área, en píxeles.
w	integer	Ancho medido desde el punto superior izquierdo del área, en píxeles.
x	integer	Coordenada izquierda del punto superior izquierdo del área, en píxeles.
y	integer	Coordenada superior del punto superior izquierdo del área, en píxeles.

DetectedObject

Describe un objeto detectado en una imagen.

Nombre	Tipo	Description
boundingBox	BoundingBox	Un rectángulo delimitador para un área dentro de una imagen.
id	string	Identificador del objeto detectado.
tags	Tag[]	Confianzas de clasificación del objeto detectado.

ErrorResponse

Respuesta devuelta cuando se produce un error.

Nombre	Tipo	Description
error	ErrorResponseDetails	Información de error.

ErrorResponseDetails

Información de error.

Nombre	Tipo	Description
code	string	Código de error.
details	ErrorResponseDetails[]	Lista de errores detallados.
innererror	ErrorResponseInnerError	Error detallado.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponseInnerError

Error detallado.

Nombre	Tipo	Description
code	string	Código de error.
innererror	ErrorResponseInnerError	Error detallado.
message	string	Mensaje de error.

FixtureApiModel

Describe un accesorio en un planograma.

Nombre	Tipo	Description
h	number	Alto del accesorio.
id	string	Id. del accesorio.
w	number	Ancho del accesorio.
x	number	Desplazamiento izquierdo desde el origen, en unidad de en pulgadas o centímetros.
y	number	Desplazamiento superior desde el origen, en unidad de en pulgadas o centímetros.

ImageMetadataApiModel

La información de metadatos de la imagen, como el alto y el ancho.

Nombre	Tipo	Description
height	integer	Alto de la imagen en píxeles.
width	integer	Ancho de la imagen en píxeles.

PlanogramApiModel

Describe el planograma para las operaciones de coincidencia de planogramas.

Nombre	Tipo	Description
fixtures	FixtureApiModel[]	Lista de accesorios en el planograma.
height	number	Alto del planograma.
positions	PositionApiModel[]	Lista de posiciones en el planograma.
products	ProductApiModel[]	Lista de productos en el planograma.
width	number	Ancho del planograma.

PlanogramMatchingRequestApiModel

Entrada para pasar a la operación de coincidencia de planogramas.

Nombre	Tipo	Description
detectedProducts	ProductRecognitionResultApiModel	Resultados de la operación de descripción del producto.
planogram	PlanogramApiModel	Describe el planograma para las operaciones de coincidencia de planogramas.

PlanogramMatchingResultApiModel

Resultados de la operación de coincidencia de planogramas.

Nombre	Tipo	Description
matchingResultPerPosition	PositionMatchingResultApiModel[]	Información del objeto detectado coincidente para cada posición de planograma.

PositionApiModel

Describe una posición de producto en un planograma.

Nombre	Tipo	Description
fixtureId	string	Id. del accesorio en el que está activado el producto.
id	string	Id. de la posición.
productId	string	Id. del producto.
x	number	Desplazamiento izquierdo desde el origen, en unidad de en pulgadas o centímetros.
y	number	Desplazamiento superior desde el origen, en unidad de en pulgadas o centímetros.

PositionMatchingResultApiModel

Identificador de posición del planograma coincidente y el objeto detectado correspondiente del resultado de reconocimiento del producto.

Nombre	Tipo	Description
detectedObject	DetectedObject	Describe un objeto detectado en una imagen.
positionId	string	Identificador de posición del planograma coincidente con el objeto detectado correspondiente.

ProductApiModel

Describe un producto en el planograma.

Nombre	Tipo	Description
h	number	Alto del accesorio.
id	string	Id. del producto.
name	string	Nombre del producto.
w	number	Ancho del producto.

ProductRecognitionResultApiModel

Resultados de la operación de descripción del producto.

Nombre	Tipo	Description
gaps	DetectedObject[]	Huecos detectados en la imagen.
imageMetadata	ImageMetadataApiModel	La información de metadatos de la imagen, como el alto y el ancho.
products	DetectedObject[]	Productos detectados en la imagen.

Tag

Observación de entidad en la imagen, junto con la puntuación de confianza.

Nombre	Tipo	Description
confidence	number	Nivel de confianza de que se observó la entidad.
name	string	Nombre de la entidad.

Compartir a través de

Planogram Compliance - Match

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

PlanogramCompliance_Match

Solicitud de ejemplo

Respuesta de muestra

Definiciones

BoundingBox

DetectedObject

ErrorResponse

ErrorResponseDetails

ErrorResponseInnerError

FixtureApiModel

ImageMetadataApiModel

PlanogramApiModel

PlanogramMatchingRequestApiModel

PlanogramMatchingResultApiModel

PositionApiModel

PositionMatchingResultApiModel

ProductApiModel

ProductRecognitionResultApiModel

Tag

Recursos adicionales