Guia do identificador de tags

O modelo Tag Recognizer ajuda você a resolver problemas importantes na compreensão da sua gôndola de varejo, ou seja, reconhecendo e analisando as tags (por exemplo, a etiqueta de preço ou outras etiquetas) de acordo com o esquema de extração de entidades de par de chave-valor definido pelo usuário.

Esse modelo pode servir como o principal elemento básico da IA para analisar e interpretar dados de imagens de produtos em lojas de varejo. Por exemplo, você pode usar esse modelo em imagens de prateleiras capturadas por câmeras locais ou dispositivos móveis.

Casos de uso do Reconhecedor de tags e do Reconhecedor de produtos

Os modelos Reconhecedor de produtos e Reconhecedor de tags podem servir como os principais blocos de construção de IA para analisar e interpretar os dados de imagem de produtos e tags que você pode ter capturado em lojas de varejo.

Os modelos de reconhecimento de produtos e de tags incorporam vários recursos principais de modelagem e dados de IA do Google para ajudar os varejistas e/ou parceiros técnicos a resolver problemas importantes na compreensão dos dados de imagens de produtos e etiquetas de preço, incluindo:

  • Reconhecer, ou seja, entender qual produto está na imagem.
  • Reconhecer e analisar a tag (por exemplo, preço ou qualquer outra tag de rótulo de texto) de acordo com o esquema de extração de entidade de par de chave-valor definido pelo usuário.

Em particular, vários modelos de IA do Google diferenciados estão incluídos para oferecer suporte à resolução de problemas desses casos de uso, como

  • Modelo de embedding visual de miniatura do produto, que transforma uma imagem de miniatura do produto em uma representação numérica de espaço de recursos.
  • Modelo de OCR do Google, que extrai todos os textos visíveis na imagem.
  • Modelo de extração de entidades do Google (que pode ser personalizado) que transforma os textos brutos em entidades nomeadas de par de chave-valor definidos pelo usuário.

Além desses modelos de IA do Google, o reconhecedor de produtos também usa o grande banco de dados de informações de produtos do Google. Os dados de produtos nesse banco de dados incluem o GTIN / UPC, a marca, o título, as descrições em vários idiomas, o logotipo e as imagens do produto com várias variações de embalagem. O banco de dados de produtos com o modelo de incorporação visual de miniatura de produto mencionado anteriormente permite que o modelo de reconhecimento de produtos identifique muitos produtos imediatamente.

Os dois principais recursos de IA são os modelos de reconhecimento de produtos e de reconhecimento de tags.

Funcionalidade do Reconhecedor de tags

Esse modelo reconhece todas as strings de texto na tag e tenta analisar o texto no esquema de extração de entidade de par de chave-valor definido pelo usuário, como descrição do item do produto ou valor do preço. Ele inclui os seguintes modelos de IA do Google:

  • A tecnologia de OCR do Google, que extrai todo o texto visível na imagem.

  • O modelo de extração de entidade do Google que transforma o texto bruto em entidades nomeadas de par de chave-valor definidas pelo usuário. Personalize esse modelo usando a Vertex AI. Por exemplo, se você se importa principalmente com a descrição do item do produto, o valor do preço do produto ou o preço promocional, mas nada mais, o usuário pode definir o esquema de análise da tag da seguinte maneira:

    key: item_description   value: string
key: regular_price      value: number
key: sale_price         value: number

Esquema de análise de tags

Com o treinamento de modelo personalizado de extração de entidade, a caixa do item de tag detectado será reconhecida e analisada de acordo com o esquema definido pelo usuário, por exemplo, da seguinte maneira:

  item_description:   COLLECTION 18PC GFT BX
  regular_price:      1099
  sale_price:         999

Exemplo de objeto JSON de saída

{
  "imageUri": "gs://test_bucket/test_image.jpg",
  "tagRecognitionAnnotations": [
    {
      "entities": [
        {
          "confidence": 0.99646133,
          "mentionText": "NISSIN TOP RAMEN\n\nBOW CHICKEN\n\n",
          "region": {
            "xMax": 0.4618055,
            "xMin": 0.042725038,
            "yMax": 0.45387268,
            "yMin": 0.18415153
          },
          "type":"description"
        },
        {
          "confidence": 0.95828205,
          "mentionText": "$3.90\n",
          "region": {
            "xMax": 0.24819264,
            "xMin": 0.04185935,
            "yMax": 0.96134734,
            "yMin": 0.80382305
          },
          "type":"unit_price"
        },
        {
          "confidence": 0.60659707,
          "mentionText": "$14.99\n",
          "region": {
            "xMax": 0.9754113,
            "xMin": 0.3654699,
            "yMax": 0.92825794,
            "yMin": 0.40368474
          },
          "type":"price"
        }
      ]
    }
  ]
}

configuração do ambiente

Esta seção descreve como interagir com a API RESTful do Store Vision AI.

API_ENDPOINT=visionai.googleapis.com
PROJECT_ID=your project ID

Todos os métodos create exigem a especificação explícita do nome/ID do recurso a ser criado. Você pode usar um identificador de string significativo, por exemplo, "product-ABC", ou um identificador gerado aleatoriamente, por exemplo, UUID.

Para conceder a uma pessoa o acesso de editor para usar a API Store Vision, execute o seguinte comando de vinculação do IAM:

gcloud projects add-iam-policy-binding PROJECT_ID --member='user:USER_ACCOUNT' --role='roles/visionai.editor'

