Package google.cloud.vision.v1p3beta1

Índice

ImageAnnotator

Serviço que executa tarefas de deteção da Google Cloud Vision API em imagens do cliente, como deteção de caras, pontos de referência, logótipos, etiquetas e texto. O serviço ImageAnnotator devolve entidades detetadas das imagens.

AsyncBatchAnnotateFiles

rpc AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest) returns (Operation)

Execute a deteção e a anotação de imagens assíncronas para uma lista de ficheiros genéricos, como ficheiros PDF, que podem conter várias páginas e várias imagens por página. Pode aceder ao progresso e aos resultados através da interface google.longrunning.Operations. Operation.metadata contém OperationMetadata (metadados). Operation.response contém AsyncBatchAnnotateFilesResponse (resultados).

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte a Vista geral da autenticação.
BatchAnnotateImages

rpc BatchAnnotateImages(BatchAnnotateImagesRequest) returns (BatchAnnotateImagesResponse)

Executar a deteção e a anotação de imagens para um lote de imagens.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte a Vista geral da autenticação.

ProductSearch

Faz a gestão de produtos e conjuntos de produtos de imagens de referência para utilização na pesquisa de produtos. Usa o seguinte modelo de recurso:

  • A API tem uma coleção de ProductSet recursos, denominada projects/*/locations/*/productSets/*, que funciona como uma forma de agrupar diferentes produtos para limitar a identificação.

Em paralelo,

  • 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 produto ao ProductSet especificado. Se o produto já estiver presente, não é feita nenhuma alteração.

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

Possíveis erros:

  • Devolve NOT_FOUND se o produto ou o ProductSet não existir.
Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte a Vista geral da autenticação.
CreateProduct

rpc CreateProduct(CreateProductRequest) returns (Product)

Cria e devolve um novo recurso de produto.

Possíveis erros:

  • Devolve INVALID_ARGUMENT se display_name estiver em falta ou tiver mais de 4096 carateres.
  • Devolve INVALID_ARGUMENT se a descrição tiver mais de 4096 carateres.
  • Devolve INVALID_ARGUMENT se product_category estiver em falta ou for inválido.
Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte a Vista geral da autenticação.
CreateProductSet

rpc CreateProductSet(CreateProductSetRequest) returns (ProductSet)

Cria e devolve um novo recurso ProductSet.

Possíveis erros:

  • Devolve INVALID_ARGUMENT se display_name estiver em falta ou tiver mais de 4096 carateres.
Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte a Vista geral da autenticação.
CreateReferenceImage

rpc CreateReferenceImage(CreateReferenceImageRequest) returns (ReferenceImage)

Cria e devolve um novo recurso ReferenceImage.

O campo bounding_poly é opcional. Se bounding_poly não for especificado, o sistema tenta detetar regiões de interesse na imagem que sejam compatíveis com a product_category no produto principal. Se for especificado, a deteção é SEMPRE ignorada. O sistema converte polígonos em retângulos não rodados.

Tenha em atenção que o pipeline redimensiona a imagem se a resolução da imagem for demasiado grande para processamento (acima de 50 MP).

Possíveis erros:

  • Devolve INVALID_ARGUMENT se o image_uri estiver em falta ou tiver mais de 4096 carateres.
  • Devolve INVALID_ARGUMENT se o produto não existir.
  • Devolve INVALID_ARGUMENT se bounding_poly não for fornecido e não for detetado nada compatível com a product_category do produto principal.
  • Devolve INVALID_ARGUMENT se bounding_poly contiver mais de 10 polígonos.
Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte a Vista geral da autenticação.
DeleteProduct

rpc DeleteProduct(DeleteProductRequest) returns (Empty)

Elimina permanentemente um produto e as respetivas imagens de referência.

Os metadados do produto e todas as respetivas imagens são eliminados imediatamente, mas as consultas de pesquisa em ProductSets que contenham o produto podem continuar a funcionar até que todas as caches relacionadas sejam atualizadas.

Possíveis erros:

  • Devolve NOT_FOUND se o produto não existir.
Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte a Vista geral da autenticação.
DeleteProductSet

rpc DeleteProductSet(DeleteProductSetRequest) returns (Empty)

Elimina permanentemente um ProductSet. Os produtos e as ReferenceImages no ProductSet não são eliminados.

Os ficheiros de imagem reais não são eliminados do Google Cloud Storage.

Possíveis erros:

  • Devolve NOT_FOUND se o ProductSet não existir.
Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte a Vista geral da autenticação.
DeleteReferenceImage

rpc DeleteReferenceImage(DeleteReferenceImageRequest) returns (Empty)

Elimina permanentemente uma imagem de referência.

Os metadados da imagem são eliminados imediatamente, mas as consultas de pesquisa em ProductSets que contenham a imagem podem continuar a funcionar até que todas as caches relacionadas sejam atualizadas.

Os ficheiros de imagem reais não são eliminados do Google Cloud Storage.

Possíveis erros:

  • Devolve NOT_FOUND se a imagem de referência não existir.
Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte a Vista geral da autenticação.
GetProduct

rpc GetProduct(GetProductRequest) returns (Product)

Obtém informações associadas a um produto.

Possíveis erros:

  • Devolve NOT_FOUND se o produto não existir.
Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte a Vista geral da autenticação.
GetProductSet

rpc GetProductSet(GetProductSetRequest) returns (ProductSet)

Obtém informações associadas a um ProductSet.

Possíveis erros:

  • Devolve NOT_FOUND se o ProductSet não existir.
Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte a Vista geral da autenticação.
GetReferenceImage

rpc GetReferenceImage(GetReferenceImageRequest) returns (ReferenceImage)

Obtém informações associadas a uma ReferenceImage.

Possíveis erros:

  • Devolve NOT_FOUND se a imagem especificada não existir.
Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte a Vista 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 numa lista de informações de imagens.

A API google.longrunning.Operation pode ser usada para acompanhar o progresso e os resultados do pedido. Operation.metadata contém BatchOperationMetadata. (progress) Operation.response contém ImportProductSetsResponse. (resultados)

A origem de entrada deste método é um ficheiro CSV no Google Cloud Storage. Para ver o formato do ficheiro CSV, consulte ImportProductSetsGcsSource.csv_file_uri.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte a Vista geral da autenticação.
ListProductSets

rpc ListProductSets(ListProductSetsRequest) returns (ListProductSetsResponse)

Lista ProductSets numa ordem não especificada.

Possíveis erros:

  • Devolve INVALID_ARGUMENT se page_size for superior a 100 ou inferior a 1.
Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte a Vista geral da autenticação.
ListProducts

rpc ListProducts(ListProductsRequest) returns (ListProductsResponse)

Apresenta os produtos numa ordem não especificada.

Possíveis erros:

  • Devolve INVALID_ARGUMENT se page_size for superior a 100 ou inferior a 1.
Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte a Vista geral da autenticação.
ListProductsInProductSet

rpc ListProductsInProductSet(ListProductsInProductSetRequest) returns (ListProductsInProductSetResponse)

Apresenta os produtos num ProductSet, numa ordem não especificada. Se o ProductSet não existir, o campo products da resposta fica vazio.

Possíveis erros:

  • Devolve INVALID_ARGUMENT se page_size for superior a 100 ou inferior a 1.
Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte a Vista geral da autenticação.
ListReferenceImages

rpc ListReferenceImages(ListReferenceImagesRequest) returns (ListReferenceImagesResponse)

Apresenta imagens de referência.

Possíveis erros:

  • Devolve NOT_FOUND se o produto principal não existir.
  • Devolve INVALID_ARGUMENT se page_size for superior a 100 ou inferior a 1.
Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte a Vista geral da autenticação.
RemoveProductFromProductSet

rpc RemoveProductFromProductSet(RemoveProductFromProductSetRequest) returns (Empty)

Remove um produto do ProductSet especificado.

Possíveis erros:

  • Devolve NOT_FOUND se o produto não for encontrado no ProductSet.
Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte a Vista geral da autenticação.
UpdateProduct

rpc UpdateProduct(UpdateProductRequest) returns (Product)

Faz alterações a um recurso Product. Atualmente, só é possível atualizar os campos display_name, description e labels.

Se as etiquetas forem atualizadas, a alteração não é refletida nas consultas até à próxima hora de indexação.

Possíveis erros:

  • Devolve NOT_FOUND se o produto não existir.
  • Devolve INVALID_ARGUMENT se display_name estiver presente em update_mask, mas estiver em falta no pedido ou tiver mais de 4096 carateres.
  • Devolve INVALID_ARGUMENT se a descrição estiver presente em update_mask, mas tiver mais de 4096 carateres.
  • Devolve INVALID_ARGUMENT se product_category estiver presente em update_mask.
Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte a Vista geral da autenticação.
UpdateProductSet

rpc UpdateProductSet(UpdateProductSetRequest) returns (ProductSet)

Faz alterações a um recurso ProductSet. Atualmente, só é possível atualizar o display_name.

Possíveis erros:

  • Devolve NOT_FOUND se o ProductSet não existir.
  • Devolve INVALID_ARGUMENT se display_name estiver presente em update_mask, mas estiver em falta no pedido ou tiver mais de 4096 carateres.
Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte a Vista geral da autenticação.

AddProductToProductSetRequest

Mensagem de pedido para o método AddProductToProductSet.

Campos
name

string

O nome do recurso do ProductSet a modificar.

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

string

O nome do recurso do produto a adicionar a este ProductSet.

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

AnnotateFileResponse

Resposta a um pedido de anotação de um único ficheiro. Um ficheiro pode conter uma ou mais imagens, que têm individualmente as suas próprias respostas.

Campos
input_config

InputConfig

Informações sobre o ficheiro para o qual esta resposta é gerada.

responses[]

AnnotateImageResponse

Respostas individuais a imagens encontradas no ficheiro.

AnnotateImageRequest

Pedido para realizar tarefas da Google Cloud Vision API numa imagem fornecida pelo utilizador, com funcionalidades pedidas pelo utilizador.

Campos
image

Image

A imagem a ser processada.

features[]

Feature

Funcionalidades pedidas.

image_context

ImageContext

Contexto adicional que pode acompanhar a imagem.

AnnotateImageResponse

Resposta a um pedido de anotação de imagem.

Campos
face_annotations[]

FaceAnnotation

Se estiver presente, a deteção de caras foi concluída com êxito.

landmark_annotations[]

EntityAnnotation

Se estiver presente, a deteção de pontos de referência foi concluída com êxito.

logo_annotations[]

EntityAnnotation

Se estiver presente, a deteção do logótipo foi concluída com êxito.

label_annotations[]

EntityAnnotation

Se estiver presente, a deteção de etiquetas foi concluída com êxito.

localized_object_annotations[]

LocalizedObjectAnnotation

Se estiver presente, a deteção de objetos localizada foi concluída com êxito. Estes são ordenados por ordem descendente de acordo com a pontuação de confiança.

text_annotations[]

EntityAnnotation

Se estiver presente, a deteção de texto (OCR) foi concluída com êxito.

full_text_annotation

TextAnnotation

Se estiver presente, a deteção de texto (OCR) ou a deteção de texto de documentos (OCR) foi concluída com êxito. Esta anotação fornece a hierarquia estrutural do texto detetado pelo OCR.

safe_search_annotation

SafeSearchAnnotation

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

image_properties_annotation

ImageProperties

Se estiver presente, as propriedades da imagem foram extraídas com êxito.

crop_hints_annotation

CropHintsAnnotation

Se estiver presente, as sugestões de recorte foram concluídas com êxito.

web_detection

WebDetection

Se estiver presente, a deteção na Web foi concluída com êxito.

product_search_results

ProductSearchResults

Se estiver presente, a pesquisa de produtos foi concluída com êxito.

error

Status

Se definido, representa a mensagem de erro da operação. Tenha em atenção que as anotações de imagens preenchidas têm a garantia de estar corretas, mesmo quando error está definido.

context

ImageAnnotationContext

Se estiverem presentes, são necessárias informações contextuais para compreender a origem desta imagem.

AsyncAnnotateFileRequest

Um pedido de anotação de ficheiro offline.

Campos
input_config

InputConfig

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

features[]

Feature

Obrigatório. Funcionalidades pedidas.

image_context

ImageContext

Contexto adicional que pode acompanhar as imagens no ficheiro.

output_config

OutputConfig

Obrigatório. A localização de saída e os metadados pretendidos (por exemplo, o formato).

AsyncAnnotateFileResponse

A resposta para um único pedido de anotação de ficheiro offline.

Campos
output_config

OutputConfig

A localização de saída e os metadados de AsyncAnnotateFileRequest.

AsyncBatchAnnotateFilesRequest

Vários pedidos de anotação de ficheiros assíncronos são processados em lote numa única chamada de serviço.

Campos
requests[]

AsyncAnnotateFileRequest

Pedidos de anotação de ficheiros assíncronos individuais para este lote.

AsyncBatchAnnotateFilesResponse

Resposta a um pedido de anotação de ficheiro em lote assíncrono.

Campos
responses[]

AsyncAnnotateFileResponse

A lista de respostas de anotação de ficheiros, uma para cada pedido em AsyncBatchAnnotateFilesRequest.

BatchAnnotateImagesRequest

Vários pedidos de anotação de imagens são processados em lote numa única chamada de serviço.

Campos
requests[]

AnnotateImageRequest

Pedidos de anotação de imagens individuais para este lote.

BatchAnnotateImagesResponse

Resposta a um pedido de anotação de imagens em lote.

Campos
responses[]

AnnotateImageResponse

Respostas individuais a pedidos de anotação de imagens no lote.

BatchOperationMetadata

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

Isto está incluído no campo metadata do Operation devolvido 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 o pedido em lote foi enviado para o servidor.

end_time

Timestamp

A hora em que o pedido em lote é concluído e google.longrunning.Operation.done está definido como verdadeiro.

Estado

Enumera os possíveis estados em que o pedido em lote pode estar.

Enumerações
STATE_UNSPECIFIED Inválido.
PROCESSING O pedido está a ser processado ativamente.
SUCCESSFUL O pedido está concluído e, pelo menos, um item foi processado com êxito.
FAILED O pedido foi concluído e nenhum item foi processado com êxito.
CANCELLED O pedido é feito depois de o utilizador ter chamado o longrunning.Operations.CancelOperation. Todos os registos processados antes do comando de cancelamento são apresentados conforme especificado no pedido.

Bloquear

Elemento lógico na página.

Campos
property

TextProperty

Foram detetadas informações adicionais para o bloqueio.

bounding_box

BoundingPoly

A caixa limitadora do bloco. Os vértices estão na ordem superior esquerdo, superior direito, inferior direito e inferior esquerdo. Quando é detetada uma rotação da caixa delimitadora, a rotação é representada em torno do canto superior esquerdo, conforme definido quando o texto é lido na orientação "natural". Por exemplo:

  • Quando o texto é horizontal, pode ter o seguinte aspeto:
    0----1
    |    |
    3----2
  • Quando é rodado 180 graus em torno do canto superior esquerdo, torna-se:
    2----3
    |    |
    1----0

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

Paragraph

Lista de parágrafos neste bloco (se este bloco for do tipo texto).

block_type

BlockType

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

confidence

float

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

BlockType

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

Enumerações
UNKNOWN Tipo de bloco desconhecido.
TEXT Bloco de texto normal.
TABLE Bloco de tabela.
PICTURE Bloqueio de imagem.
RULER Caixa de linhas horizontais/verticais.
BARCODE Bloco de código de barras.

BoundingPoly

Um polígono de limite para a anotação de imagem detetada.

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 cor consistem em canais RGB, pontuação e a fração da imagem que a cor ocupa na imagem.

Campos
color

Color

Componentes RGB da cor.

score

float

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

pixel_fraction

float

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

CreateProductRequest

Mensagem de pedido para o método CreateProduct.

Campos
parent

string

O projeto no qual o produto deve ser criado.

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

Product

O produto a criar.

product_id

string

Um ID de recurso fornecido pelo utilizador para este produto. Se estiver definido, o servidor tenta usar este valor como o ID do recurso. Se já estiver em utilização, é devolvido um erro com o código ALREADY_EXISTS. Tem de ter, no máximo, 128 carateres. Não pode conter o caráter /.

CreateProductSetRequest

Mensagem de pedido para o método CreateProductSet.

Campos
parent

string

O projeto no qual o ProductSet deve ser criado.

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

ProductSet

O ProductSet a criar.

product_set_id

string

Um ID de recurso fornecido pelo utilizador para este ProductSet. Se estiver definido, o servidor tenta usar este valor como o ID do recurso. Se já estiver em utilização, é devolvido um erro com o código ALREADY_EXISTS. Tem de ter, no máximo, 128 carateres. Não pode conter o caráter /.

CreateReferenceImageRequest

Mensagem de pedido para o método CreateReferenceImage.

Campos
parent

string

Nome do recurso do produto no qual criar a imagem de referência.

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

ReferenceImage

A imagem de referência para criar. Se for especificado um ID da imagem, este é ignorado.

reference_image_id

string

Um ID do recurso fornecido pelo utilizador para a ReferenceImage a adicionar. Se estiver definido, o servidor tenta usar este valor como o ID do recurso. Se já estiver em utilização, é devolvido um erro com o código ALREADY_EXISTS. Tem de ter, no máximo, 128 carateres. Não pode conter o caráter /.

CropHint

Sugestão de recorte único usada para gerar um novo recorte quando uma imagem é publicada.

Campos
bounding_poly

BoundingPoly

O polígono delimitador da região de recorte. As coordenadas da caixa delimitadora estão na escala da imagem original, conforme devolvidas em ImageParams.

confidence

float

Confiança de que esta é uma região saliente. Intervalo [0, 1].

importance_fraction

float

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

CropHintsAnnotation

Conjunto de sugestões de recorte que são usadas para gerar novos recortes quando as imagens são publicadas.

Campos
crop_hints[]

CropHint

Resultados de sugestões de corte.

CropHintsParams

Parâmetros para o pedido de anotação de sugestões de recorte.

Campos
aspect_ratios[]

float

Formatos em números de vírgula flutuante, que representam a relação entre a largura e a altura da imagem. Por exemplo, se a proporção desejada for 4/3, o valor de vírgula flutuante correspondente deve ser 1,33333. Se não for especificado, é devolvido o melhor recorte possível. O número de formatos fornecidos está limitado a um máximo de 16. Todos os formatos fornecidos após o 16.º são ignorados.

DeleteProductRequest

Mensagem de pedido para o método DeleteProduct.

Campos
name

string

Nome do recurso do produto a eliminar.

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

DeleteProductSetRequest

Mensagem de pedido para o método DeleteProductSet.

Campos
name

string

Nome do recurso do ProductSet a eliminar.

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

DeleteReferenceImageRequest

Mensagem de pedido para o método DeleteReferenceImage.

Campos
name

string

O nome do recurso da imagem de referência a eliminar.

O formato é:

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

DominantColorsAnnotation

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

Campos
colors[]

ColorInfo

Valores de cores RGB com a respetiva pontuação e fração de píxeis.

EntityAnnotation

Conjunto de funcionalidades de entidades detetadas.

Campos
mid

string

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

locale

string

O código de idioma da região em que o texto da entidade description é expresso.

description

string

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

score

float

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

confidence
(deprecated)

float

Descontinuado. Em alternativa, use score. A precisão da deteção de entidades numa imagem. Por exemplo, para uma imagem na qual a entidade "Torre Eiffel" é detetada, este campo representa a confiança de que existe uma torre na imagem da consulta. Intervalo [0, 1].
topicality

float

A relevância da etiqueta ICA (anotação de conteúdo de imagem) para a imagem. Por exemplo, a relevância de "torre" é provavelmente superior para uma imagem que contenha a "Torre Eiffel" detetada do que para uma imagem que contenha um edifício alto distante detetado, mesmo que a confiança de que existe uma torre em cada imagem possa ser a mesma. Intervalo [0, 1].

bounding_poly

BoundingPoly

Região da imagem à qual esta entidade pertence. Não produzido para funcionalidades LABEL_DETECTION.

locations[]

LocationInfo

As informações de localização da entidade detetada. Podem estar presentes vários elementos LocationInfo porque uma localização pode indicar a localização da cena na imagem e outra localização pode indicar a localização do local onde a imagem foi tirada. Normalmente, as informações de localização estão presentes para pontos de referência.

properties[]

Property

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

FaceAnnotation

Um objeto de anotação de cara contém os resultados da deteção de caras.

Campos
bounding_poly

BoundingPoly

O polígono delimitador em torno do rosto. As coordenadas da caixa delimitadora estão na escala da imagem original, conforme devolvidas em ImageParams. A caixa delimitadora é calculada para "enquadrar" o rosto de acordo com as expetativas humanas. Baseia-se nos resultados dos pontos de referência. Tenha em atenção que uma ou mais coordenadas x e/ou y podem não ser geradas no BoundingPoly (o polígono não vai ter limites) se apenas aparecer uma parte de uma cara na imagem a ser anotada.

fd_bounding_poly

BoundingPoly

O polígono delimitador fd_bounding_poly é mais apertado do que o boundingPoly e envolve apenas a parte da pele do rosto. Normalmente, é usado para eliminar a cara de qualquer análise de imagem que detete a "quantidade de pele" visível numa imagem. Não se baseia nos resultados dos pontos de referência, apenas na deteção facial inicial, pelo que

fd

(deteção facial) prefixo.
landmarks[]

Landmark

Pontos de referência faciais detetados.

roll_angle

float

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

pan_angle

float

Ângulo de guinada, que indica o ângulo para a esquerda/direita para o qual o rosto está virado relativamente ao plano vertical perpendicular à imagem. Intervalo [-180,180].

tilt_angle

float

Ângulo de inclinação, que indica o ângulo para cima/para baixo para o qual o rosto está a apontar relativamente ao plano horizontal da imagem. Intervalo [-180,180].

detection_confidence

float

Confiança na deteção. Intervalo [0, 1].

landmarking_confidence

float

Confiança na identificação de pontos de referência faciais. 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 esbatida.

headwear_likelihood

Likelihood

Probabilidade de usar adereços para a cabeça.

Ponto de referência

Um ponto de referência específico do rosto (por exemplo, uma caraterística facial).

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 (caraterística) facial. A esquerda e a direita são definidas a partir do ponto de vista do visualizador da imagem, sem considerar as projeções de espelho típicas das fotos. Assim, LEFT_EYE é normalmente o olho direito da pessoa.

Enumerações
UNKNOWN_LANDMARK Ponto de referência de rosto desconhecido detetado. Não deve ser preenchido.
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 intermédio entre os olhos.
NOSE_TIP Ponta do nariz.
UPPER_LIP Lábio superior.
LOWER_LIP Lábio inferior.
MOUTH_LEFT Boca para a esquerda.
MOUTH_RIGHT Boca para a direita.
MOUTH_CENTER Centro da boca.
NOSE_BOTTOM_RIGHT Nariz, parte inferior direita.
NOSE_BOTTOM_LEFT Nariz, parte inferior esquerda.
NOSE_BOTTOM_CENTER Nariz, parte inferior central.
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 médio superior.
RIGHT_EYEBROW_UPPER_MIDPOINT Sobrancelha direita, ponto médio superior.
LEFT_EAR_TRAGION Trágus do ouvido esquerdo.
RIGHT_EAR_TRAGION Trágus do ouvido direito.
LEFT_EYE_PUPIL Pupila do olho esquerdo.
RIGHT_EYE_PUPIL Pupila do olho direito.
FOREHEAD_GLABELLA Glabela da testa.
CHIN_GNATHION Gnathion do queixo.
CHIN_LEFT_GONION Queixo no gónio esquerdo.
CHIN_RIGHT_GONION Gónio do queixo direito.

Funcionalidade

O tipo de deteção da API Google Cloud Vision a realizar e o número máximo de resultados a devolver para esse tipo. Podem ser especificados vários objetos Feature na lista features.

Campos
type

Type

O tipo de funcionalidade.

max_results

int32

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

model

string

Modelo a usar para a funcionalidade. Valores suportados: "builtin/stable" (a predefinição se não estiver definida) e "builtin/latest".

Tipo

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

Enumerações
TYPE_UNSPECIFIED Tipo de funcionalidade não especificado.
FACE_DETECTION Executar a deteção facial.
LANDMARK_DETECTION Executar a deteção de pontos de referência.
LOGO_DETECTION Executar a deteção de logótipos.
LABEL_DETECTION Executar a deteção de etiquetas.
TEXT_DETECTION Executar deteção de texto / reconhecimento ótico de carateres (OCR). A deteção de texto está otimizada para áreas de texto numa imagem maior. Se a imagem for um documento, use DOCUMENT_TEXT_DETECTION.
DOCUMENT_TEXT_DETECTION Executar OCR de documentos de texto denso. Tem precedência quando DOCUMENT_TEXT_DETECTION e TEXT_DETECTION estão presentes.
SAFE_SEARCH_DETECTION Executar a Pesquisa segura para detetar conteúdo potencialmente inseguro ou indesejável.
IMAGE_PROPERTIES Calcular um conjunto de propriedades da imagem, como as cores dominantes da imagem.
CROP_HINTS Execute sugestões de corte.
WEB_DETECTION Executar deteção na Web.
OBJECT_LOCALIZATION Execute o localizador para a deteção de objetos.

GcsDestination

A localização do Google Cloud Storage onde a saída vai ser escrita.

Campos
uri

string

URI do Google Cloud Storage onde os resultados vão ser armazenados. Os resultados estão no formato JSON e são precedidos pelo URI de entrada correspondente. Este campo pode representar um único ficheiro ou um prefixo para várias saídas. Os prefixos têm de terminar com /.

Exemplos:

Se existirem vários resultados, cada resposta continua a ser AnnotateFileResponse, cada uma das quais contém um subconjunto da lista completa de AnnotateImageResponse. Podem ocorrer várias saídas se, por exemplo, o JSON de saída for demasiado grande e transbordar para vários ficheiros divididos.

GcsSource

A localização do Google Cloud Storage a partir da qual a entrada vai ser lida.

Campos
uri

string

URI do Google Cloud Storage para o ficheiro de entrada. Tem de ser um objeto do Google Cloud Storage. De momento, os carateres universais não são suportados.

GetProductRequest

Mensagem de pedido para o método GetProduct.

Campos
name

string

Nome do recurso do produto a obter.

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

GetProductSetRequest

Mensagem de pedido para o método GetProductSet.

Campos
name

string

Nome do recurso do ProductSet a obter.

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

GetReferenceImageRequest

Mensagem de pedido para o método GetReferenceImage.

Campos
name

string

O nome do recurso da ReferenceImage a obter.

O formato é:

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

Imagem

Imagem do cliente para realizar tarefas da Google Cloud Vision API.

Campos
content

bytes

Conteúdo de imagem, representado como um fluxo de bytes. Nota: tal como acontece com todos os campos bytes, os protobuffers usam uma representação binária pura, enquanto as representações JSON usam base64.

source

ImageSource

Localização da imagem no Google Cloud Storage ou URL da imagem acessível publicamente. Se forem fornecidos os parâmetros content e source para uma imagem, o parâmetro content tem prioridade e é usado para executar o pedido de anotação de imagens.

ImageAnnotationContext

Se uma imagem foi produzida a partir de um ficheiro (por exemplo, um PDF), esta mensagem fornece informações sobre a origem dessa imagem.

Campos
uri

string

O URI do ficheiro usado para produzir a imagem.

page_number

int32

Se o ficheiro era um PDF ou um TIFF, este campo indica o número da página no ficheiro usado para produzir a imagem.

ImageContext

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

Campos
lat_long_rect

LatLongRect

Não usado.

language_hints[]

string

Lista de idiomas a usar para TEXT_DETECTION. Na maioria dos casos, um valor vazio produz os melhores resultados, uma vez que permite a deteção automática do idioma. Para idiomas baseados no alfabeto latino, não é necessário definir language_hints. Em casos raros, quando o idioma do texto na imagem é conhecido, a definição de uma sugestão ajuda a obter melhores resultados (embora seja um obstáculo significativo se a sugestão estiver incorreta). A deteção de texto devolve um erro se um ou mais dos idiomas especificados não estiverem entre os idiomas suportados.

crop_hints_params

CropHintsParams

Parâmetros para o pedido de anotação de sugestões de recorte.

product_search_params

ProductSearchParams

Parâmetros para a pesquisa de produtos.

web_detection_params

WebDetectionParams

Parâmetros para a deteção na Web.

ImageProperties

Armazena propriedades de imagens, como cores dominantes.

Campos
dominant_colors

DominantColorsAnnotation

Se estiver presente, as cores dominantes foram concluídas com êxito.

ImageSource

Origem da imagem externa (Google Cloud Storage ou localização da imagem do URL da Web).

Campos
gcs_image_uri

string

Em alternativa, use image_uri.

O URI do Google Cloud Storage tem o formato gs://bucket_name/object_name. O controlo de versões de objetos não é suportado. Consulte o artigo URIs de solicitação do Google Cloud Storage para ver 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 controlo de versões de objetos não é suportado. Consulte os URIs de pedido do Google Cloud Storage para mais informações.

  2. Um URL HTTP/HTTPS de imagem acessível publicamente. Quando obtém imagens de URLs HTTP/HTTPS, a Google não pode garantir que o pedido será concluído. O seu pedido pode falhar se o anfitrião especificado recusar o pedido (por exemplo, devido à limitação de pedidos ou à prevenção de DOS) ou se o Google limitar os pedidos ao site para evitar abusos. Não deve depender de imagens alojadas externamente para aplicações de produção.

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

ImportProductSetsGcsSource

A localização do Google Cloud Storage para um ficheiro CSV que preserva uma lista de ImportProductSetRequests em cada linha.

Campos
csv_file_uri

string

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

O URI tem de começar por gs://.

O formato do ficheiro CSV de entrada deve ser uma imagem por linha. Em cada linha, existem 8 colunas.

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

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

Se o ProductSet ou o Product especificado pelos valores product-set-id e product-id não existir, o sistema cria um novo ProductSet ou Product para a imagem. Neste 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 tem de ser exclusiva se for fornecida. Se estiver vazio, o sistema atribui automaticamente um ID exclusivo à imagem.

A coluna product-display-name é opcional. Se estiver vazio, o sistema define o campo display_name do produto como um espaço (" "). Pode atualizar o campo display_name mais tarde através da API.

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

A coluna labels (opcional) é uma linha que contém uma lista de pares de chave/valor separados por vírgulas, 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 não especificar a coluna bounding-poly, o sistema tenta detetar automaticamente as regiões de interesse.

É permitida, no máximo, uma coluna bounding-poly por linha. Se a imagem contiver várias regiões de interesse, adicione uma linha ao ficheiro CSV que inclua as mesmas informações do produto e os valores bounding-poly para cada região de interesse.

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

O sistema redimensiona a imagem se a resolução da imagem for demasiado grande para processar (superior a 20 MP).

ImportProductSetsInputConfig

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

Campos
gcs_source

ImportProductSetsGcsSource

A localização do Google Cloud Storage para um ficheiro CSV que preserva uma lista de ImportProductSetRequests em cada linha.

ImportProductSetsRequest

Mensagem de pedido para o método ImportProductSets.

Campos
parent

string

O projeto no qual os ProductSets devem ser importados.

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

ImportProductSetsInputConfig

O conteúdo de entrada para a lista de pedidos.

ImportProductSetsResponse

Mensagem de resposta para o método ImportProductSets.

Esta mensagem é devolvida pelo método google.longrunning.Operations.GetOperation no campo google.longrunning.Operation.response devolvido.

Campos
reference_images[]

ReferenceImage

A lista de reference_images que foram importadas com êxito.

statuses[]

Status

O estado do RPC para cada pedido ImportProductSet, incluindo êxitos e erros.

O número de estados aqui corresponde ao número de linhas no ficheiro CSV e statuses[i] armazena o estado de êxito ou falha do processamento da i-ésima linha do CSV, a começar na linha 0.

InputConfig

A localização de entrada e os metadados pretendidos.

Campos
gcs_source

GcsSource

A localização do Google Cloud Storage a partir da qual a entrada é lida.

mime_type

string

O tipo de ficheiro. Atualmente, apenas são suportados os tipos "application/pdf" e "image/tiff". Os carateres universais não são compatíveis.

LatLongRect

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

Campos
min_lat_lng

LatLng

Par de latitude/longitude mínimo.

max_lat_lng

LatLng

Número máximo de pares de latitude/longitude.

Probabilidade

Uma representação agrupada da probabilidade, que se destina a dar aos clientes resultados altamente estáveis nas atualizações do modelo.

Enumerações
UNKNOWN Probabilidade desconhecida.
VERY_UNLIKELY É muito improvável que a imagem pertença ao setor vertical especificado.
UNLIKELY É pouco provável que a imagem pertença ao vertical especificado.
POSSIBLE É possível que a imagem pertença ao vertical especificado.
LIKELY É provável que a imagem pertença ao vertical especificado.
VERY_LIKELY É muito provável que a imagem pertença ao setor vertical especificado.

ListProductSetsRequest

Mensagem de pedido para o método ListProductSets.

Campos
parent

string

O projeto a partir do qual devem ser listados os ProductSets.

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

int32

O número máximo de itens a devolver. Predefinição de 10, máximo de 100.

page_token

string

O next_page_token devolvido de um pedido List anterior, se existir.

ListProductSetsResponse

Mensagem de resposta para o método ListProductSets.

Campos
product_sets[]

ProductSet

Lista de ProductSets.

next_page_token

string

Token para obter a página seguinte de resultados ou vazio se não existirem mais resultados na lista.

ListProductsInProductSetRequest

Mensagem de pedido para o método ListProductsInProductSet.

Campos
name

string

O recurso ProductSet para o qual obter produtos.

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

int32

O número máximo de itens a devolver. Predefinição de 10, máximo de 100.

page_token

string

O next_page_token devolvido de um pedido List anterior, se existir.

ListProductsInProductSetResponse

Mensagem de resposta para o método ListProductsInProductSet.

Campos
products[]

Product

A lista de produtos.

next_page_token

string

Token para obter a página seguinte de resultados ou vazio se não existirem mais resultados na lista.

ListProductsRequest

Mensagem de pedido para o método ListProducts.

Campos
parent

string

O projeto OU o ProductSet a partir do qual os produtos devem ser listados.

Formato: projects/PROJECT_ID/locations/LOC_ID
page_size

int32

O número máximo de itens a devolver. Predefinição de 10, máximo de 100.

page_token

string

O next_page_token devolvido de um pedido List anterior, se existir.

ListProductsResponse

Mensagem de resposta para o método ListProducts.

Campos
products[]

Product

Lista de produtos.

next_page_token

string

Token para obter a página seguinte de resultados ou vazio se não existirem mais resultados na lista.

ListReferenceImagesRequest

Mensagem de pedido 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 devolver. Predefinição de 10, máximo de 100.

page_token

string

Um token que identifica uma página de resultados a devolver. Este é o valor de nextPageToken devolvido numa solicitação de lista de imagens de referência anterior.

A predefinição é a primeira página se não for especificado.

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 devolver. Predefinição de 10, máximo de 100.

next_page_token

string

O next_page_token devolvido de um pedido List anterior, se existir.

LocalizedObjectAnnotation

Conjunto de objetos detetados com caixas de limite.

Campos
mid

string

ID do objeto que deve estar alinhado com o MID de EntityAnnotation.

language_code

string

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

name

string

Nome do objeto, expresso no respetivo idioma language_code.

score

float

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

bounding_poly

BoundingPoly

Região da imagem à qual este objeto pertence. Este campo tem de ser preenchido.

LocationInfo

Informações de localização da entidade detetada.

Campos
lat_lng

LatLng

Coordenadas de localização de latitude/longitude.

NormalizedVertex

Um vértice representa um ponto 2D na imagem. NOTA: as coordenadas dos vértices normalizadas são relativas à imagem original e variam entre 0 e 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 metadados para a operação BatchAnnotateImages.

Campos
state

State

Estado atual da operação em lote.

create_time

Timestamp

A hora em que o pedido em lote foi recebido.

update_time

Timestamp

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

Estado

Estados da operação em lote.

Enumerações
STATE_UNSPECIFIED Inválido.
CREATED O pedido é recebido.
RUNNING O pedido está a ser processado ativamente.
DONE O processamento em lote está concluído.
CANCELLED O processamento em lote foi cancelado.

OutputConfig

A localização e os metadados de saída pretendidos.

Campos
gcs_destination

GcsDestination

A localização do Google Cloud Storage para escrever as saídas.

batch_size

int32

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

Por exemplo, para um ficheiro PDF com 100 páginas, são gerados 100 protos de resposta. Se batch_size = 20, são escritos 5 ficheiros JSON, cada um com 20 protos de resposta, com o prefixo gcs_destination.uri.

Atualmente, o batch_size aplica-se apenas a GcsDestination, com potencial suporte futuro para outras configurações de saída.

Página

Página detetada a partir do OCR.

Campos
property

TextProperty

Foram detetadas informações adicionais na página.

width

int32

Largura da página. Para PDFs, a unidade é pontos. Para imagens (incluindo TIFFs), a unidade é píxeis.

height

int32

Altura da página. Para PDFs, a unidade é pontos. Para imagens (incluindo TIFFs), a unidade é píxeis.

blocks[]

Block

Lista de blocos de texto, imagens, etc. nesta página.

confidence

float

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

Parágrafo

Unidade estrutural de texto que representa um número de palavras numa determinada ordem.

Campos
property

TextProperty

Foram detetadas informações adicionais para o parágrafo.

bounding_box

BoundingPoly

A caixa limitadora do parágrafo. Os vértices estão na ordem superior esquerdo, superior direito, inferior direito e inferior esquerdo. Quando é detetada uma rotação da caixa delimitadora, a rotação é representada em torno do canto superior esquerdo, conforme definido quando o texto é lido na orientação "natural". Por exemplo: * Quando o texto está na horizontal, pode ter o seguinte aspeto: 0----1 | | 3----2 * Quando é rodado 180 graus em torno do canto superior esquerdo, torna-se: 2----3 | | 1----0 e a ordem dos vértices continua a ser (0, 1, 2, 3).

words[]

Word

Lista de palavras neste parágrafo.

confidence

float

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

Posição

Uma posição 3D na imagem, usada principalmente para pontos de referência de deteção de caras. Uma posição válida tem de ter coordenadas x e y. As coordenadas de 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).

Produto

Um produto contém ReferenceImages.

Campos
name

string

O nome do recurso do produto.

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

Este campo é ignorado quando cria um produto.
display_name

string

O nome fornecido pelo utilizador para este produto. Não pode estar vazio. Tem de ter, no máximo, 4096 carateres.

description

string

Metadados fornecidos pelo utilizador a serem armazenados com este produto. Tem de ter, no máximo, 4096 carateres.

product_category

string

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

Este campo é imutável.
product_labels[]

KeyValue

Pares de chave-valor que podem ser anexados a um produto. No momento da consulta, as restrições podem ser especificadas com base nas product_labels.

Tenha em atenção que os valores inteiros podem ser fornecidos como strings, por exemplo, "1199". Apenas as strings com valores inteiros podem corresponder a uma restrição baseada em intervalo, que vai ser suportada em breve.

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

KeyValue

Uma etiqueta de produto representada como um par de chave-valor.

Campos
key

string

A chave da etiqueta anexada ao produto. Não pode estar vazio e não pode exceder 128 bytes.

value

string

O valor da etiqueta anexada ao produto. Não pode estar vazio e não pode exceder 128 bytes.

ProductSearchParams

Parâmetros para um pedido de pesquisa de produtos.

Campos
bounding_poly

BoundingPoly

O polígono de limite em torno da área de interesse na imagem. Opcional. Se não for especificado, é aplicada a discrição do sistema.

product_set

string

O nome do recurso de um ProductSet a ser pesquisado para encontrar imagens semelhantes.

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

string

A lista de categorias de produtos nas quais pesquisar. Atualmente, apenas consideramos a primeira categoria, e deve ser especificado "homegoods", "apparel" ou "toys".

filter

string

A expressão de filtragem. Pode usar esta opção para restringir os resultados da pesquisa com base nas etiquetas dos produtos. Atualmente, suportamos um AND de OR de expressões de chave-valor, em que cada expressão num OR tem de ter a mesma chave.

Por exemplo, "(color = red OR color = blue) AND brand = Google" é aceitável, mas não "(color = red OR brand = Google)" ou "color: red".

ProductSearchResults

Resultados de um pedido de pesquisa de produtos.

Campos
index_time

Timestamp

Data/hora do índice que forneceu estes resultados. As alterações feitas após esta hora não sã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 detetados na imagem da consulta. Cada entrada corresponde a um polígono delimitador na imagem de consulta e contém os produtos correspondentes específicos dessa região. Podem existir correspondências de produtos duplicadas na união de todos os resultados por produto.

GroupedResult

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

Campos
bounding_poly

BoundingPoly

O polígono delimitador à volta do produto detetado 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 produto.

score

float

Um nível de confiança na correspondência, que varia 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. Um ProductSet pode conter um máximo de 1 milhão de imagens de referência. Se o limite for excedido, a indexação periódica falha.

Campos
name

string

O nome do recurso do ProductSet.

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

Este campo é ignorado quando cria um ProductSet.
display_name

string

O nome fornecido pelo utilizador para este ProductSet. Não pode estar vazio. Tem de ter, no máximo, 4096 carateres.

index_time

Timestamp

Apenas saída. A hora em que este ProductSet foi indexado pela última vez. Os resultados da consulta vão refletir todas as atualizações anteriores a esta hora. Se este ProductSet nunca tiver sido indexado, esta data/hora é o valor predefinido "1970-01-01T00:00:00Z".

Este campo é ignorado quando cria um ProductSet.
index_error

Status

Apenas saída. Se tiver ocorrido um erro na indexação do conjunto de produtos, o campo é preenchido.

Este campo é ignorado quando cria um ProductSet.

Propriedade

Um Property consiste num par de nome/valor fornecido pelo utilizador.

Campos
name

string

Nome da propriedade.

value

string

Valor da propriedade.

uint64_value

uint64

Valor das propriedades numéricas.

ReferenceImage

Um ReferenceImage representa uma imagem do produto e os respetivos metadados associados, como caixas de limite.

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.

Este campo é ignorado quando cria uma imagem de referência.
uri

string

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

O URI tem de começar por gs://.

Obrigatório.
bounding_polys[]

BoundingPoly

Polígonos de delimitação em torno das áreas de interesse na imagem de referência. Opcional. Se este campo estiver vazio, o sistema tenta detetar regiões de interesse. São usados, no máximo, 10 polígonos delimitadores.

A forma fornecida é convertida num retângulo não rodado. Após a conversão, o lado mais pequeno do retângulo tem de ser igual ou superior a 300 píxeis. O formato tem de ser 1:4 ou inferior (ou seja, 1:3 é aceitável; 1:5 não é).

RemoveProductFromProductSetRequest

Mensagem de pedido para o método RemoveProductFromProductSet.

Campos
name

string

O nome do recurso do ProductSet a modificar.

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

string

O nome do recurso do produto a remover deste ProductSet.

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

SafeSearchAnnotation

Conjunto de funcionalidades relacionadas com a imagem, calculadas por métodos de visão computacional em verticais de pesquisa segura (por exemplo, conteúdo para adultos, roubo de identidade, médico, violência).

Campos
adult

Likelihood

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

spoof

Likelihood

Probabilidade de spoofing. A probabilidade de ter sido feita uma modificação à versão canónica da imagem para a tornar engraçada ou ofensiva.

medical

Likelihood

Probabilidade de se tratar de uma imagem médica.

violence

Likelihood

Probabilidade de esta imagem conter conteúdo violento.

racy

Likelihood

Probabilidade de a imagem pedida conter conteúdo picante. O conteúdo picante pode incluir, entre outros, vestuário revelador ou transparente, nudez estrategicamente coberta, poses provocantes ou obscenas, ou close-ups de áreas sensíveis do corpo.

Símbolo

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

Campos
property

TextProperty

Foram detetadas informações adicionais para o símbolo.

bounding_box

BoundingPoly

A caixa delimitadora do símbolo. Os vértices estão na ordem superior esquerdo, superior direito, inferior direito e inferior esquerdo. Quando é detetada uma rotação da caixa delimitadora, a rotação é representada em torno do canto superior esquerdo, conforme definido quando o texto é lido na orientação "natural". Por exemplo: * Quando o texto está na horizontal, pode ter o seguinte aspeto: 0----1 | | 3----2 * Quando é rodado 180 graus em torno do canto superior esquerdo, torna-se: 2----3 | | 1----0 e a ordem dos vértices continua a ser (0, 1, 2, 3).

text

string

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

confidence

float

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

TextAnnotation

TextAnnotation contém uma representação estruturada do texto extraído do OCR. A hierarquia de uma estrutura de texto extraído por OCR é a seguinte: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Cada componente estrutural, a partir de Page, também pode ter as suas próprias propriedades. As propriedades descrevem idiomas detetados, pausas, etc. Consulte a definição da mensagem TextAnnotation.TextProperty abaixo para ver mais detalhes.

Campos
pages[]

Page

Lista de páginas detetadas pelo OCR.

text

string

Texto UTF-8 detetado nas páginas.

DetectedBreak

Início ou fim de um componente estrutural detetado.

Campos
type

BreakType

Tipo de quebra detetado.

is_prefix

bool

Verdadeiro se a quebra preceder o elemento.

BreakType

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

Enumerações
UNKNOWN Tipo de etiqueta de quebra desconhecido.
SPACE Espaço normal.
SURE_SPACE Espaço certo (muito largo).
EOL_SURE_SPACE Quebra de moldagem de linhas.
HYPHEN Hífen no final da linha que não está presente no texto; não ocorre em simultâneo com SPACE, LEADER_SPACE ou LINE_BREAK.
LINE_BREAK Quebra de linha que termina um parágrafo.

DetectedLanguage

Idioma detetado para um componente estrutural.

Campos
language_code

string

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

confidence

float

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

TextProperty

Foram detetadas informações adicionais no componente estrutural.

Campos
detected_languages[]

DetectedLanguage

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

detected_break

DetectedBreak

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

UpdateProductRequest

Mensagem de pedido 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 os campos a atualizar. Se update_mask não for especificado, todos os campos mutáveis são atualizados. Os caminhos de máscara válidos incluem product_labels, display_name e description.

UpdateProductSetRequest

Mensagem de pedido para o método UpdateProductSet.

Campos
product_set

ProductSet

O recurso ProductSet que substitui o recurso no servidor.

update_mask

FieldMask

O FieldMask que especifica os campos a atualizar. Se update_mask não for especificado, todos os campos mutáveis são atualizados. O caminho da máscara válido é display_name.

Vertex

Um vértice representa um ponto 2D na imagem. NOTA: as coordenadas dos vértices 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 para a imagem da Internet.

Campos
web_entities[]

WebEntity

Entidades deduzidas a partir de imagens semelhantes na Internet.

full_matching_images[]

WebImage

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

partial_matching_images[]

WebImage

Imagens com correspondência parcial da Internet. Essas imagens são suficientemente semelhantes para partilharem algumas funcionalidades de pontos-chave. Por exemplo, é provável que uma imagem original tenha uma correspondência parcial para os respetivos recortes.

pages_with_matching_images[]

WebPage

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

visually_similar_images[]

WebImage

Os resultados de imagens visualmente semelhantes.

best_guess_labels[]

WebLabel

A melhor estimativa do serviço quanto ao tópico da imagem do pedido. Inferidas a partir de imagens semelhantes na Web aberta.

WebEntity

Entidade deduzida a partir de imagens semelhantes na Internet.

Campos
entity_id

string

ID de entidade opaco.

score

float

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

description

string

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

WebImage

Metadados de imagens online.

Campos
url

string

O URL da imagem do resultado.

score

float

(Obsoleto) Classificação de relevância geral da imagem.

WebLabel

Etiqueta para fornecer metadados adicionais para a deteção na Web.

Campos
label

string

Etiqueta para metadados adicionais.

language_code

string

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

WebPage

Metadados para páginas Web.

Campos
url

string

O URL da página Web do resultado.

score

float

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

page_title

string

Título da página Web, que 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 com correspondência parcial na página. Essas imagens são suficientemente semelhantes para partilharem algumas funcionalidades de pontos-chave. Por exemplo, é provável que uma imagem original tenha uma correspondência parcial para os respetivos recortes.

WebDetectionParams

Parâmetros para o pedido de deteção na Web.

Campos
include_geo_results

bool

Se devem ser incluídos resultados derivados das informações geográficas na imagem.

Word

Uma representação de palavras.

Campos
property

TextProperty

Foram detetadas informações adicionais para a palavra.

bounding_box

BoundingPoly

A caixa limitadora da palavra. Os vértices estão na ordem superior esquerdo, superior direito, inferior direito e inferior esquerdo. Quando é detetada uma rotação da caixa delimitadora, a rotação é representada em torno do canto superior esquerdo, conforme definido quando o texto é lido na orientação "natural". Por exemplo: * Quando o texto está na horizontal, pode ter o seguinte aspeto: 0----1 | | 3----2 * Quando é rodado 180 graus em torno do canto superior esquerdo, torna-se: 2----3 | | 1----0 e a ordem dos vértices continua a ser (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 de OCR para a palavra. Intervalo [0, 1].