Planogram Compliance - Match

Serviço:

Azure AI Services

Versão da API:

2023-04-01-preview

Execute a operação de correspondência de planograma em relação a um planograma e um resultado de compreensão do produto.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
api-version	query	True	string	Versão da API solicitada.

Corpo da solicitação

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

Nome	Obrigatório	Tipo	Description
detectedProducts	True	ProductRecognitionResultApiModel	Resultados da operação de compreensão do produto.
planogram	True	PlanogramApiModel	Descreve o planograma para operações de correspondência de planograma.

Respostas

Nome	Tipo	Description
200 OK	PlanogramMatchingResultApiModel	Êxito
Other Status Codes	ErrorResponse	Erro Cabeçalhos x-ms-error-code: string

Exemplos

PlanogramCompliance_Match

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

200

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

Definições

Nome	Description
BoundingBox	Uma caixa delimitadora para uma área dentro de uma imagem.
DetectedObject	Descreve um objeto detectado em uma imagem.
ErrorResponse	Resposta retornada quando ocorre um erro.
ErrorResponseDetails	Informações de erro.
ErrorResponseInnerError	Erro detalhado.
FixtureApiModel	Descreve uma luminária em um planograma.
ImageMetadataApiModel	As informações de metadados da imagem, como altura e largura.
PlanogramApiModel	Descreve o planograma para operações de correspondência de planograma.
PlanogramMatchingRequestApiModel	Entrada para passar para a operação de correspondência de planograma.
PlanogramMatchingResultApiModel	Resultados da operação de correspondência de planograma.
PositionApiModel	Descreve uma posição do produto em um planograma.
PositionMatchingResultApiModel	O par unido da ID de posição do planograma com o objeto detectado correspondente do resultado da compreensão do produto.
ProductApiModel	Descreve um produto no planograma.
ProductRecognitionResultApiModel	Resultados da operação de compreensão do produto.
Tag	Uma observação de entidade na imagem, juntamente com a pontuação de confiança.

BoundingBox

Objeto

Uma caixa delimitadora para uma área dentro de uma imagem.

Nome	Tipo	Description
h	integer (int32) minimum: 1	Altura medida do ponto superior esquerdo da área, em pixels.
w	integer (int32) minimum: 1	Largura medida do ponto superior esquerdo da área, em pixels.
x	integer (int32) minimum: 0	Coordenada esquerda do ponto superior esquerdo da área, em pixels.
y	integer (int32) minimum: 0	Coordenada superior do ponto superior esquerdo da área, em pixels.

DetectedObject

Objeto

Descreve um objeto detectado em uma imagem.

Nome	Tipo	Description
boundingBox	BoundingBox	Uma caixa delimitadora para uma área dentro de uma imagem.
id	string minLength: 1	ID do objeto detectado.
tags	Tag[]	Confianças de classificação do objeto detectado.

ErrorResponse

Objeto

Resposta retornada quando ocorre um erro.

Nome	Tipo	Description
error	ErrorResponseDetails	Informações de erro.

ErrorResponseDetails

Objeto

Informações de erro.

Nome	Tipo	Description
code	string	Código de erro.
details	ErrorResponseDetails[]	Lista de erros detalhados.
innererror	ErrorResponseInnerError	Erro detalhado.
message	string	Mensagem de erro.
target	string	Destino do erro.

ErrorResponseInnerError

Objeto

Erro detalhado.

Nome	Tipo	Description
code	string	Código de erro.
innererror	ErrorResponseInnerError	Erro detalhado.
message	string	Mensagem de erro.

FixtureApiModel

Objeto

Descreve uma luminária em um planograma.

Nome	Tipo	Description
h	number (double)	Altura do acessório.
id	string minLength: 1	Id da luminária.
w	number (double)	Largura do acessório.
x	number (double) minimum: 0	Deslocamento à esquerda da origem, na unidade de polegadas ou centímetros.
y	number (double) minimum: 0	Deslocamento superior da origem, na unidade de polegadas ou centímetros.

ImageMetadataApiModel

Objeto

As informações de metadados da imagem, como altura e largura.

Nome	Tipo	Description
height	integer (int32) minimum: 1	A altura da imagem em pixels.
width	integer (int32) minimum: 1	A largura da imagem em pixels.

PlanogramApiModel

Objeto

Descreve o planograma para operações de correspondência de planograma.

Nome	Tipo	Description
fixtures	FixtureApiModel[]	Lista dos acessórios no planograma.
height	number (double)	Altura do planograma.
positions	PositionApiModel[]	Lista das posições no planograma.
products	ProductApiModel[]	Lista de produtos no planograma.
width	number (double)	Largura do planograma.

PlanogramMatchingRequestApiModel

Objeto

Entrada para passar para a operação de correspondência de planograma.

Nome	Tipo	Description
detectedProducts	ProductRecognitionResultApiModel	Resultados da operação de compreensão do produto.
planogram	PlanogramApiModel	Descreve o planograma para operações de correspondência de planograma.

PlanogramMatchingResultApiModel

Objeto

Resultados da operação de correspondência de planograma.

Nome	Tipo	Description
matchingResultPerPosition	PositionMatchingResultApiModel[]	As informações de objeto detectadas correspondentes para cada posição de planograma.

PositionApiModel

Objeto

Descreve uma posição do produto em um planograma.

Nome	Tipo	Description
fixtureId	string minLength: 1	ID da luminária em que o produto está.
id	string minLength: 1	ID da posição.
productId	string minLength: 1	ID do produto.
x	number (double) minimum: 0	Deslocamento à esquerda da origem, na unidade de polegadas ou centímetros.
y	number (double) minimum: 0	Deslocamento superior da origem, na unidade de polegadas ou centímetros.

PositionMatchingResultApiModel

Objeto

O par unido da ID de posição do planograma com o objeto detectado correspondente do resultado da compreensão do produto.

Nome	Tipo	Description
detectedObject	DetectedObject	Descreve um objeto detectado em uma imagem.
positionId	string minLength: 1	A ID da posição do planograma correspondeu ao objeto detectado correspondente.

ProductApiModel

Objeto

Descreve um produto no planograma.

Nome	Tipo	Description
h	number (double)	Altura do acessório.
id	string minLength: 1	ID do produto.
name	string minLength: 1 maxLength: 255	Nome do produto.
w	number (double)	Largura do produto.

ProductRecognitionResultApiModel

Objeto

Resultados da operação de compreensão do produto.

Nome	Tipo	Description
gaps	DetectedObject[]	Lacunas detectadas na imagem.
imageMetadata	ImageMetadataApiModel	As informações de metadados da imagem, como altura e largura.
products	DetectedObject[]	Produtos detectados na imagem.

Tag

Objeto

Uma observação de entidade na imagem, juntamente com a pontuação de confiança.

Nome	Tipo	Description
confidence	number (double) minimum: 0 maximum: 1	O nível de confiança que a entidade foi observada.
name	string minLength: 1	Nome da entidade.