Para conceder acesso de editor a uma conta de serviço, use o comando abaixo:

gcloud projects add-iam-policy-binding PROJECT_ID --member='serviceAccount:SERVICE_ACCOUNT' --role='roles/visionai.editor'

Saiba mais sobre a vinculação do IAM.

Jornada do usuário do Reconhecedor de tags

  1. Realize o treinamento personalizado do modelo de detecção de tags usando o recurso Vertex AI / AutoML Vision Object Detection.
  2. Realize treinamento de modelo de análise de entidade de tag usando o recurso Vertex AI / AutoML Vision Object Detection com um mecanismo de OCR personalizado.
  3. Crie um endpoint com a configuração de reconhecimento de tag desejada.
  4. Realize o BatchAnalyze com o recurso TagRecognition. No back-end, o sistema identifica tags de cada imagem de entrada e analisa o texto em cada tag detectada para produzir uma saída de análise estruturada. T ## treinamento de modelo de detecção de tags e análise de entidades

É possível treinar o modelo personalizado de detecção de tags usando o recurso de treinamento de modelo de detecção de objetos de imagem do produto Vertex AI / AutoML Vision. Embora o recurso de treinamento de modelo de detecção de objetos da Vertex AI / AutoML Vision ofereça uma experiência de treinamento de modelo totalmente gerenciada, ainda é sua responsabilidade preparar um conjunto de dados de imagens bem amostrado com anotações de caixa delimitadora de objetos totalmente rotuladas como o conjunto de dados de treinamento para alimentar o console de treinamento de modelo. Google Cloud fornece o serviço de rotulagem de dados da Vertex AI para permitir que você crie a tarefa de rotulagem de dados. Siga este link para mais detalhes sobre o job de rotulagem de dados da Vertex AI: /vertex-ai/docs/datasets/data-labeling-job. Forneça instruções claras de rotulagem de dados aos avaliadores humanos para que eles saibam como rotular as caixas delimitadoras de detecção de tags nas imagens como preparação do conjunto de dados de treinamento.

Para treinar o modelo de análise de entidade de tag, é necessário preparar uma coleção de dados de treinamento com imagens e anotações associadas.

  • A imagem é a tag já cortada.
  • Em cada imagem, é necessário definir e fornecer o campo de entidade principal (como product_title, price, unit_price) que você quer detectar e reconhecer / analisar, além da localização das coordenadas da caixa delimitadora da imagem associada nessa visualização de imagem cortada.
  • Para oferecer suporte ao reconhecimento / análise correto, também é necessário fornecer a sintaxe de expressão regular para caracterizar cada campo. Isso é necessário para ajudar no treinamento e na rotina de inferência do algoritmo de análise de tags.

imagem de tag reconhecida

Exemplo de treinamento de análise de entidades de tag

Por exemplo, com o exemplo anterior de treinamento de análise de entidade de tag, você pode fornecer uma linha de informações de anotação no arquivo CSV de anotação de dados de treinamento da seguinte forma:

"image_filepath", "product_title", "(x0, y0, x1, y1)", "", "price", "(x0, y0, x1, y1)", "\\$\\d+\\.\\d{2}", "unit_price", "(x0, y0, x1, y1)", "\\$\\d+\\.\\d{2}"

No exemplo anterior:

  • O campo "product_title" tem a coordenada de imagem da caixa correspondente "(x0, y0, x1, y1)" e a restrição de expressão regular para esse campo é "".
  • O campo "price" tem a coordenada de imagem da caixa correspondente "(x0, y0, x1, y1)", e a restrição de expressão regular para esse campo é "\$\d+\.\d{2}", o que indica que estamos procurando reconhecer e analisar esse campo com o sinal de dólar no início da entrada de texto e alguns dígitos numéricos antes do "." e dois dígitos depois do ".".
  • O campo "unit_price" tem a mesma sintaxe de anotação do campo "price". Por exemplo, as coordenadas da imagem da caixa "(x0, y0, x1, y1)" e a restrição de expressão regular para esse campo são "\$\d+\.\d{2}", o que indica que estamos procurando reconhecer e analisar esse campo com o sinal de dólar no início da entrada de texto e alguns dígitos antes do "." e dois dígitos depois do ".".

Portanto, dados de treinamento de um modelo adequado de análise de preços / detecção de entidades terão uma coleção de imagens de etiquetas de preço, com a anotação em um arquivo CSV com cada entrada de linha CSV, assim como a entrada no exemplo anterior.

"image_filepath", "product_title", "(x0, y0, x1, y1)", "", "price", "(x0, y0, x1, y1)", "\\$\\d+\\.\\d{2}", "unit_price", "(x0, y0, x1, y1)", "\\$\\d+\\.\\d{2}"

"image_filepath", "product_title", "(x0, y0, x1, y1)", "", "price", "(x0, y0, x1, y1)", "\\$\\d+\\.\\d{2}", "unit_price", "(x0, y0, x1, y1)", "\\$\\d+\\.\\d{2}"

"image_filepath", "product_title", "(x0, y0, x1, y1)", "", "price", "(x0, y0, x1, y1)", "\\$\\d+\\.\\d{2}", "unit_price", "(x0, y0, x1, y1)", "\\$\\d+\\.\\d{2}"

[...]

É possível treinar o modelo personalizado de análise de entidades de tag usando o recurso de treinamento de modelo de detecção de objetos de imagem do produto Vertex AI /AutoML Vision e a personalização do mecanismo de OCR do Google.

