Package google.cloud.vision.v1p3beta1

Índice

ImageAnnotator

Serviço que executa tarefas de detecção da API Google Cloud Vision em imagens de clientes, como detecção facial, de ponto de referência, de logotipo, de rótulo e de texto. O serviço ImageAnnotator retorna as entidades detectadas das imagens.

AsyncBatchAnnotateFiles

rpc AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest) returns (Operation)

Executar detecção e anotação assíncronas de imagens em uma lista de arquivos genéricos, como arquivos PDF, que podem conter várias páginas e diversas imagens por página. O progresso e os resultados podem ser recuperados na interface google.longrunning.Operations. Operation.metadata contém OperationMetadata (metadados). Operation.response contém AsyncBatchAnnotateFilesResponse (resultados).

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

Para saber mais, consulte a Visão geral da autenticação.
BatchAnnotateImages

rpc BatchAnnotateImages(BatchAnnotateImagesRequest) returns (BatchAnnotateImagesResponse)

Executar detecção e anotação de imagem em um lote de imagens.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

Para saber mais, consulte a Visão geral da autenticação.

ProductSearch

Gerencia Products e ProductSets de imagens de referência para uso na pesquisa de produtos. Ele usa o seguinte modelo de recurso:

  • A API tem uma coleção de recursos ProductSet, denominada projects/*/locations/*/productSets/*, que coloca produtos diferentes em grupos para limitar a identificação.

Paralelamente,

  • A API tem uma coleção de recursos Product, denominada projects/*/locations/*/products/*.

  • Cada Product tem uma coleção de recursos ReferenceImage, denominada projects/*/locations/*/products/*/referenceImages/*.

AddProductToProductSet

rpc AddProductToProductSet(AddProductToProductSetRequest) returns (Empty)

Adiciona um Product ao ProductSet especificado. Se o Product já estiver presente, nenhuma alteração será feita.

Um Product pode ser adicionado a 100 ProductSets no máximo.

Erros possíveis:

  • Retorna NOT_FOUND quando o Product ou o ProductSet não existe.
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

Para saber mais, consulte a Visão geral da autenticação.
CreateProduct

rpc CreateProduct(CreateProductRequest) returns (Product)

Cria e retorna um recurso do produto.

Erros possíveis:

  • Retorna INVALID_ARGUMENT quando display_name não está preenchido ou tem mais de 4.096 caracteres.
  • Retorna INVALID_ARGUMENT quando a descrição tem mais de 4.096 caracteres.
  • Retorna INVALID_ARGUMENT quando a product_category está ausente ou é inválida.
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

Para saber mais, consulte a Visão geral da autenticação.
CreateProductSet

rpc CreateProductSet(CreateProductSetRequest) returns (ProductSet)

Cria e retorna um recurso ProductSet.

Erros possíveis:

  • Retorna INVALID_ARGUMENT quando display_name está ausente ou tem mais de 4.096 caracteres.
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

Para saber mais, consulte a Visão geral da autenticação.
CreateReferenceImage

rpc CreateReferenceImage(CreateReferenceImageRequest) returns (ReferenceImage)

Cria e retorna um recurso ReferenceImage.

O campo bounding_poly é opcional. Se bounding_poly não for especificado, o sistema vai tentar detectar regiões de interesse na imagem que sejam compatíveis com a product_category no produto pai. Se for especificado, a detecção será SEMPRE ignorada. O sistema converte polígonos em retângulos não girados.

O pipeline vai redimensionar a imagem se ela for muito grande para processar (acima de 50 MP).

Erros possíveis:

  • Retorna INVALID_ARGUMENT quando o image_uri está ausente ou tem mais de 4.096 caracteres.
  • Retorna INVALID_ARGUMENT quando o produto não existe.
  • Retorna INVALID_ARGUMENT quando bounding_poly não é fornecido e nada é aceito pela product_category do produto pai.
  • Retorna INVALID_ARGUMENT quando bounding_poly tem mais de 10 polígonos.
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

Para saber mais, consulte a Visão geral da autenticação.
DeleteProduct

rpc DeleteProduct(DeleteProductRequest) returns (Empty)

Exclui permanentemente um produto e as imagens de referência dele.

Os metadados do produto e todas as imagens dele são excluídos imediatamente, mas as consultas de pesquisa dos ProductSets que contêm o produto ainda podem funcionar até que todos os caches relacionados sejam atualizados.

Erros possíveis:

  • Retorna NOT_FOUND quando o produto não existe.
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

Para saber mais, consulte a Visão geral da autenticação.
DeleteProductSet

rpc DeleteProductSet(DeleteProductSetRequest) returns (Empty)

Exclui permanentemente um ProductSet. Os Products e as ReferenceImages no ProductSet não são excluídos.

Os arquivos de imagem reais não são excluídos do Google Cloud Storage.

Erros possíveis:

  • Retorna NOT_FOUND quando o ProductSet não existe.
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

Para saber mais, consulte a Visão geral da autenticação.
DeleteReferenceImage

rpc DeleteReferenceImage(DeleteReferenceImageRequest) returns (Empty)

Exclui permanentemente uma imagem de referência.

Embora os metadados da imagem sejam excluídos imediatamente, as consultas de pesquisa em ProductSets que contêm a imagem ainda podem funcionar até que todos os caches relacionados sejam atualizados.

Os arquivos de imagem reais não são excluídos do Google Cloud Storage.

Erros possíveis:

  • Retorna NOT_FOUND quando a imagem de referência não existe.
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

Para saber mais, consulte a Visão geral da autenticação.
GetProduct

rpc GetProduct(GetProductRequest) returns (Product)

Recebe informações associadas a um Product.

Erros possíveis:

  • Retorna NOT_FOUND quando o Product não existe.
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

Para saber mais, consulte a Visão geral da autenticação.
GetProductSet

rpc GetProductSet(GetProductSetRequest) returns (ProductSet)

Recebe informações associadas a um ProductSet.

Erros possíveis:

  • Retorna NOT_FOUND quando o ProductSet não existe.
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

Para saber mais, consulte a Visão geral da autenticação.
GetReferenceImage

rpc GetReferenceImage(GetReferenceImageRequest) returns (ReferenceImage)

Recebe informações associadas a uma ReferenceImage.

Erros possíveis:

  • Retorna NOT_FOUND quando a imagem especificada não existe.
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

Para saber mais, consulte a Visão geral da autenticação.
ImportProductSets

rpc ImportProductSets(ImportProductSetsRequest) returns (Operation)

API assíncrona que importa uma lista de imagens de referência para conjuntos de produtos especificados com base em uma lista de informações de imagem.

A API google.longrunning.Operation pode ser usada para acompanhar o progresso e os resultados da solicitação. Operation.metadata contém BatchOperationMetadata. (progresso) Operation.response contém ImportProductSetsResponse. (resultados)

A origem da entrada desse método é um arquivo CSV no Google Cloud Storage. Para o formato do arquivo CSV, consulte ImportProductSetsGcsSource.csv_file_uri.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

Para saber mais, consulte a Visão geral da autenticação.
ListProductSets

rpc ListProductSets(ListProductSetsRequest) returns (ListProductSetsResponse)

Lista os ProductSets em uma ordem não especificada.

Erros possíveis:

  • Retorna INVALID_ARGUMENT quando page_size é maior que 100 ou menor que 1.
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

Para saber mais, consulte a Visão geral da autenticação.
ListProducts

rpc ListProducts(ListProductsRequest) returns (ListProductsResponse)

Lista produtos em uma ordem não especificada.

Erros possíveis:

  • Retorna INVALID_ARGUMENT quando page_size é maior que 100 ou menor que 1.
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

Para saber mais, consulte a Visão geral da autenticação.
ListProductsInProductSet

rpc ListProductsInProductSet(ListProductsInProductSetRequest) returns (ListProductsInProductSetResponse)

Lista em uma ordem não especificada os Products em um ProductSet. Se o ProductSet não existir, o campo de produtos ficará vazio na resposta.

Erros possíveis:

  • Retorna INVALID_ARGUMENT quando page_size é maior que 100 ou menor que 1.
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

Para saber mais, consulte a Visão geral da autenticação.
ListReferenceImages

rpc ListReferenceImages(ListReferenceImagesRequest) returns (ListReferenceImagesResponse)

Lista as imagens de referência.

Erros possíveis:

  • Retorna NOT_FOUND quando o produto pai não existe.
  • Retorna INVALID_ARGUMENT quando page_size é maior que 100 ou menor que 1.
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

Para saber mais, consulte a Visão geral da autenticação.
RemoveProductFromProductSet

rpc RemoveProductFromProductSet(RemoveProductFromProductSetRequest) returns (Empty)

Remove um Product do ProductSet especificado.

Erros possíveis:

  • Retorna NOT_FOUND quando o Product não é encontrado no ProductSet.
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

Para saber mais, consulte a Visão geral da autenticação.
UpdateProduct

rpc UpdateProduct(UpdateProductRequest) returns (Product)

Faz alterações em um recurso Product. No momento, apenas os campos display_name, description e labels podem ser atualizados.

Se os rótulos forem atualizados, a alteração não será refletida nas consultas até o horário do próximo índice.

Erros possíveis:

  • Retorna NOT_FOUND quando o Product não existe.
  • Retorna INVALID_ARGUMENT quando display_name está presente em update_mask, mas está ausente na solicitação ou tem mais de 4.096 caracteres.
  • Retorna INVALID_ARGUMENT quando a descrição está presente em update_mask, mas tem mais de 4.096 caracteres.
  • Retorna INVALID_ARGUMENT quando product_category está presente em update_mask.
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

Para saber mais, consulte a Visão geral da autenticação.
UpdateProductSet

rpc UpdateProductSet(UpdateProductSetRequest) returns (ProductSet)

Faz alterações em um recurso ProductSet. No momento, apenas display_name pode ser atualizado.

Erros possíveis:

  • Retorna NOT_FOUND quando o ProductSet não existe.
  • Retorna INVALID_ARGUMENT quando display_name está presente em update_mask, mas está ausente na solicitação ou tem mais de 4.096 caracteres.
Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

Para saber mais, consulte a Visão geral da autenticação.

AddProductToProductSetRequest

Mensagem de solicitação para o método AddProductToProductSet.

Campos
name

string

O nome do recurso do ProductSet a ser modificado.

O formato é: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
product

string

O nome do recurso do Product a ser adicionado ao ProductSet.

O formato é: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

AnnotateFileResponse

Resposta a uma solicitação de anotação de arquivo única. Um arquivo pode conter uma ou mais imagens, que têm as próprias respostas.

Campos
input_config

InputConfig

Informações sobre o arquivo para que a resposta é gerada.

responses[]

AnnotateImageResponse

Respostas individuais às imagens encontradas no arquivo.

AnnotateImageRequest

Solicitação de execução de tarefas da API Google Cloud Vision em uma imagem fornecida pelo usuário, com recursos solicitados pelo usuário.

Campos
image

Image

A imagem a ser processada.

features[]

Feature

Recursos solicitados.

image_context

ImageContext

Contexto adicional que pode acompanhar a imagem.

AnnotateImageResponse

Resposta a uma solicitação de anotação de imagem.

Campos
face_annotations[]

FaceAnnotation

Quando presente, significa que a detecção facial foi concluída.

landmark_annotations[]

EntityAnnotation

Se presente, a detecção de ponto de referência foi concluída com sucesso.

logo_annotations[]

EntityAnnotation

Se presente, a detecção de logotipo foi concluída com sucesso.

label_annotations[]

EntityAnnotation

Quando presente, significa que a detecção de rótulos foi concluída.

localized_object_annotations[]

LocalizedObjectAnnotation

Quando presente, significa que a detecção localizada de objetos foi concluída. A classificação será decrescente por pontuação de confiança.

text_annotations[]

EntityAnnotation

Quando presente, significa que a detecção de texto (OCR) foi concluída.

full_text_annotation

TextAnnotation

Se presente, a detecção de texto (OCR) ou de texto de documentos foi concluída com sucesso. Esta anotação fornece a hierarquia estrutural para o texto detectado pelo OCR.

safe_search_annotation

SafeSearchAnnotation

Se presente, a anotação de pesquisa segura foi concluída com sucesso.

image_properties_annotation

ImageProperties

Se presente, as propriedades da imagem foram extraídas com sucesso.

crop_hints_annotation

CropHintsAnnotation

Se presente, as dicas de corte foram concluídas com sucesso.

web_detection

WebDetection

Quando presente, significa que a detecção da Web foi concluída.

product_search_results

ProductSearchResults

Quando presente, significa que a pesquisa de produtos foi concluída.

error

Status

Quando definido, representa a mensagem de erro da operação. Observe que há uma garantia de que as anotações de imagens preenchidas são corretas, mesmo quando error está definido.

context

ImageAnnotationContext

Quando presente, as informações contextuais são necessárias para entender a origem da imagem.

AsyncAnnotateFileRequest

Uma solicitação de anotação de arquivo off-line.

Campos
input_config

InputConfig

Obrigatório. Informações sobre o arquivo de entrada.

features[]

Feature

Obrigatório. Recursos solicitados.

image_context

ImageContext

Contexto adicional que pode acompanhar as imagens no arquivo.

output_config

OutputConfig

Obrigatório. Os metadados, como formato, e o local pretendido para a saída.

AsyncAnnotateFileResponse

A resposta a uma solicitação de anotação de arquivo off-line única.

Campos
output_config

OutputConfig

O local e os metadados da saída de AsyncAnnotateFileRequest.

AsyncBatchAnnotateFilesRequest

Várias solicitações de anotação assíncrona de arquivo são agrupadas em uma única chamada de serviço.

Campos
requests[]

AsyncAnnotateFileRequest

Solicitações individuais de anotação assíncrona de arquivo para este lote.

AsyncBatchAnnotateFilesResponse

Resposta a uma solicitação de anotação assíncrona de arquivo em lote.

Campos
responses[]

AsyncAnnotateFileResponse

A lista de respostas de anotação de arquivo, uma para cada solicitação em AsyncBatchAnnotateFilesRequest.

BatchAnnotateImagesRequest

Várias solicitações de anotação de imagem são agrupadas em uma única chamada de serviço.

Campos
requests[]

AnnotateImageRequest

Solicitações individuais de anotação de imagem para este lote.

BatchAnnotateImagesResponse

Resposta a uma solicitação de anotação de imagem em lote.

Campos
responses[]

AnnotateImageResponse

Respostas individuais às solicitações de anotação de imagem no lote.

BatchOperationMetadata

Metadados das operações em lote, como o estado atual.

Está incluído no campo metadata do Operation retornado pela chamada GetOperation do serviço google::longrunning::Operations.

Campos
state

State

O estado atual da operação em lote.

submit_time

Timestamp

A hora em que a solicitação em lote foi enviada ao servidor.

end_time

Timestamp

A hora em que a solicitação em lote é concluída e google.longrunning.Operation.done é definido como verdadeiro.

State

Enumera os possíveis estados da solicitação em lote.

Tipos enumerados
STATE_UNSPECIFIED Inválido.
PROCESSING A solicitação está sendo processada.
SUCCESSFUL A solicitação foi concluída e pelo menos um item foi processado.
FAILED A solicitação foi concluída e nenhum item foi processado.
CANCELLED A solicitação foi concluída após o usuário ter chamado longrunning.Operations.CancelOperation. Todos os registros que foram processados antes do comando de cancelamento são emitidos conforme especificado na solicitação.

Block

Elemento lógico na página.

Campos
property

TextProperty

Informações adicionais detectadas para o bloco.

bounding_box

BoundingPoly

A caixa delimitadora do bloco. Os vértices estão na seguinte ordem: superior esquerda, superior direita, inferior direita e inferior esquerda. Quando for detectada uma rotação da caixa delimitadora, ela será representada no canto superior esquerdo, como definido pela leitura do texto na orientação natural. Exemplo:

  • Quando o texto é horizontal, pode ser semelhante ao seguinte:
    0----1
    |    |
    3----2
  • Quando girada 180 graus em torno do canto superior esquerdo, ela se torna:
    2----3
    |    |
    1----0

e a ordem dos vértices ainda será (0, 1, 2, 3).
paragraphs[]

Paragraph

Lista de parágrafos neste bloco, se ele for do tipo: texto.

block_type

BlockType

Tipo de bloco detectado (texto, imagem etc.) para este bloco.

confidence

float

Confiança dos resultados do OCR no bloco. Intervalo [0, 1].

BlockType

Tipo de um bloco (texto, imagem etc.), conforme identificado pelo OCR.

Tipos enumerados
UNKNOWN Tipo de bloco desconhecido
TEXT Bloco de texto regular
TABLE Bloco de tabelas
PICTURE Bloco de imagens
RULER Caixa de linha horizontal/vertical
BARCODE Bloco de códigos de barras

BoundingPoly

Um polígono delimitador para a anotação de imagem detectada.

Campos
vertices[]

Vertex

Os vértices do polígono delimitador.

normalized_vertices[]

NormalizedVertex

Os vértices normalizados do polígono delimitador.

ColorInfo

As informações de cores consistem em canais RGB, pontuação e a fração da imagem ocupada pela cor.

Campos
color

Color

Componentes RGB da cor.

score

float

Pontuação específica da imagem referente a esta cor. Valor no intervalo [0, 1].

pixel_fraction

float

A fração de pixels que a cor ocupa na imagem. Valor no intervalo [0, 1].

CreateProductRequest

Mensagem de solicitação para o método CreateProduct.

Campos
parent

string

O projeto em que o Product será criado.

O formato é projects/PROJECT_ID/locations/LOC_ID.
product

Product

O produto a ser criado.

product_id

string

Um ID de recurso fornecido pelo usuário para o Product. Se definido, o servidor vai tentar usar esse valor como o ID do recurso. Se ele já estiver em uso, um erro será retornado com o código ALREADY_EXISTS. Precisa ter no máximo 128 caracteres. Não pode conter o caractere /.

CreateProductSetRequest

Mensagem de solicitação para o método CreateProductSet.

Campos
parent

string

O projeto em que o ProductSet será criado.

O formato é projects/PROJECT_ID/locations/LOC_ID.
product_set

ProductSet

O ProductSet a ser criado.

product_set_id

string

Um ID de recurso fornecido pelo usuário para o ProductSet. Se definido, o servidor vai tentar usar esse valor como o ID do recurso. Se ele já estiver em uso, um erro será retornado com o código ALREADY_EXISTS. Precisa ter no máximo 128 caracteres. Não pode conter o caractere /.

CreateReferenceImageRequest

Mensagem de solicitação para o método CreateReferenceImage.

Campos
parent

string

Nome do recurso do produto onde será criada a imagem de referência.

O formato é projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.
reference_image

ReferenceImage

A imagem de referência a ser criada. Se um ID de imagem for especificado, ele será ignorado.

reference_image_id

string

Um ID de recurso fornecido pelo usuário para a ReferenceImage a ser adicionada. Se definido, o servidor vai tentar usar esse valor como o ID do recurso. Se ele já estiver em uso, um erro será retornado com o código ALREADY_EXISTS. Precisa ter no máximo 128 caracteres. Não pode conter o caractere /.

CropHint

Dica de corte único usada para gerar um novo corte ao suprir uma imagem.

Campos
bounding_poly

BoundingPoly

O polígono delimitador da região do corte. As coordenadas da caixa delimitadora estão na escala da imagem original, conforme retornado em ImageParams.

confidence

float

A confiança de que se trata de uma região saliente. Intervalo [0, 1].

importance_fraction

float

Fração de importância desta região saliente em relação à imagem original.

CropHintsAnnotation

Conjunto de dicas de corte usadas para gerar novos cortes ao suprir as imagens.

Campos
crop_hints[]

CropHint

Resultados da dica de corte.

CropHintsParams

Parâmetros para solicitação de anotação de dicas de corte.

Campos
aspect_ratios[]

float

Índices proporcionais nas flutuações, representando a proporção entre a largura e a altura da imagem. Por exemplo, se a proporção desejada for 4/3, o valor de flutuação correspondente deverá ser 1,33333. Se ele não for especificado, o melhor corte possível será retornado. O número de proporções fornecidas tem um limite máximo de 16. Acima disso, elas são ignoradas.

DeleteProductRequest

Mensagem de solicitação para o método DeleteProduct.

Campos
name

string

Nome do recurso do produto a ser excluído.

O formato é: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

DeleteProductSetRequest

Mensagem de solicitação para o método DeleteProductSet.

Campos
name

string

Nome do recurso do ProductSet a ser excluído.

O formato é: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

DeleteReferenceImageRequest

Mensagem de solicitação para o método DeleteReferenceImage.

Campos
name

string

O nome do recurso da imagem de referência a ser excluída.

O formato é:

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID

DominantColorsAnnotation

Conjunto de cores dominantes e as pontuações correspondentes.

Campos
colors[]

ColorInfo

Valores de cor RGB com a respectiva fração de pontuação e pixel.

EntityAnnotation

Conjunto de recursos detectados da entidade.

Campos
mid

string

ID da entidade opaca. Alguns IDs podem estar disponíveis na API Google Knowledge Graph Search.

locale

string

O código do idioma da localidade em que a description textual da entidade é expressa.

description

string

Descrição textual da entidade, expressa no respectivo idioma de locale.

score

float

Pontuação geral do resultado. Intervalo [0, 1].

confidence
(deprecated)

float

Descontinuado. Use score. A precisão da detecção de entidade em uma imagem. Por exemplo, para uma imagem em que a entidade "Torre Eiffel" é detectada, esse campo representa a confiança de que há uma torre na imagem da consulta. Intervalo [0, 1].
topicality

float

A relevância do marcador de anotação de conteúdo da imagem (ICA, na sigla em inglês) em relação à imagem. Por exemplo, a relevância de "torre" provavelmente é maior em uma imagem que contém a "Torre Eiffel" detectada do que em uma imagem com um prédio alto distante detectado, mesmo que a confiança de que há uma torre em cada imagem possa ser a mesma. Intervalo [0, 1].

bounding_poly

BoundingPoly

Região da imagem a que esta entidade pertence. Não produzido para os recursos LABEL_DETECTION.

locations[]

LocationInfo

As informações de local da entidade detectada. Vários elementos de LocationInfo podem estar presentes porque um local pode indicar a localização da cena na imagem, e outro pode indicar a localização do lugar em que a imagem foi gerada. Em geral, há informações de local disponíveis para pontos de referência.

properties[]

Property

Algumas entidades podem ter campos opcionais de Property (nome/valor) fornecidos pelo usuário, como pontuação ou string que qualifica a entidade.

FaceAnnotation

Um objeto de anotação de rosto contém os resultados da detecção facial.

Campos
bounding_poly

BoundingPoly

O polígono delimitador ao redor do rosto. As coordenadas da caixa delimitadora estão na escala da imagem original, conforme retornado em ImageParams. A caixa delimitadora é processada para enquadrar o rosto de acordo com as expectativas humanas. Ela usa como base os resultados do detector de ponto de referência. Uma ou mais coordenadas X ou Y talvez não sejam geradas no BoundingPoly (o polígono será ilimitado) se apenas parte do rosto aparecer na imagem que será anotada.

fd_bounding_poly

BoundingPoly

O polígono delimitador fd_bounding_poly é mais restrito que o boundingPoly e inclui apenas a parte da pele do rosto. Normalmente, ele é usado para eliminar o rosto de qualquer análise da imagem que detecta a quantidade de pele visível. Ele não se baseia nos resultados do detector de ponto de referência, apenas na detecção inicial de rosto. Por isso, há o prefixo

fd

(detecção de rosto).
landmarks[]

Landmark

Pontos de referência detectados do rosto.

roll_angle

float

Ângulo de giro, que indica a quantidade de rotação no sentido horário/anti-horário do rosto em relação à imagem vertical do eixo perpendicular ao rosto. Intervalo [-180,180].

pan_angle

float

Ângulo de desvio, que indica o ângulo de desvio para a esquerda/direita que o rosto aponta em relação ao plano vertical perpendicular à imagem. Intervalo [-180,180].

tilt_angle

float

Ângulo de inclinação, que indica o ângulo de inclinação para cima/baixo que o rosto aponta em relação ao plano horizontal da imagem. Intervalo [-180,180].

detection_confidence

float

Confiança da detecção. Intervalo [0, 1].

landmarking_confidence

float

Confiança da detecção de ponto de referência do rosto. Intervalo [0, 1].

joy_likelihood

Likelihood

Probabilidade de alegria.

sorrow_likelihood

Likelihood

Probabilidade de tristeza.

anger_likelihood

Likelihood

Probabilidade de raiva.

surprise_likelihood

Likelihood

Probabilidade de surpresa.

under_exposed_likelihood

Likelihood

Probabilidade de subexposição.

blurred_likelihood

Likelihood

Probabilidade de desfoque.

headwear_likelihood

Likelihood

Probabilidade de acessório na cabeça.

Ponto de referência

Um ponto de referência específico do rosto. Por exemplo, uma característica.

Campos
type

Type

Tipo de ponto de referência do rosto.

position

Position

Posição do ponto de referência do rosto.

Tipo

Tipo de ponto de referência do rosto (característica). Os lados esquerdo e direito são definidos do ponto de vista de quem vê a imagem, sem considerar as projeções de espelhamento típicas das fotos. Normalmente, LEFT_EYE é o olho direito da pessoa.

Tipos enumerados
UNKNOWN_LANDMARK Ponto de referência desconhecido do rosto detectado. Não preencha.
LEFT_EYE Olho esquerdo.
RIGHT_EYE Olho direito.
LEFT_OF_LEFT_EYEBROW Esquerda da sobrancelha esquerda.
RIGHT_OF_LEFT_EYEBROW Direita da sobrancelha esquerda.
LEFT_OF_RIGHT_EYEBROW Esquerda da sobrancelha direita.
RIGHT_OF_RIGHT_EYEBROW Direita da sobrancelha direita.
MIDPOINT_BETWEEN_EYES Ponto intermediário entre os olhos.
NOSE_TIP Ponta do nariz.
UPPER_LIP Lábio superior.
LOWER_LIP Lábio inferior.
MOUTH_LEFT Lado esquerdo da boca.
MOUTH_RIGHT Lado direito da boca.
MOUTH_CENTER Centro da boca.
NOSE_BOTTOM_RIGHT Nariz, parte inferior direita.
NOSE_BOTTOM_LEFT Nariz, parte inferior esquerda.
NOSE_BOTTOM_CENTER Nariz, centro inferior.
LEFT_EYE_TOP_BOUNDARY Olho esquerdo, limite superior.
LEFT_EYE_RIGHT_CORNER Olho esquerdo, canto direito.
LEFT_EYE_BOTTOM_BOUNDARY Olho esquerdo, limite inferior.
LEFT_EYE_LEFT_CORNER Olho esquerdo, canto esquerdo.
RIGHT_EYE_TOP_BOUNDARY Olho direito, limite superior.
RIGHT_EYE_RIGHT_CORNER Olho direito, canto direito.
RIGHT_EYE_BOTTOM_BOUNDARY Olho direito, limite inferior.
RIGHT_EYE_LEFT_CORNER Olho direito, canto esquerdo.
LEFT_EYEBROW_UPPER_MIDPOINT Sobrancelha esquerda, ponto intermediário superior.
RIGHT_EYEBROW_UPPER_MIDPOINT Sobrancelha direita, ponto intermediário superior.
LEFT_EAR_TRAGION Trágus da orelha esquerda.
RIGHT_EAR_TRAGION Trágus da orelha direita.
LEFT_EYE_PUPIL Pupila do olho esquerdo.
RIGHT_EYE_PUPIL Pupila do olho direito.
FOREHEAD_GLABELLA Glabela da testa.
CHIN_GNATHION Gnátio do queixo.
CHIN_LEFT_GONION Gônio esquerdo do queixo.
CHIN_RIGHT_GONION Gônio direito do queixo.

Recurso

O tipo de detecção da API Google Cloud Vision a ser executada e o número máximo de resultados a serem retornados para esse tipo. Vários objetos Feature podem ser especificados na lista features.

Campos
type

Type

O tipo de recurso.

max_results

int32

Número máximo de resultados do tipo. Não se aplica a TEXT_DETECTION, DOCUMENT_TEXT_DETECTION ou CROP_HINTS.

model

string

Modelo a ser usado com o recurso. Valores aceitos: "builtin/stable", o padrão se não definido, e "builtin/latest".

Tipo

Tipo de recurso da API Google Cloud Vision a ser extraído.

Tipos enumerados
TYPE_UNSPECIFIED Tipo de recurso não especificado.
FACE_DETECTION Executar detecção facial.
LANDMARK_DETECTION Executar detecção de ponto de referência.
LOGO_DETECTION Executar detecção de logotipo.
LABEL_DETECTION Executar detecção de rótulos.
TEXT_DETECTION Executar detecção de texto/reconhecimento óptico de caracteres (OCR). A detecção de texto é otimizada para áreas de texto em uma imagem maior. Se a imagem for um documento, use DOCUMENT_TEXT_DETECTION.
DOCUMENT_TEXT_DETECTION Executar o OCR em um documento de texto denso. Tem precedência quando DOCUMENT_TEXT_DETECTION e TEXT_DETECTION estão presentes.
SAFE_SEARCH_DETECTION Executar a Pesquisa segura para detectar conteúdos que podem não ser seguros ou são indesejáveis.
IMAGE_PROPERTIES Calcular um conjunto de propriedades de imagem, como as cores dominantes.
CROP_HINTS Executar dicas de corte.
WEB_DETECTION Executar detecção da Web.
OBJECT_LOCALIZATION Executar localizador para detecção de objetos.

GcsDestination

O local do Google Cloud Storage em que a saída será gravada.

Campos
uri

string

URI do Google Cloud Storage em que os resultados serão armazenados. Os resultados estarão no formato JSON precedidos pelo URI de entrada correspondente. Esse campo pode representar um único arquivo ou um prefixo para várias saídas. Os prefixos precisam terminar com /.

Exemplos:

Se houver várias saídas, cada resposta ainda será AnnotationFileResponse e cada uma conterá um subconjunto da lista completa de AnnotateImageResponse. Poderá haver várias saídas se, por exemplo, o JSON de saída for muito grande e for distribuído por vários arquivos fragmentados.

GcsSource

Local do Google Cloud Storage em que a entrada será lida.

Campos
uri

string

URI do Google Cloud Storage para o arquivo de entrada. Precisa ser apenas um objeto do Google Cloud Storage. Caracteres curinga não são aceitos no momento.

GetProductRequest

Mensagem de solicitação para o método GetProduct.

Campos
name

string

Nome do recurso do Product a ser recebido.

O formato é: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

GetProductSetRequest

Mensagem de solicitação para o método GetProductSet.

Campos
name

string

Nome do recurso do ProductSet a ser recebido.

O formato é: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

GetReferenceImageRequest

Mensagem de solicitação para o método GetReferenceImage.

Campos
name

string

O nome do recurso da ReferenceImage a ser recebida.

O formato é:

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID.

Imagem

Imagem do cliente em que serão executadas as tarefas da API Google Cloud Vision.

Campos
content

bytes

Conteúdo da imagem, representado como um stream de bytes. Observação: assim como acontece com todos os campos bytes, os protobuffers usam uma representação binária pura, e as representações JSON usam Base64.

source

ImageSource

URL da imagem do Google Cloud Storage ou URL da imagem acessível publicamente. Se content e source forem fornecidos para uma imagem, content terá precedência e será usado para executar a solicitação de anotação de imagem.

ImageAnnotationContext

Se uma imagem foi produzida com base em um arquivo, como um PDF, essa mensagem fornece informações sobre a origem da imagem.

Campos
uri

string

O URI do arquivo usado para produzir a imagem.

page_number

int32

Se o arquivo for um PDF ou TIFF, esse campo vai fornecer o número da página no arquivo usado para produzir a imagem.

ImageContext

Contexto da imagem e/ou parâmetros específicos do recurso.

Campos
lat_long_rect

LatLongRect

Não utilizado.

language_hints[]

string

Lista de idiomas a serem usados para TEXT_DETECTION. Na maioria dos casos, um valor vazio produz os melhores resultados porque possibilita a detecção automática de idioma. Para idiomas baseados no alfabeto latino, não é necessário definir language_hints. Em alguns casos raros, quando o idioma do texto na imagem é conhecido, você recebe resultados melhores definindo uma dica. No entanto, isso poderá ser um problema se ela for definida incorretamente. A detecção de texto vai retornar um erro se um ou mais dos idiomas especificados não forem aceitos.

crop_hints_params

CropHintsParams

Parâmetros para solicitação de anotação de dicas de corte.

product_search_params

ProductSearchParams

Parâmetros para pesquisa de produtos.

web_detection_params

WebDetectionParams

Parâmetros para detecção da Web.

ImageProperties

Armazena as propriedades da imagem, como as cores dominantes.

Campos
dominant_colors

DominantColorsAnnotation

Se presente, as cores dominantes foram concluídas com sucesso.

ImageSource

Origem da imagem externa (Google Cloud Storage ou URL da Web do local da imagem).

Campos
gcs_image_uri

string

Use image_uri.

O URI do Google Cloud Storage no formato gs://bucket_name/object_name. O controle de versão do objeto não é aceito. Consulte URIs de solicitação do Google Cloud Storage para mais informações.
image_uri

string

O URI da imagem de origem. Pode ser:

  1. Um URI do Google Cloud Storage no formato gs://bucket_name/object_name. O controle de versão do objeto não é aceito. Consulte URIs de solicitação do Google Cloud Storage para mais informações.

  2. Um URL HTTP/HTTPS da imagem que seja acessível publicamente. Ao buscar imagens em URLs HTTP/HTTPS, o Google não pode garantir que a solicitação seja concluída. A solicitação poderá falhar se o host especificado negá-la, como por limitação da solicitação ou prevenção de DOS, ou se o Google limitar as solicitações ao site para prevenção de abuso. Não é recomendado usar imagens hospedadas externamente em aplicativos de produção.

Quando gcs_image_uri e image_uri são especificados, image_uri tem precedência.

ImportProductSetsGcsSource

O local do Google Cloud Storage para um arquivo CSV que preserva uma lista de ImportProductSetRequests em cada linha.

Campos
csv_file_uri

string

O URI do Google Cloud Storage do arquivo CSV de entrada.

O URI precisa começar com gs://.

O formato do arquivo CSV de entrada deve ser uma imagem por linha. Em cada linha, há oito colunas.

  1. image-uri
  2. image-id
  3. product-set-id
  4. product-id
  5. product-category
  6. product-display-name
  7. labels
  8. bounding-poly

As colunas image-uri, product-set-id, product-id e product-category são obrigatórias. Todas as outras são opcionais.

Se o ProductSet ou o Product especificado pelos valores product-set-id e product-id não existir, o sistema criará um ProductSet ou Product para a imagem. Nesse caso, a coluna product-display-name refere-se a display_name, a coluna product-category refere-se a product_category e a coluna labels refere-se a product_labels.

A coluna image-id é opcional, mas precisa ser exclusiva caso seja fornecida. Se ela estiver vazia, o sistema atribuirá automaticamente um ID exclusivo à imagem.

A coluna product-display-name é opcional. Se estiver vazia, o sistema definirá o campo display_name do produto como um espaço. É possível atualizar o display_name posteriormente usando a API.

Se um Product com o product-id especificado já existir, o sistema vai ignorar as colunas product-display-name, product-category e labels.

A coluna labels (opcional) é uma linha com uma lista de pares de chave-valor separados por vírgula, no seguinte formato:

"key_1=value_1,key_2=value_2,...,key_n=value_n"

A coluna bounding-poly (opcional) identifica uma região de interesse da imagem da mesma forma que CreateReferenceImage. Se você não especificar a coluna bounding-poly, o sistema vai tentar detectar automaticamente as regiões de interesse.

No máximo, uma coluna bounding-poly é permitida por linha. Se a imagem tiver várias regiões de interesse, adicione uma linha ao arquivo CSV que inclua as mesmas informações de produto e os valores bounding-poly de cada região de interesse.

A coluna bounding-poly precisa conter um número par de números separados por vírgula, no formato p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y. Use números inteiros não negativos para polígonos delimitadores absolutos e valores flutuantes em [0, 1] para polígonos delimitadores normalizados.

O sistema vai redimensionar a imagem se ela for muito grande para processar (maior que 20 MP).

ImportProductSetsInputConfig

O conteúdo de entrada para o método ImportProductSets.

Campos
gcs_source

ImportProductSetsGcsSource

O local do Google Cloud Storage para um arquivo CSV que preserva uma lista de ImportProductSetRequests em cada linha.

ImportProductSetsRequest

Mensagem de solicitação para o método ImportProductSets.

Campos
parent

string

O projeto em que os ProductSets serão importados.

O formato é projects/PROJECT_ID/locations/LOC_ID.
input_config

ImportProductSetsInputConfig

O conteúdo de entrada da lista de solicitações.

ImportProductSetsResponse

Mensagem de resposta para o método ImportProductSets.

Essa mensagem é retornada pelo método google.longrunning.Operations.GetOperation no campo google.longrunning.Operation.response.

Campos
reference_images[]

ReferenceImage

A lista de reference_images importadas.

statuses[]

Status

O status de RPC de cada solicitação ImportProductSet, incluindo sucessos e erros.

O número de status aqui corresponde ao número de linhas no arquivo CSV, e status[i] armazena os status de sucesso ou falha do processamento da linha i do CSV, começando pela linha 0.

InputConfig

Os metadados e o local pretendido para a entrada.

Campos
gcs_source

GcsSource

Local do Google Cloud Storage em que a entrada será lida.

mime_type

string

O tipo do arquivo. No momento, somente application/pdf e image/tiff são aceitos. Caracteres curinga não são aceitos.

LatLongRect

Retângulo determinado por pares mínimos e máximos de LatLng.

Campos
min_lat_lng

LatLng

Par "lat/long" mínimo.

max_lat_lng

LatLng

Par "lat/long" máximo.

Likelihood

Uma representação de probabilidade em intervalos com o objetivo de gerar resultados altamente estáveis aos clientes em todos os upgrades de modelo.

Tipos enumerados
UNKNOWN Probabilidade desconhecida.
VERY_UNLIKELY É muito improvável que a imagem pertença à vertical especificada.
UNLIKELY É improvável que a imagem pertença à vertical especificada.
POSSIBLE É possível que a imagem pertença à vertical especificada.
LIKELY É provável que a imagem pertença à vertical especificada.
VERY_LIKELY É muito provável que a imagem pertença à vertical especificada.

ListProductSetsRequest

Mensagem de solicitação para o método ListProductSets.

Campos
parent

string

O projeto com os ProductSets que precisam ser listados.

O formato é projects/PROJECT_ID/locations/LOC_ID.
page_size

int32

O número máximo de itens a serem retornados. O padrão é 10 e o máximo é 100.

page_token

string

O next_page_token retornado de uma solicitação List anterior, se houver.

ListProductSetsResponse

Mensagem de resposta para o método ListProductSets.

Campos
product_sets[]

ProductSet

Lista de ProductSets.

next_page_token

string

Token para recuperar a próxima página de resultados ou um valor vazio se não houver mais resultados na lista.

ListProductsInProductSetRequest

Mensagem de solicitação para o método ListProductsInProductSet.

Campos
name

string

O recurso ProductSet com os Products que serão recuperados.

O formato é: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
page_size

int32

O número máximo de itens a serem retornados. O padrão é 10 e o máximo é 100.

page_token

string

O next_page_token retornado de uma solicitação List anterior, se houver.

ListProductsInProductSetResponse

Mensagem de resposta para o método ListProductsInProductSet.

Campos
products[]

Product

A lista de Products.

next_page_token

string

Token para recuperar a próxima página de resultados ou um valor vazio se não houver mais resultados na lista.

ListProductsRequest

Mensagem de solicitação para o método ListProducts.

Campos
parent

string

O projeto OU ProductSet com os Products que serão listados.

Formato: projects/PROJECT_ID/locations/LOC_ID
page_size

int32

O número máximo de itens a serem retornados. O padrão é 10 e o máximo é 100.

page_token

string

O next_page_token retornado de uma solicitação List anterior, se houver.

ListProductsResponse

Mensagem de resposta para o método ListProducts.

Campos
products[]

Product

Lista de produtos.

next_page_token

string

Token para recuperar a próxima página de resultados ou um valor vazio se não houver mais resultados na lista.

ListReferenceImagesRequest

Mensagem de solicitação para o método ListReferenceImages.

Campos
parent

string

Nome do recurso do produto que contém as imagens de referência.

O formato é projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.
page_size

int32

O número máximo de itens a serem retornados. O padrão é 10 e o máximo é 100.

page_token

string

Um token que identifica uma página de resultados a serem retornados. Esse é o valor de nextPageToken retornado em uma solicitação de lista de imagens de referência anterior.

Se não for especificado, o padrão será a primeira página.

ListReferenceImagesResponse

Mensagem de resposta para o método ListReferenceImages.

Campos
reference_images[]

ReferenceImage

A lista de imagens de referência.

page_size

int32

O número máximo de itens a serem retornados. O padrão é 10 e o máximo é 100.

next_page_token

string

O next_page_token retornado de uma solicitação List anterior, se houver.

LocalizedObjectAnnotation

Conjunto de objetos detectados com caixas delimitadoras.

Campos
mid

string

ID do objeto que deve se alinhar a EntityAnnotation no meio.

language_code

string

O código de idioma BCP-47, como pt-BR ou en-US. Para mais informações, consulte http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

name

string

Nome do objeto, expresso no idioma language_code.

score

float

Pontuação do resultado. Intervalo [0, 1].

bounding_poly

BoundingPoly

Região da imagem a que o objeto pertence. Esse campo precisa ser preenchido.

LocationInfo

Informações de local da entidade detectada.

Campos
lat_lng

LatLng

Coordenadas de local lat/long.

NormalizedVertex

Um vértice representa um ponto 2D na imagem. OBSERVAÇÃO: as coordenadas do vértice normalizado são relativas à imagem original e variam de 0 a 1.

Campos
x

float

Coordenada X.

y

float

Coordenada Y.

Zero coordinate values


The general format for bounding polys in the JSON response when detected is an array of 4 vertex objects:
  • [{"x": 0.063,"y": 0.018},{"x": 0.123,"y": 0.018},{"x": 0.123,"y": 0.038},{"x": 0.063,"y": 0.038}]
When the API detects a coordinate ("x" or "y") value of 0.0, that coordinate is omitted in the JSON response. For example, a response could take the following form: [{},{"x": 0.028}, {"x": 0.028,"y": 0.043},{"y": 0.043}]. This response shows all three representation possibilities:
  • {} - an empty object when both "x":0.0 and "y":0.0.
  • {"x": 0.028} and {"y": 0.043} - an object with a single key-value pair when one coordinate is 0.0 but the other is a non-zero value.
  • {"x": 0.028,"y": 0.043} - an object with both key-value pairs when both coordinates have a non-zero value.

OperationMetadata

Contém os metadados da operação BatchAnnotateImages.

Campos
state

State

Estado atual da operação em lote.
create_time

Timestamp

A hora em que a solicitação em lote foi recebida.
update_time

Timestamp

A hora em que o resultado da operação foi atualizado pela última vez.

State

Estados de operação em lote.

Tipos enumerados
STATE_UNSPECIFIED Inválido.
CREATED A solicitação é recebida.
RUNNING A solicitação está sendo processada.
DONE O processamento em lote foi concluído.
CANCELLED O processamento em lote foi cancelado.

OutputConfig

Os metadados e o local pretendido para a saída.

Campos
gcs_destination

GcsDestination

O local do Google Cloud Storage em que a saída será gravada.

batch_size

int32

O número máximo de protos de resposta a serem colocados em cada arquivo JSON de saída no Google Cloud Storage. O intervalo válido é [1, 100]. Se não for especificado, o valor padrão será 20.

Por exemplo, para um arquivo PDF com 100 páginas, serão gerados 100 protos de resposta. Se batch_size = 20, cinco arquivos JSON, cada um com 20 protos de resposta, serão gravados com o prefixo gcs_destination.uri.

No momento, batch_size só se aplica a GcsDestination, com possível suporte futuro para outras configurações de saída.

Página

Página detectada do OCR.

Campos
property

TextProperty

Informações adicionais detectadas na página.

width

int32

Largura da página. Nos PDFs, a unidade é a pontuação. Para imagens (incluindo TIFFs), a unidade é pixels.

height

int32

Altura da página. Nos PDFs, a unidade é a pontuação. Para imagens (incluindo TIFFs), a unidade é pixels.

blocks[]

Block

Lista de blocos de texto, imagens, entre outros, nesta página.

confidence

float

Confiança dos resultados do OCR na página. Intervalo [0, 1].

Paragraph

Unidade estrutural de texto que representa uma série de palavras em determinada ordem.

Campos
property

TextProperty

Informações adicionais detectadas para o parágrafo.

bounding_box

BoundingPoly

A caixa delimitadora do parágrafo. Os vértices estão na seguinte ordem: superior esquerda, superior direita, inferior direita e inferior esquerda. Quando for detectada uma rotação da caixa delimitadora, ela será representada no canto superior esquerdo, como definido pela leitura do texto na orientação natural. Por exemplo: * quando o texto é horizontal, é semelhante ao seguinte: 0----1 | | 3----2 * quando é girado em 180 graus em torno do canto superior esquerdo, torna-se: 2----3 | | 1----0, e a ordem dos vértices ainda é (0, 1, 2, 3).

words[]

Word

Lista de palavras neste parágrafo.

confidence

float

Confiança dos resultados do OCR para o parágrafo. Intervalo [0, 1].

Position

Uma posição 3D na imagem, usada principalmente para pontos de referência de detecção facial. Uma posição válida precisa ter as coordenadas X e Y. As coordenadas da posição estão na mesma escala que a imagem original.

Campos
x

float

Coordenada X.

y

float

Coordenada Y.

z

float

Coordenada Z (ou profundidade).

Product

Um Product contém ReferenceImages.

Campos
name

string

O nome do recurso do produto.

O formato é: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

Esse campo é ignorado ao criar um produto.
display_name

string

O nome fornecido pelo usuário para o Product. Não pode ficar em branco. Pode ter no máximo 4.096 caracteres.

description

string

Metadados fornecidos pelo usuário a serem armazenados com o produto. Pode ter no máximo 4.096 caracteres.

product_category

string

A categoria do produto identificado pela imagem de referência. Pode ser: homegoods, apparel ou toys.

Esse campo não pode ser modificado.
product_labels[]

KeyValue

Pares de chave-valor que podem ser anexados a um produto. No momento da consulta, é possível especificar restrições com base nos product_labels.

Valores inteiros podem ser fornecidos como strings. Por exemplo, 1199. Somente strings com valores inteiros funcionam com uma restrição baseada em intervalo, que será aceita em breve.

Vários valores podem ser atribuídos à mesma chave. Um produto pode ter até 100 product_labels.

KeyValue

Um rótulo de produto representado como um par de chave-valor.

Campos
key

string

A chave do rótulo anexado ao produto. Não pode estar vazio e não pode exceder 128 bytes.

value

string

O valor do rótulo anexado ao produto. Não pode estar vazio e não pode exceder 128 bytes.

ProductSearchParams

Parâmetros para uma solicitação de pesquisa de produtos.

Campos
bounding_poly

BoundingPoly

O polígono delimitador ao redor da área de interesse na imagem. Opcional. Se não for especificado, o critério do sistema será aplicado.

product_set

string

O nome do recurso de um ProductSet para pesquisar imagens semelhantes.

O formato é: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.
product_categories[]

string

A lista de categorias de produtos para pesquisar. No momento, apenas a primeira categoria é considerada e é necessário especificar: homegoods, apparel ou toys.

filter

string

A expressão de filtragem. Essa opção pode ser usada para restringir os resultados da pesquisa com base nos rótulos do Product. No momento, aceitamos expressões de chave-valor em AND ou OR. No entanto, cada expressão em OR precisa ter a mesma chave.

Por exemplo, é aceito: (color = red OR color = blue) AND brand = Google. Não é aceito: (color = red OR brand = Google) ou color: red.

ProductSearchResults

Resultados para uma solicitação de pesquisa de produtos.

Campos
index_time

Timestamp

O carimbo de data/hora do índice que forneceu esses resultados. As alterações feitas após esse período não serão refletidas nos resultados atuais.

results[]

Result

Lista de resultados, um para cada correspondência de produto.

product_grouped_results[]

GroupedResult

Lista de resultados agrupados por produtos detectados na imagem da consulta. Cada entrada corresponde a um polígono delimitador na imagem da consulta e contém os produtos correspondentes específicos dessa região. Pode haver correspondências duplicadas de produtos na união de todos os resultados por produto.

GroupedResult

Informações sobre os produtos semelhantes a um único produto em uma imagem de consulta.

Campos
bounding_poly

BoundingPoly

O polígono delimitador ao redor do produto detectado na imagem da consulta.

results[]

Result

Lista de resultados, um para cada correspondência de produto.

Resultado

Informações sobre um produto.

Campos
product

Product

O Product.

score

float

Nível de confiança na correspondência, variando de 0 (nenhuma confiança) a 1 (confiança total).

image

string

O nome do recurso da imagem do produto que é a correspondência mais próxima da consulta.

ProductSet

Um ProductSet contém Products. Ele pode conter no máximo 1 milhão de imagens de referência. Se o limite for excedido, a indexação periódica falhará.

Campos
name

string

O nome do recurso do ProductSet.

O formato é: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.

Este campo é ignorado ao criar um ProductSet.
display_name

string

O nome fornecido pelo usuário para o ProductSet. Não pode ficar em branco. Pode ter no máximo 4.096 caracteres.

index_time

Timestamp

Apenas saída. A hora em que o ProductSet foi indexado pela última vez. Os resultados da consulta vão refletir todas as atualizações anteriores a esse período. Se o ProductSet nunca foi indexado, esse carimbo de data/hora é o valor padrão 1970-01-01T00:00:00Z.

Este campo é ignorado ao criar um ProductSet.
index_error

Status

Apenas saída. Se ocorrer um erro na indexação do ProductSet, o campo será preenchido.

Este campo é ignorado ao criar um ProductSet.

Propriedade

Uma Property consiste em um par de nome/valor fornecido pelo usuário.

Campos
name

string

Nome da propriedade.

value

string

Valor da propriedade.

uint64_value

uint64

Valor das propriedades numéricas.

ReferenceImage

Uma ReferenceImage representa uma imagem de produto e os metadados associados, como caixas delimitadoras.

Campos
name

string

O nome do recurso da imagem de referência.

O formato é:

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID.

Esse campo é ignorado ao criar uma imagem de referência.
uri

string

O URI do Google Cloud Storage da imagem de referência.

O URI precisa começar com gs://.

Obrigatório.
bounding_polys[]

BoundingPoly

Polígonos delimitadores em torno das áreas de interesse na imagem de referência. Opcional. Se esse campo estiver vazio, o sistema vai tentar detectar regiões de interesse. No máximo, 10 polígonos delimitadores serão usados.

A forma fornecida é convertida em um retângulo não girado. Depois de convertida, a borda pequena do retângulo precisa ser maior ou igual a 300 pixels. A proporção deve ser de 1:4 ou menos. Isso significa que 1:3 é aceitável e 1:5 não é.

RemoveProductFromProductSetRequest

Mensagem de solicitação para o método RemoveProductFromProductSet.

Campos
name

string

O nome do recurso do ProductSet a ser modificado.

O formato é: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
product

string

O nome do recurso do Product a ser removido do ProductSet.

O formato é: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

SafeSearchAnnotation

Conjunto de recursos pertencentes à imagem, calculados por métodos de visão computacional em verticais da pesquisa segura. Por exemplo, conteúdo adulto, paródia, assunto médico, violência.

Campos
adult

Likelihood

Representa a probabilidade de conteúdo adulto na imagem. O conteúdo adulto pode conter elementos como nudez, imagens ou desenhos animados pornográficos ou atividades sexuais.

spoof

Likelihood

Probabilidade de paródia. A probabilidade de uma modificação ter sido feita na versão canônica da imagem para que pareça engraçada ou ofensiva.

medical

Likelihood

Probabilidade de ser uma imagem médica.

violence

Likelihood

Probabilidade de ser uma imagem com conteúdo violento.

racy

Likelihood

Probabilidade de conteúdo indecente na imagem da solicitação. Conteúdo indecente pode incluir mas não está limitado a: roupas curtas ou transparentes, nudez estrategicamente coberta, poses obscenas ou provocativas ou closes de partes inapropriadas do corpo.

Symbol

Uma única representação de símbolo.

Campos
property

TextProperty

Informações adicionais detectadas para o símbolo.

bounding_box

BoundingPoly

A caixa delimitadora do símbolo. Os vértices estão na seguinte ordem: superior esquerda, superior direita, inferior direita e inferior esquerda. Quando for detectada uma rotação da caixa delimitadora, ela será representada no canto superior esquerdo, como definido pela leitura do texto na orientação natural. Por exemplo: * quando o texto é horizontal, é semelhante ao seguinte: 0----1 | | 3----2 * quando é girado 180 graus em torno do canto superior esquerdo, torna-se: 2----3 | | 1----0, e a ordem dos vértices ainda é (0, 1, 2, 3).

text

string

A representação UTF-8 real do símbolo.

confidence

float

Confiança dos resultados do OCR para o símbolo. Intervalo [0, 1].

TextAnnotation

TextAnnotation contém uma representação estruturada do texto extraído pelo OCR. A hierarquia de uma estrutura de texto extraído pelo OCR tem esta aparência: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol. Cada componente estrutural, começando por Page, ainda pode ter propriedades próprias. As propriedades descrevem os idiomas detectados, as quebras etc. Consulte a definição da mensagem TextAnnotation.TextProperty abaixo para mais detalhes.

Campos
pages[]

Page

Lista de páginas detectadas pelo OCR.

text

string

Texto UTF-8 detectado nas páginas.

DetectedBreak

Início ou fim da detecção de um componente estrutural.

Campos
type

BreakType

Tipo de quebra detectado.

is_prefix

bool

Verdadeiro se a quebra preceder o elemento.

BreakType

Enum para denotar o tipo de quebra encontrado. Nova linha, espaço etc.

Tipos enumerados
UNKNOWN Tipo de marcador de quebra desconhecido.
SPACE Espaço regular.
SURE_SPACE Espaço garantido (muito largo).
EOL_SURE_SPACE Quebra de linha.
HYPHEN Hífen de fim de linha que não está presente no texto. Não ocorre juntamente com SPACE, LEADER_SPACE ou LINE_BREAK.
LINE_BREAK Quebra de linha que termina um parágrafo.

DetectedLanguage

Idioma detectado para um componente estrutural.

Campos
language_code

string

O código de idioma BCP-47, como pt-BR ou en-US. Para mais informações, consulte http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

confidence

float

Confiança do idioma detectado. Intervalo [0, 1].

TextProperty

Informações adicionais detectadas sobre o componente estrutural.

Campos
detected_languages[]

DetectedLanguage

Uma lista de idiomas detectados juntamente com a confiança.

detected_break

DetectedBreak

Início ou fim detectado de um segmento de texto.

UpdateProductRequest

Mensagem de solicitação para o método UpdateProduct.

Campos
product

Product

O recurso Product que substitui o recurso no servidor product.name é imutável.

update_mask

FieldMask

O FieldMask que especifica quais campos serão atualizados. Se update_mask não for especificado, todos os campos mutáveis serão atualizados. Os caminhos de máscara válidos incluem product_labels, display_name e description.

UpdateProductSetRequest

Mensagem de solicitação para o método UpdateProductSet.

Campos
product_set

ProductSet

O recurso ProductSet que substitui aquele que está no servidor.

update_mask

FieldMask

O FieldMask que especifica quais campos serão atualizados. Se update_mask não for especificado, todos os campos mutáveis serão atualizados. O caminho de máscara válido é display_name.

Vertex

Um vértice representa um ponto 2D na imagem. OBSERVAÇÃO: as coordenadas do vértice estão na mesma escala que a imagem original.

Campos
x

int32

Coordenada X.

y

int32

Coordenada Y.

Zero coordinate values


The general format for bounding polys in the JSON response when detected is an array of 4 vertex objects:
  • [{"x": 63,"y": 18},{"x": 123,"y": 18},{"x": 123,"y": 38},{"x": 63,"y": 38}]
When the API detects a coordinate ("x" or "y") value of 0, that coordinate is omitted in the JSON response. For example, a response could take the following form: [{},{"x": 28}, {"x": 28,"y": 43},{"y": 43}]. This response shows all three representation possibilities:
  • {} - an empty object when both "x":0 and "y":0.
  • {"x": 28} and {"y": 43} - an object with a single key-value pair when one coordinate is 0 but the other is a non-zero value.
  • {"x": 28,"y": 43} - an object with both key-value pairs when both coordinates have a non-zero value.

WebDetection

Informações relevantes sobre a imagem da Internet.

Campos
web_entities[]

WebEntity

Entidades deduzidas de imagens semelhantes na Internet.

full_matching_images[]

WebImage

Imagens da Internet totalmente correspondentes. Pode incluir cópias redimensionadas da imagem de consulta.

partial_matching_images[]

WebImage

Imagens da Internet parcialmente correspondentes. Elas são semelhantes o suficiente para compartilhar algumas características importantes. Por exemplo, uma imagem original provavelmente apresenta correspondência parcial em relação aos cortes.

pages_with_matching_images[]

WebPage

Páginas da Web que contêm as imagens correspondentes da Internet.

visually_similar_images[]

WebImage

Os resultados visualmente semelhantes da imagem.

best_guess_labels[]

WebLabel

O melhor palpite do serviço quanto ao tópico da imagem da solicitação. Inferido com base em imagens semelhantes na Web aberta.

WebEntity

Entidade deduzida de imagens semelhantes na Internet.

Campos
entity_id

string

ID da entidade opaca.

score

float

Pontuação geral de relevância da entidade. Não normalizada e não comparável em diferentes consultas de imagem.

description

string

Descrição canônica da entidade, em inglês.

WebImage

Metadados das imagens on-line.

Campos
url

string

O URL da imagem do resultado.

score

float

Pontuação geral de relevância da imagem (obsoleta).

WebLabel

Marcador para fornecer metadados adicionais para detecção da Web.

Campos
label

string

Rótulo para metadados adicionais.

language_code

string

O código de idioma BCP-47 para label, como en-US ou pt-BR. Para mais informações, consulte http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

WebPage

Metadados para páginas da Web.

Campos
url

string

O URL da página da Web de resultados.

score

float

Pontuação geral de relevância para a página da Web (obsoleta).

page_title

string

Título da página da Web, pode conter marcações HTML.

full_matching_images[]

WebImage

Imagens totalmente correspondentes na página. Pode incluir cópias redimensionadas da imagem de consulta.

partial_matching_images[]

WebImage

Imagens parcialmente correspondentes na página. Elas são semelhantes o suficiente para compartilhar algumas características importantes. Por exemplo, uma imagem original provavelmente apresenta correspondência parcial em relação aos cortes.

WebDetectionParams

Parâmetros para solicitação de detecção da Web.

Campos
include_geo_results

bool

Determina se é para incluir resultados derivados das informações geográficas na imagem.

Word

Uma representação de palavra.

Campos
property

TextProperty

Informações adicionais detectadas para a palavra.

bounding_box

BoundingPoly

A caixa delimitadora da palavra. Os vértices estão na seguinte ordem: superior esquerda, superior direita, inferior direita e inferior esquerda. Quando for detectada uma rotação da caixa delimitadora, ela será representada no canto superior esquerdo, como definido pela leitura do texto na orientação natural. Por exemplo: * quando o texto é horizontal, é semelhante ao seguinte: 0----1 | | 3----2 * quando é girado em 180 graus em torno do canto superior esquerdo, torna-se: 2----3 | | 1----0, e a ordem dos vértices ainda é (0, 1, 2, 3).

symbols[]

Symbol

Lista de símbolos na palavra. A ordem dos símbolos segue a ordem de leitura natural.

confidence

float

Confiança dos resultados do OCR para a palavra. Intervalo [0, 1].