No entanto, embora, desde julho de 2022, o treinamento e a implantação de modelos personalizados de detecção de tags e análise de entidades de tags na API BatchAnalyze da Store Vision AI ainda não sejam totalmente compatíveis como uma experiência de console integrada, ainda é possível aproveitar esse treinamento de modelo personalizado de detecção de tags e análise de entidades de tags (usando o recurso de detecção de objetos da Vertex AI Vision) e disponibilizá-los na API BatchAnalyze da Store Vision AI seguindo várias etapas manuais de autoatendimento.

Uso da API: análise de inferência em lote

Criar endpoint
  • ENDPOINT_ID=ID do seu endpoint
  • TAG_DETECTOR=Nome do seu modelo de detecção de tags
  • TAG_PARSER=Nome do seu modelo de análise de tag
curl -sS -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailEndpoints?retail_endpoint_id=ENDPOINT_ID \
-d '{
  "tagRecognitionConfig": {
    "tag_detection_model": "TAG_DETECTOR_NAME",
    "tag_parsing_model": "TAG_PARSER_NAME"
  }
}'
  • INPUT_FILE_URI=URI do Cloud Storage do seu arquivo de entrada. Cada linha no arquivo de entrada é apenas um URI do Cloud Storage da imagem a ser processada. Por exemplo, gs://my-bucket/my-image.jpg
  • OUTPUT_URI_PREFIX=prefixo do URI do Cloud Storage para o arquivo de resultados da saída. Por exemplo, gs://my-bucket/my-output-dir
curl -sS -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailEndpoints/ENDPOINT_ID:batchAnalyze 
-d '{
  "gcsSource": {
    "uris": ["INPUT_FILE_URI"]
  },
  "features": [
    {
      "type": "TYPE_TAG_RECOGNITION",
     }
  ],
  "outputGcsDestination": {
    "outputUriPrefix": "OUTPUT_URI_PREFIX"
  }
}'

"features": [
    {
      "type": "TYPE_TAG_RECOGNITION",
      "tagRecognitionConfig": {
        "tag_detection_model": "'TAG_DETECTOR_NAME'",
        "tag_parsing_model": "TAG_PARSER_NAME"
      }
    }
  ],

Há também mais campos que podem ser definidos e configurados no tagRecognitionConfig, que é um objeto RetailTagRecognitionConfig. Consulte a descrição do recurso na referência da API para mais detalhes.

Referência da API

Recurso: projects.locations.retailCatalogs

Representação JSON

{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "resourceState": enum(RetailResourceState),
  "labels": {
    string: string,
    ...
  }
}

Campos

Nome de

String
Apenas saída. Nome do recurso do RetailCatalog

displayName
String
Opcional. Nome de exibição do RetailCatalog.

createTime
string (formato Carimbo de data/hora)
Apenas saída. Carimbo de data/hora em que este RetailCatalog foi criado.

updateTime
string (formato Carimbo de data/hora)
Apenas saída. O carimbo de data/hora da atualização.

resourceState
enum
Apenas saída. Estado do RetailCatalog.

rótulos
map (key: string, value: string)
Os rótulos com metadados definidos pelo usuário para organizar seu RetailCatalog.

As chaves e os valores de rótulo não podem ter mais de 64 caracteres (pontos de código Unicode) e podem conter apenas letras minúsculas, caracteres numéricos, sublinhados e traços. Caracteres internacionais são permitidos.

Consulte https://goo.gl/xmQnxf para mais informações e exemplos de rótulos.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Método: projects.locations.retailCatalogs.create

Solicitação HTTP

POST https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/us-central1}/retailCatalogs

Parâmetros de caminho
primária string Obrigatório. Identificador principal.

Corpo da solicitação

O corpo da solicitação contém uma instância de RetailCatalog.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta vai conter uma instância recém-criada de RetailCatalog.

Método: projects.locations.retailCatalogs.get

Solicitação HTTP

GET https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/us-central1/retailCatalogs/*}

Parâmetros de caminho
nome string Obrigatório. Identificador RetailCatalog.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de RetailCatalog.

Método: projects.locations.retailCatalogs.list

Solicitação HTTP

GET https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/us-central1}/retailCatalogs

Parâmetros de caminho
primária string Obrigatório. Identificador principal.

Parâmetros de consulta

filtrar string Opcional. Uma expressão para filtrar os resultados da solicitação.
pageToken string Opcional. Um token que identifica a página de resultados que o servidor vai retornar.
pageSize integer Opcional. Tamanho da página solicitada. O servidor pode retornar menos itens do que o solicitado. Se não for especificado, o servidor vai escolher um padrão adequado.
orderBy string Opcional. Uma lista separada por vírgulas de campos a serem ordenados em ordem crescente. Use "desc" depois de um nome de campo para ordem decrescente.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se não houver falha, o corpo da resposta vai trazer dados com a seguinte estrutura: representação JSON

{
  "retailCatalogs": [
    {
      object (RetailCatalog)
    }
  ],
  "nextPageToken": string
}

Método: projects.locations.retailCatalogs.delete

Solicitação HTTP

DELETE https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/us-central1/retailCatalogs/*}

Parâmetros de caminho
nome string Obrigatório. Identificador RetailCatalog.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Método: projects.locations.retailCatalogs.importRetailProducts

Solicitação HTTP

POST https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/us-central1/retailCatalogs/*}:importRetailProducts

Parâmetros de caminho
nome string Obrigatório. Nome do recurso RetailCatalog.

Corpo da solicitação

Representação JSON

{
  "gcsSource": { object(GcsSource) },
  "format": enum(Format)
}

Campos

gcsSource objeto Obrigatório. O local do Cloud Storage para o conteúdo de entrada. É possível fornecer vários locais de entrada. O conteúdo de todos os locais de entrada será importado em um lote. Extensões de arquivo compatíveis: 1. Um arquivo JSONL. Cada linha é um formato JSON de RetailProductIoFormat.
2. Um arquivo TXT. Cada linha é o GTIN de um produto a ser importado.
formato enum Obrigatório. O formato do arquivo de importação.

Formatar valores ENUM

FORMAT_UNSPECIFIED Não pode ser usado.
FORMAT_TXT Formato TXT.
FORMAT_JSONL Formato JSONL.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Recurso: projects.locations.retailProducts

Representação JSON

{
  "name": string,
  "gtins": [string],
  "normalizedGtins": [string],
  "thirdPartyIds": [ { object(ThirdPartyId) }],
  "locale": string,
  "brand": string,
  "title": string,
  "productUri": string,
  "resourceState": enum(RetailResourceState),
   "labels": {
    string: string,
    ...
    }
   "createTime": string,
   "updateTime": string
}

Campos

Nome de

String
Apenas saída. Nome do recurso do RetailProductImage

displayName
String
Opcional. Nome de exibição do RetailProductImage.

sourceType
enum
Opcional. Tipo de origem

gcsUri
string
Opcional. Local do Cloud Storage do RetailProductImage. Ele deve ser definido, exceto quando a imagem é fornecida pelo Google, por exemplo, quando o tipo de origem é SOURCE_TYPE_GOOGLE.

resourceState
enum
Apenas saída. Estado do RetailProductImage.

rótulos
map (key: string, value: string)
Os rótulos com metadados definidos pelo usuário para organizar seu RetailProductImage.

As chaves e os valores de rótulo não podem ter mais de 64 caracteres (pontos de código Unicode) e podem conter apenas letras minúsculas, caracteres numéricos, sublinhados e traços. Caracteres internacionais são permitidos.

Consulte https://goo.gl/xmQnxf para mais informações e exemplos de rótulos.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

createTime
string (formato Carimbo de data/hora)
Apenas saída. O carimbo de data/hora de criação.

updateTime
string (formato Carimbo de data/hora)
Apenas saída. O carimbo de data/hora da atualização.

Apresentação JSON RetailThirdPartyId

{
  "id": string,
  "owner": string
}

Campos
ID string ID de terceiros usado pelo varejista ou fabricante (por exemplo, SKU ou MPN).
proprietário string A entidade "proprietária" do identificador de terceiros, por exemplo, o fabricante ou o varejista que vende esse produto.

Método: projects.locations.retailCatalogs.retailProducts.create

Solicitação HTTP

POST https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*}/retailProducts

Parâmetros de caminho
primária string Obrigatório. Identificador principal.

Corpo da solicitação

O corpo da solicitação contém uma instância de RetailProduct.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta vai conter uma instância recém-criada de RetailProduct.

Método: projects.locations.retailCatalogs.retailProducts.get

Solicitação HTTP

GET https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProducts/*

Parâmetros de caminho
nome string Obrigatório. Identificador RetailProduct.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de RetailProduct.

Método: projects.locations.retailCatalogs.retailProducts.list

Solicitação HTTP

GET https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*}/retailProducts

Parâmetros de caminho
primária string Obrigatório. Identificador principal.

Parâmetros de consulta

filtrar string Opcional. Uma expressão para filtrar os resultados da solicitação.
pageToken string Opcional. Um token que identifica a página de resultados que o servidor vai retornar.
pageSize integer Opcional. Tamanho da página solicitada. O servidor pode retornar menos itens do que o solicitado. Se não for especificado, o servidor vai escolher um padrão adequado.
orderBy string Opcional. Uma lista separada por vírgulas de campos a serem ordenados em ordem crescente. Use "desc" depois de um nome de campo para ordem decrescente.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se não houver falha, o corpo da resposta vai trazer dados com a seguinte estrutura: representação JSON

{
  "retailProducts": [
    {
      object (RetailProducts)
    }
  ],
  "nextPageToken": string
}

Método: projects.locations.retailCatalogs.retailProducts.delete

Solicitação HTTP

DELETE https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProducts/*

Parâmetros de caminho
nome string Obrigatório. Identificador RetailProduct.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for concluída, o corpo da resposta estará vazio.

Recurso: projects.locations.retailProductImages

Representação JSON

{
  "name": string,
  "displayName": string,
  "sourceType": enum(SourceType),
  "gcsUri": string,
  "resourceState": enum(RetailResourceState),
   "labels": {
    string: string,
    ...
    }
   "createTime": string,
   "updateTime": string
}

Campos

Nome de

String
Apenas saída. Nome do recurso do RetailProductImage

displayName
String
Opcional. Nome de exibição do RetailProductImage.

sourceType
enum
Opcional. Tipo de origem

gcsUri
string
Opcional. Local do Cloud Storage do RetailProductImage. Ele deve ser definido, exceto quando a imagem é fornecida pelo Google, por exemplo, quando o tipo de origem é SOURCE_TYPE_GOOGLE.

resourceState
enum
Apenas saída. Estado do RetailProductImage.

rótulos
map (key: string, value: string)
Os rótulos com metadados definidos pelo usuário para organizar seu RetailProductImage.

As chaves e os valores de rótulo não podem ter mais de 64 caracteres (pontos de código Unicode) e podem conter apenas letras minúsculas, caracteres numéricos, sublinhados e traços. Caracteres internacionais são permitidos.

Consulte https://goo.gl/xmQnxf para mais informações e exemplos de rótulos.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

createTime
string (formato Carimbo de data/hora)
Apenas saída. O carimbo de data/hora de criação.

updateTime
string (formato Carimbo de data/hora)
Apenas saída. O carimbo de data/hora da atualização.

Valores ENUM de SourceType

SOURCE_TYPE_UNSPECIFIED Fonte de dados desconhecida. Não pode ser usado.
SOURCE_TYPE_FIXED_CAMERA A imagem é capturada por uma câmera fixa.
SOURCE_TYPE_HAND_HELD_CAMERA A imagem é capturada com uma câmera portátil.
SOURCE_TYPE_CRAWLED A imagem é rastreada da Web.
SOURCE_TYPE_SYSTEM_GENERATED A imagem é cortada de uma imagem original com identificação humana.

Método: projects.locations.retailCatalogs.retailProducts.retailProductImages.create

Solicitação HTTP

POST https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*/retailProducts/*}/retailProductImages

Parâmetros de caminho
primária string Obrigatório. Identificador principal.

Corpo da solicitação

O corpo da solicitação contém uma instância de RetailProductImage.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta vai conter uma instância recém-criada de RetailProductImage.

Método: projects.locations.retailCatalogs.retailProducts.retailProductImages.get

Solicitação HTTP

GET https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProducts/*/retailProductImages/*

Parâmetros de caminho
nome string Obrigatório. Identificador RetailProductImage.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de RetailProductImage.

Método: projects.locations.retailCatalogs.retailProducts.retailProductImages.list

Solicitação HTTP

GET https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*/retailProducts/*}/retailProductImages

Parâmetros de caminho
primária string Obrigatório. Identificador principal.

Parâmetros de consulta

filtrar string Opcional. Uma expressão para filtrar os resultados da solicitação.
pageToken string Opcional. Um token que identifica a página de resultados que o servidor vai retornar.
pageSize integer Opcional. Tamanho da página solicitada. O servidor pode retornar menos itens do que o solicitado. Se não for especificado, o servidor vai escolher um padrão adequado.
orderBy string Opcional. Uma lista separada por vírgulas de campos a serem ordenados em ordem crescente. Use "desc" depois de um nome de campo para ordem decrescente.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON

{
  "retailProductImages": [
    {
      object (RetailProductImages)
    }
  ],
  "nextPageToken": string
}

Método: projects.locations.retailCatalogs.retailProducts.retailProductImages.delete

Solicitação HTTP

DELETE https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProducts/*/retailProductImages/*

Parâmetros de caminho
nome string Obrigatório. Identificador RetailProductImage.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for concluída, o corpo da resposta estará vazio.

Recurso: projects.locations.retailCatalogs.retailProductSets

Representação JSON

{
  "name": string,
  "displayName": string,
  "retailProductIds": [string],
  "resourceState": enum(RetailResourceState),
   "labels": {
    string: string,
    ...
    }
   "createTime": string,
   "updateTime": string
}

Campos

Nome de

String
Apenas saída. Nome do recurso do RetailProductSet

displayName
String
Opcional. Nome de exibição do RetailProductSet.

retailProductIds []
String
Apenas saída. IDs de recursos de produtos pertencentes a este RetailProductSet. Os produtos em um RetailProductSet precisam estar no mesmo catálogo.

resourceState
enum
Apenas saída. Estado do RetailProductSet.

rótulos
map (key: string, value: string)
Os rótulos com metadados definidos pelo usuário para organizar seu RetailProductSet.

As chaves e os valores de rótulo não podem ter mais de 64 caracteres (pontos de código Unicode) e podem conter apenas letras minúsculas, caracteres numéricos, sublinhados e traços. Caracteres internacionais são permitidos.

Consulte https://goo.gl/xmQnxf para mais informações e exemplos de rótulos.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

createTime
string (formato Carimbo de data/hora)
Apenas saída. O carimbo de data/hora de criação.

updateTime
string (formato Carimbo de data/hora)
Apenas saída. O carimbo de data/hora da atualização.

Método: projects.locations.retailCatalogs.retailProductSets.create

Solicitação HTTP

POST https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*}/retailProductSets

Parâmetros de caminho
primária string Obrigatório. Identificador principal.

Corpo da solicitação

O corpo da solicitação contém uma instância de RetailProductSet.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta vai conter uma instância recém-criada de RetailProductSet.

Método: projects.locations.retailCatalogs.retailProductSets.get

Solicitação HTTP

GET https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProductSets/*

Parâmetros de caminho
nome string Obrigatório. Identificador de RetailProductSet.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta vai conter uma instância de "RetailProductSet".

Método: projects.locations.retailCatalogs.retailProductSets.list

Solicitação HTTP

GET https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*}/retailProductSets

Parâmetros de caminho
primária string Obrigatório. Identificador principal.

Parâmetros de consulta

filtrar string Opcional. Uma expressão para filtrar os resultados da solicitação.
pageToken string Opcional. Um token que identifica a página de resultados que o servidor vai retornar.
pageSize integer Opcional. Tamanho da página solicitada. O servidor pode retornar menos itens do que o solicitado. Se não for especificado, o servidor vai escolher um padrão adequado.
orderBy string Opcional. Uma lista separada por vírgulas de campos a serem ordenados em ordem crescente. Use "desc" depois de um nome de campo para ordem decrescente.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON

{
  "retailProductSets": [
    {
      object (RetailProductSets)
    }
  ],
  "nextPageToken": string
}

Método: projects.locations.retailCatalogs.retailProductSets.delete

Solicitação HTTP

DELETE https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProductSets/*

Parâmetros de caminho
nome string Obrigatório. Identificador de RetailProductSet.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for concluída, o corpo da resposta estará vazio.

Método: projects.locations.retailCatalogs.retailProductSets.add

Solicitação HTTP

POST https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProductSets/*}:remove

Parâmetros de caminho
nome string Obrigatório. Nome do recurso RetailProductSet.

Corpo da solicitação

Representação JSON

{
  "productIds": [string],
  "productFilter": string
}

Campos


productIds[ ]
string
ID do recurso dos RetailProducts a serem adicionados. Todos precisam pertencer ao mesmo RetailCatalog que o RetailProductSet de destino especificado. É possível especificar até 200 IDs de RetailProducts em uma solicitação. Não pode ser usado com productFilter.

productFilter
string
Um filtro padrão que será aplicado a todos os RetailProducts no RetailCatalog principal. Selecione os itens que atendem às condições do filtro e adicione-os ao RetailProductSet. Não pode ser usado com "product_ids". Filtros compatíveis: https://google.aip.dev/160

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Método: projects.locations.retailCatalogs.retailProductSets.remove

Solicitação HTTP

POST https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProductSets/*}:add

Parâmetros de caminho
nome string Obrigatório. Nome do recurso RetailProductSet.

Corpo da solicitação

Representação JSON

{
  "productIds": [string],
  "productFilter": string
}

Campos


productIds[ ]
string
IDs de recursos dos RetailProducts a serem removidos. Se os RetailProducts especificados não pertencerem a este RetailProductSet, eles serão ignorados. É possível especificar até 200 IDs de RetailProducts em uma solicitação. Não pode ser usado com "products_filter".

productFilter
string
Um filtro padrão que será aplicado a todos os RetailProducts no RetailProductSet especificado. Selecione os itens que atendem às condições do filtro e remova-os do RetailProductSet. Não pode ser usado com "product_ids". Filtros compatíveis:https://google.aip.dev/160

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Recurso: projects.locations.retailCatalogs.retailProductRecognitionIndexes

Representação JSON

{
  "name": string,
  "displayName": string,
  "description": string,
  "retailProductSet": [string],
   "resourceState": enum(RetailResourceState),
   "labels": {
    string: string,
    ...
    }
   "createTime": string,
   "updateTime": string
}

Campos

Nome de

String
Apenas saída. Nome do recurso RetailProductRecognitionIndex.

displayName
String
Opcional. Nome de exibição do RetailProductRecognitionIndex.

descrição
String
Opcional. A descrição do RetailProductRecognitionIndex.

retailProductSet[]
string
Opcional. O nome do recurso RetailProductSet a ser usado para criar este recurso. Se definido, o RetailProductRecognitionIndex vai conter apenas produtos no RetailProductSet especificado. Se não for definido, todos os produtos no catálogo principal serão usados.

resourceState
enum
Apenas saída. Estado do RetailProductRecognitionIndex.

rótulos
map (key: string, value: string)
Os rótulos com metadados definidos pelo usuário para organizar seu RetailProductRecognitionIndex.

As chaves e os valores de rótulo não podem ter mais de 64 caracteres (pontos de código Unicode) e podem conter apenas letras minúsculas, caracteres numéricos, sublinhados e traços. Caracteres internacionais são permitidos.

Consulte https://goo.gl/xmQnxf para mais informações e exemplos de rótulos.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

createTime
string (formato Carimbo de data/hora)
Apenas saída. O carimbo de data/hora de criação.

updateTime
string (formato Carimbo de data/hora)
Apenas saída. O carimbo de data/hora da atualização.

Método: projects.locations.retailCatalogs.retailProductRecognitionIndexes.create

Solicitação HTTP

POST https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*}/retailProductRecognitionIndexes

Parâmetros de caminho
primária string Obrigatório. Identificador principal.

Corpo da solicitação

O corpo da solicitação contém uma instância de RetailProductRecognitionIndex.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta vai conter uma instância recém-criada de RetailProductRecognitionIndex.

Método: projects.locations.retailCatalogs.retailProductRecognitionIndexes.get

Solicitação HTTP

GET https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProductRecognitionIndexes/*

Parâmetros de caminho
nome string Obrigatório. Identificador RetailProductRecognitionIndex.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta vai conter uma instância de RetailProductRecognitionIndex.

Método: projects.locations.retailCatalogs.retailProductRecognitionIndexes.list

Solicitação HTTP

GET https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*}/retailProductRecognitionIndexes

Parâmetros de caminho
primária string Obrigatório. Identificador principal.

Parâmetros de consulta

filtrar string Opcional. Uma expressão para filtrar os resultados da solicitação.
pageToken string Opcional. Um token que identifica a página de resultados que o servidor vai retornar.
pageSize integer Opcional. Tamanho da página solicitada. O servidor pode retornar menos itens do que o solicitado. Se não for especificado, o servidor vai escolher um padrão adequado.
orderBy string Opcional. Uma lista separada por vírgulas de campos a serem ordenados em ordem crescente. Use "desc" depois de um nome de campo para ordem decrescente.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON

{
  "retailProductRecognitionIndexes": [
    {
      object (RetailProductRecognitionIndex)
    }
  ],
  "nextPageToken": string
}

Método: projects.locations.retailCatalogs.retailProductRecognitionIndexes.delete

Solicitação HTTP

DELETE https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProductRecognitionIndexes/*

Parâmetros de caminho
nome string Obrigatório. Identificador de ProductRecognitionIndex.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Recurso: projects.locations.retailEndpoints

Representação JSON

{
  "name": string,
  "displayName": string,
  "description": string,
  "deployedProductRecognitionIndex": string,
  "resourceState": enum(RetailResourceState),
  "productRecognitionConfig": { object(RetailProductRecognitionConfig) },
  "tagRecognitionConfig": { object(RetailTagRecognitionConfig) },
  "labels": {
    string: string,
    ...
   }
  "createTime": string,
  "updateTime": string
}

Campos

Nome de

String
Apenas saída. Nome do recurso RetailEndpoint.

displayName
String
Opcional. Nome de exibição do RetailEndpoint.

descrição
String
Opcional. A descrição do RetailEndpoint.

deployedProductRecognitionIndex
String
Apenas saída. Nome do recurso do ProductRecognitionIndex implantado neste RetailEndpoint.

productRecognitionConfig		 Objeto

Opcional. Configuração para reconhecimento de produtos.

tagRecognitionConfig		 Objeto

Opcional. Configuração para reconhecimento de tag.

resourceState
enum
Apenas saída. Estado do RetailProductRecognitionIndex.

rótulos
map (key: string, value: string)
Os rótulos com metadados definidos pelo usuário para organizar seu RetailProductRecognitionIndex.

As chaves e os valores de rótulo não podem ter mais de 64 caracteres (pontos de código Unicode) e podem conter apenas letras minúsculas, caracteres numéricos, sublinhados e traços. Caracteres internacionais são permitidos.

Consulte https://goo.gl/xmQnxf para mais informações e exemplos de rótulos.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

createTime
string (formato Carimbo de data/hora)
Apenas saída. O carimbo de data/hora de criação.

updateTime
string (formato Carimbo de data/hora)
Apenas saída. O carimbo de data/hora da atualização.

RetailProductRecognitionConfig

Representação JSON

{
  "productDetectionModel": string,
  "detectionConfidenceThreshold": float,
  "recognitionConfidenceThreshold": float,
  "additionalConfig": { object }
}

Campos

|

productDetectionModel string Obrigatório. Modelo a ser usado para detectar produtos em imagens de entrada. Valores aceitos: "builtin/stable" (o padrão) ou nome do recurso do modelo da Vertex AI.
detectionConfidenceThreshold float Opcional. Limite de confiança para filtrar resultados de detecção. Se não for definido, um valor padrão do sistema será usado.
recognitionConfidenceThreshold float Opcional. Limite de confiança para filtrar resultados de reconhecimento. Se não for definido, um valor padrão do sistema será usado.
additionalConfig objeto (formato Struct) Opcional. Configurações adicionais para reconhecimento de produtos.

RetailTagRecognitionConfig

Representação JSON

{
  "tagDetectionModel": string,
  "tagParsingModel": string,
  "detectionConfidenceThreshold": float,
  "parsingConfidenceThreshold": float,
  "additionalConfig": { object }
}

Campos

tagDetectionModel string Obrigatório. Modelo usado para detectar tags em imagens de entrada. Valores aceitos: recurso de modelo da Vertex AI.
tagParsingModel string Obrigatório. Modelo para analisar texto em tags detectadas. Valores aceitos: recurso de modelo da Vertex AI.
detectionConfidenceThreshold float Opcional. Limite de confiança para filtrar resultados de detecção. Se não for definido, um valor padrão do sistema será usado.
parsingConfidenceThreshold float Opcional. Limite de confiança para filtrar os resultados da análise de texto. Se não for definido, um valor padrão do sistema será usado.
additionalConfig objeto (formato Struct) Opcional. Configurações adicionais para reconhecimento de tags.

Método: projects.locations.retailEndpoints.create

Solicitação HTTP

POST https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*}/retailEndpoints

Parâmetros de caminho
primária string Obrigatório. Identificador principal.

Corpo da solicitação

O corpo da solicitação contém uma instância de RetailEndpoint.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta vai conter uma instância recém-criada de RetailEndpoint.

Método: projects.locations.retailEndpoints.get

Solicitação HTTP

GET https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailEndpoints/*}

Parâmetros de caminho
nome string Obrigatório. Identificador RetailEndpoint.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de RetailEndpoint.

Método: projects.locations.retailEndpoints.list

Solicitação HTTP

GET https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*}/retailEndpoints

Parâmetros de caminho
primária string Obrigatório. Identificador principal.

Parâmetros de consulta

filtrar string Opcional. Uma expressão para filtrar os resultados da solicitação.
pageToken string Opcional. Um token que identifica a página de resultados que o servidor vai retornar.
pageSize integer Opcional. Tamanho da página solicitada. O servidor pode retornar menos itens do que o solicitado. Se não for especificado, o servidor vai escolher um padrão adequado.
orderBy string Opcional. Uma lista separada por vírgulas de campos a serem ordenados em ordem crescente. Use "desc" depois de um nome de campo para ordem decrescente.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON

{
  "retailEndpoints": [
    {
      object (RetailEndpoint)
    }
  ],
  "nextPageToken": string
}

Método: projects.locations.retailEndpoints.delete

Solicitação HTTP

DELETE https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailEndpoints/*

Parâmetros de caminho
nome string Obrigatório. Identificador RetailEndpoint.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for concluída, o corpo da resposta estará vazio.

Método: projects.locations.retailEndpoints.deployRetailProductRecognitionIndex

Solicitação HTTP

POST https://visionai.googleapis.com/v1alpha1/{retailEndpoint=projects/*/locations/*/retailEndpoints/*}:deployRetailProductRecognitionIndex

Parâmetros de caminho
retailEndpoint string Obrigatório. Nome do recurso do recurso RetailEndpoint em que o RetailProductRecognitionIndex é implantado.

Corpo da solicitação

Representação JSON

{
  "retailProductRecognitionIndex": string,
}

Campos
retailProductRecognitionIndex string Obrigatório. O nome do recurso de RetailProductRecognitionIndex a ser implantado.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Método: projects.locations.retailEndpoints.undeployRetailProductRecognitionIndex

Solicitação HTTP

POST https://visionai.googleapis.com/v1alpha1/{retailEndpoint=projects/*/locations/*/retailEndpoints/*}:undeployRetailProductRecognitionIndex

Parâmetros de caminho
retailEndpoint string Obrigatório. Nome do recurso RetailEndpoint em que o cancelamento da implantação vai atuar.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Método: projects.locations.retailEndpoints.batchAnalyze

Solicitação HTTP

POST https://visionai.googleapis.com/v1alpha1/{retailEndpoint=projects/*/locations/*/retailEndpoints/*}:batchAnalyze

Parâmetros de caminho
retailEndpoint string Obrigatório. Nome do recurso do RetailEndpoint para atender à solicitação de inferência.

Corpo da solicitação

Representação JSON

{
  "gcsSource": string,
  "features": { object(Feature) },
  // Union field output can be only one of the following:
  "outputGcsDestination": string,
  "corpus": string,
  // End of list of possible types for union field output.
  "bigqueryTable": string
}

Campos

gcsSource string Obrigatório. O local do Cloud Storage para o conteúdo de entrada. É possível fornecer vários locais de entrada. O conteúdo de todos os locais de entrada será processado em um lote. Conteúdo aceito: um arquivo TXT em que cada linha é o caminho completo para uma imagem. Uma solicitação pode ter no máximo 50 mil imagens.
outputGcsDestination string Opcional. O local do Cloud Storage do diretório em que a saída precisa ser gravada.
corpus string Opcional. Nome do recurso do corpus do banco de imagens. Não compatível no momento.
bigqueryTable string Opcional. Nome do recurso da tabela do BigQuery para exportações de anotações. No formato "projects/*/datasets/*/tables/*". Se definido, as anotações geradas pela inferência de ML também serão exportadas para a tabela do BigQuery especificada. Não compatível no momento.
features[] Objeto Obrigatório. O tipo de inferência de ML a ser realizada.

Recurso

Representação JSON

{
  "type": enum(Type),
  "productRecognitionConfig": object(RetailProductRecognitionConfig),
  "tagRecognitionConfig": object(RetailTagRecognitionConfig)
}

Campos

tipo enum Obrigatório. O tipo de recurso.
productRecognitionConfig objeto Opcional. Substituições por solicitação para o recurso de reconhecimento de produto. Ele só é efetivo se o tipo estiver definido como TYPE_PRODUCT_RECOGNITION.
tagRecognitionConfig objeto Opcional. Substituições por solicitação para o recurso de reconhecimento de tag. Ele só é válido se o tipo for definido como TYPE_TAG_RECOGNITION.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Tipos

GcsSource

Representação JSON

{
  "uris": [string]
}

Campos
uris[] string Obrigatório. Referências a caminhos do Cloud Storage.

Tipo

Valores ENUM

TYPE_UNSPECIFIED O valor padrão. Não pode ser usado.
TYPE_PRODUCT_RECOGNITION Reconhecimento de produtos. Precisa ser usado em um RetailEndpoint com RetailProductRecognitionIndex implantado.
TYPE_TAG_RECOGNITION Detecção e análise de tags. Precisa ser usado em um RetailEndpoint com RetailTagRecognitionConfig.

RetailProductIoFormat

Representação JSON

{
  "retailProduct": { object(RetailProduct) },
  "retailProductImages": [ { object(RetailProductImage) }]
}

Campos

retailProduct objeto Obrigatório. RetailProduct para importar
retailProductImages[ ] objeto Opcional. RetailProductImages do RetailProduct especificado a serem importados.

RetailResourceState

Valores ENUM

RETAIL_RESOURCE_STATE_UNSPECIFIED O valor padrão. Não pode ser usado.
RETAIL_RESOURCE_STATE_CREATING Estado "Criando".
RETAIL_RESOURCE_STATE_CREATED Estado criado.
RETAIL_RESOURCE_STATE_UPDATING Atualizando o estado.
RETAIL_RESOURCE_STATE_DELETED Estado excluído.
RETAIL_RESOURCE_STATE_ERROR Erro de estado.