Package google.cloud.vision.v1p4beta1

Índice

ImageAnnotator

Servicio que realiza tareas de detección de la API Cloud Vision de Google en imágenes de clientes, como la detección de caras, puntos de referencia, logotipos, etiquetas y texto. El servicio ImageAnnotator devuelve las entidades detectadas en las imágenes.

AsyncBatchAnnotateFiles

rpc AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest) returns (Operation)

Ejecuta la detección y la anotación de imágenes asíncronas en una lista de archivos genéricos, como archivos PDF, que pueden contener varias páginas y varias imágenes por página. El progreso y los resultados se pueden consultar a través de la interfaz google.longrunning.Operations. Operation.metadata contiene OperationMetadata (metadatos). Operation.response contiene AsyncBatchAnnotateFilesResponse (resultados).

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

AsyncBatchAnnotateImages

rpc AsyncBatchAnnotateImages(AsyncBatchAnnotateImagesRequest) returns (Operation)

Ejecuta la detección y la anotación de imágenes asíncronas en una lista de imágenes.

El progreso y los resultados se pueden consultar a través de la interfaz google.longrunning.Operations. Operation.metadata contiene OperationMetadata (metadatos). Operation.response contiene AsyncBatchAnnotateImagesResponse (resultados).

Este servicio escribirá los resultados de las anotaciones de imágenes en archivos JSON del segmento de Google Cloud Storage del cliente. Cada archivo JSON contendrá el proto BatchAnnotateImagesResponse.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

BatchAnnotateFiles

rpc BatchAnnotateFiles(BatchAnnotateFilesRequest) returns (BatchAnnotateFilesResponse)

Servicio que realiza la detección y la anotación de imágenes en un lote de archivos. Ahora solo se admiten "application/pdf", "image/tiff" e "image/gif".

Este servicio extraerá un máximo de 5 fotogramas (GIF) o páginas (PDF o TIFF) de cada archivo proporcionado y realizará la detección y la anotación de cada imagen extraída. Los clientes pueden especificar qué 5 fotogramas o páginas se extraerán en AnnotateFileRequest.pages.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

BatchAnnotateImages

rpc BatchAnnotateImages(BatchAnnotateImagesRequest) returns (BatchAnnotateImagesResponse)

Ejecuta la detección y la anotación de imágenes en un lote de imágenes.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

Búsqueda de productos

Gestiona los productos y los ProductSets de imágenes de referencia para usarlos en la búsqueda de productos. Usa el siguiente modelo de recursos:

  • La API tiene una colección de recursos ProductSet, denominada projects/*/locations/*/productSets/*, que permite agrupar diferentes productos para limitar la identificación.

Paralelamente,

  • La API tiene una colección de recursos Product llamada projects/*/locations/*/products/*.

  • Cada Product tiene una colección de recursos ReferenceImage, llamada projects/*/locations/*/products/*/referenceImages/*.

AddProductToProductSet

rpc AddProductToProductSet(AddProductToProductSetRequest) returns (Empty)

Añade un producto al ProductSet especificado. Si el producto ya está presente, no se hace ningún cambio.

Un producto se puede añadir a un máximo de 100 ProductSets.

A continuación se indican los posibles errores.

  • Devuelve NOT_FOUND si el producto o el ProductSet no existen.
Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

CreateProduct

rpc CreateProduct(CreateProductRequest) returns (Product)

Crea y devuelve un nuevo recurso de producto.

A continuación se indican los posibles errores.

  • Devuelve INVALID_ARGUMENT si falta display_name o tiene más de 4096 caracteres.
  • Devuelve INVALID_ARGUMENT si la descripción supera los 4096 caracteres.
  • Devuelve INVALID_ARGUMENT si falta product_category o no es válido.
Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

CreateProductSet

rpc CreateProductSet(CreateProductSetRequest) returns (ProductSet)

Crea y devuelve un recurso ProductSet.

A continuación se indican los posibles errores.

  • Devuelve INVALID_ARGUMENT si falta display_name o si tiene más de 4096 caracteres.
Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

CreateReferenceImage

rpc CreateReferenceImage(CreateReferenceImageRequest) returns (ReferenceImage)

Crea y devuelve un nuevo recurso ReferenceImage.

El campo bounding_poly es opcional. Si no se especifica bounding_poly, el sistema intentará detectar regiones de interés en la imagen que sean compatibles con el valor de product_category del producto principal. Si se especifica, la detección SIEMPRE se omite. El sistema convierte los polígonos en rectángulos sin rotar.

Ten en cuenta que la canalización cambiará el tamaño de la imagen si su resolución es demasiado grande para procesarla (más de 50 MP).

A continuación se indican los posibles errores.

  • Devuelve INVALID_ARGUMENT si falta image_uri o si tiene más de 4096 caracteres.
  • Devuelve INVALID_ARGUMENT si el producto no existe.
  • Devuelve INVALID_ARGUMENT si no se proporciona bounding_poly y no se detecta nada compatible con product_category del producto principal.
  • Devuelve INVALID_ARGUMENT si bounding_poly contiene más de 10 polígonos.
Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

DeleteProduct

rpc DeleteProduct(DeleteProductRequest) returns (Empty)

Elimina de forma permanente un producto y sus imágenes de referencia.

Los metadatos del producto y todas sus imágenes se eliminarán de inmediato, pero las consultas de búsqueda en ProductSets que contengan el producto pueden seguir funcionando hasta que se actualicen todas las cachés relacionadas.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

DeleteProductSet

rpc DeleteProductSet(DeleteProductSetRequest) returns (Empty)

Elimina un ProductSet de forma permanente. Los productos y las imágenes de referencia del ProductSet no se eliminan.

Los archivos de imagen no se eliminan de Google Cloud Storage.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

DeleteReferenceImage

rpc DeleteReferenceImage(DeleteReferenceImageRequest) returns (Empty)

Elimina una imagen de referencia de forma permanente.

Los metadatos de la imagen se eliminarán de inmediato, pero las consultas de búsqueda en ProductSets que contengan la imagen pueden seguir funcionando hasta que se actualicen todas las cachés relacionadas.

Los archivos de imagen no se eliminan de Google Cloud Storage.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

GetProduct

rpc GetProduct(GetProductRequest) returns (Product)

Obtiene información asociada a un producto.

A continuación se indican los posibles errores.

  • Devuelve NOT_FOUND si el producto no existe.
Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

GetProductSet

rpc GetProductSet(GetProductSetRequest) returns (ProductSet)

Obtiene la información asociada a un ProductSet.

A continuación se indican los posibles errores.

  • Devuelve NOT_FOUND si el ProductSet no existe.
Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

GetReferenceImage

rpc GetReferenceImage(GetReferenceImageRequest) returns (ReferenceImage)

Obtiene información asociada a un ReferenceImage.

A continuación se indican los posibles errores.

  • Devuelve NOT_FOUND si la imagen especificada no existe.
Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

ImportProductSets

rpc ImportProductSets(ImportProductSetsRequest) returns (Operation)

API asíncrona que importa una lista de imágenes de referencia a conjuntos de productos especificados a partir de una lista de información de imágenes.

La API google.longrunning.Operation se puede usar para monitorizar el progreso y los resultados de la solicitud. Operation.metadata contiene BatchOperationMetadata. (progreso) Operation.response contiene ImportProductSetsResponse. (resultados)

La fuente de entrada de este método es un archivo CSV en Google Cloud Storage. Para ver el formato del archivo CSV, consulta ImportProductSetsGcsSource.csv_file_uri.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

ListProductSets

rpc ListProductSets(ListProductSetsRequest) returns (ListProductSetsResponse)

Muestra los ProductSets en un orden no especificado.

A continuación se indican los posibles errores.

  • Devuelve INVALID_ARGUMENT si page_size es mayor que 100 o menor que 1.
Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

ListProducts

rpc ListProducts(ListProductsRequest) returns (ListProductsResponse)

Muestra los productos en un orden no especificado.

A continuación se indican los posibles errores.

  • Devuelve INVALID_ARGUMENT si page_size es mayor que 100 o menor que 1.
Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

ListProductsInProductSet

rpc ListProductsInProductSet(ListProductsInProductSetRequest) returns (ListProductsInProductSetResponse)

Muestra los productos de un ProductSet en un orden no especificado. Si el ProductSet no existe, el campo products de la respuesta estará vacío.

A continuación se indican los posibles errores.

  • Devuelve INVALID_ARGUMENT si page_size es mayor que 100 o menor que 1.
Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

ListReferenceImages

rpc ListReferenceImages(ListReferenceImagesRequest) returns (ListReferenceImagesResponse)

Muestra las imágenes de referencia.

A continuación se indican los posibles errores.

  • Devuelve NOT_FOUND si el producto superior no existe.
  • Devuelve INVALID_ARGUMENT si page_size es mayor que 100 o menor que 1.
Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

RemoveProductFromProductSet

rpc RemoveProductFromProductSet(RemoveProductFromProductSetRequest) returns (Empty)

Elimina un producto del ProductSet especificado.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

UpdateProduct

rpc UpdateProduct(UpdateProductRequest) returns (Product)

Hace cambios en un recurso Product. Por el momento, solo se pueden actualizar los campos display_name, description y labels.

Si se actualizan las etiquetas, el cambio no se reflejará en las consultas hasta la próxima indexación.

A continuación se indican los posibles errores.

  • Devuelve NOT_FOUND si el producto no existe.
  • Devuelve INVALID_ARGUMENT si display_name está presente en update_mask, pero falta en la solicitud o tiene más de 4096 caracteres.
  • Devuelve INVALID_ARGUMENT si la descripción está presente en update_mask, pero tiene más de 4096 caracteres.
  • Devuelve INVALID_ARGUMENT si product_category está presente en update_mask.
Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

UpdateProductSet

rpc UpdateProductSet(UpdateProductSetRequest) returns (ProductSet)

Hace cambios en un recurso ProductSet. Por el momento, solo se puede actualizar display_name.

A continuación se indican los posibles errores.

  • Devuelve NOT_FOUND si el ProductSet no existe.
  • Devuelve INVALID_ARGUMENT si display_name está presente en update_mask, pero falta en la solicitud o tiene más de 4096 caracteres.
Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el artículo Descripción general de la autenticación.

AddProductToProductSetRequest

Mensaje de solicitud del método AddProductToProductSet.

Campos
name

string

Nombre de recurso del ProductSet que se va a modificar.

El formato es projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.

product

string

Nombre de recurso del producto que se va a añadir a este ProductSet.

El formato es projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

AnnotateFileRequest

Una solicitud para anotar un solo archivo, como un archivo PDF, TIFF o GIF.

Campos
input_config

InputConfig

Obligatorio. Información sobre el archivo de entrada.

features[]

Feature

Obligatorio. Funciones solicitadas.

image_context

ImageContext

Contexto adicional que puede acompañar a las imágenes del archivo.

pages[]

int32

Páginas del archivo para realizar la anotación de imágenes.

Las páginas empiezan por 1. Suponemos que la primera página del archivo es la página 1. Se admiten 5 páginas como máximo por solicitud. Las páginas pueden ser negativas.

Página 1 significa la primera página. Página 2 significa la segunda página. La página -1 significa la última página. La página -2 es la penúltima.

Si el archivo es GIF en lugar de PDF o TIFF, la página hace referencia a los fotogramas GIF.

Si este campo está vacío, el servicio realizará de forma predeterminada la anotación de imagen de las 5 primeras páginas del archivo.

AnnotateFileResponse

Respuesta a una solicitud de anotación de un solo archivo. Un archivo puede contener una o varias imágenes, que tienen sus propias respuestas.

Campos
input_config

InputConfig

Información sobre el archivo para el que se genera esta respuesta.

responses[]

AnnotateImageResponse

Respuestas individuales a las imágenes encontradas en el archivo.

total_pages

int32

Este campo indica el número total de páginas del archivo.

AnnotateImageRequest

Solicitud para realizar tareas de la API Cloud Vision de Google en una imagen proporcionada por el usuario, con las funciones solicitadas por el usuario y con información de contexto.

Campos
image

Image

La imagen que se va a procesar.

features[]

Feature

Funciones solicitadas.

image_context

ImageContext

Contexto adicional que puede acompañar a la imagen.

AnnotateImageResponse

Respuesta a una solicitud de anotación de imagen.

Campos
face_annotations[]

FaceAnnotation

Si está presente, la detección facial se ha completado correctamente.

landmark_annotations[]

EntityAnnotation

Si está presente, la detección de monumentos se ha completado correctamente.

logo_annotations[]

EntityAnnotation

Si está presente, la detección del logotipo se ha completado correctamente.

label_annotations[]

EntityAnnotation

Si está presente, significa que la detección de etiquetas se ha completado correctamente.

localized_object_annotations[]

LocalizedObjectAnnotation

Si está presente, la detección de objetos localizada se ha completado correctamente. Se ordenarán de forma descendente por puntuación de confianza.

text_annotations[]

EntityAnnotation

Si está presente, la detección de texto (OCR) se ha completado correctamente.

full_text_annotation

TextAnnotation

Si está presente, la detección de texto (OCR) o la detección de texto en documentos (OCR) se ha completado correctamente. Esta anotación proporciona la jerarquía estructural del texto detectado por OCR.

safe_search_annotation

SafeSearchAnnotation

Si está presente, la anotación de búsqueda segura se ha completado correctamente.

image_properties_annotation

ImageProperties

Si está presente, las propiedades de la imagen se han extraído correctamente.

crop_hints_annotation

CropHintsAnnotation

Si está presente, las sugerencias de recorte se han completado correctamente.

web_detection

WebDetection

Si está presente, la detección web se ha completado correctamente.

product_search_results

ProductSearchResults

Si está presente, la búsqueda de productos se ha completado correctamente.

error

Status

Si se define, representa el mensaje de error de la operación. Ten en cuenta que las anotaciones de imagen rellenadas son correctas, incluso cuando se ha definido error.

context

ImageAnnotationContext

Si está presente, se necesita información contextual para saber de dónde procede la imagen.

AsyncAnnotateFileRequest

Una solicitud de anotación de archivos sin conexión.

Campos
input_config

InputConfig

Obligatorio. Información sobre el archivo de entrada.

features[]

Feature

Obligatorio. Funciones solicitadas.

image_context

ImageContext

Contexto adicional que puede acompañar a las imágenes del archivo.

output_config

OutputConfig

Obligatorio. La ubicación de salida y los metadatos que quieras (por ejemplo, el formato).

AsyncAnnotateFileResponse

Respuesta a una solicitud de anotación de un solo archivo sin conexión.

Campos
output_config

OutputConfig

La ubicación de salida y los metadatos de AsyncAnnotateFileRequest.

AsyncBatchAnnotateFilesRequest

Varias solicitudes asíncronas de anotación de archivos se agrupan en una sola llamada de servicio.

Campos
requests[]

AsyncAnnotateFileRequest

Solicitudes individuales de anotación de archivos asíncronas de este lote.

AsyncBatchAnnotateFilesResponse

Respuesta a una solicitud de anotación de archivos por lotes asíncrona.

Campos
responses[]

AsyncAnnotateFileResponse

Lista de respuestas de anotación de archivos, una por cada solicitud de AsyncBatchAnnotateFilesRequest.

AsyncBatchAnnotateImagesRequest

Solicitud de anotación de imágenes asíncrona para una lista de imágenes.

Campos
requests[]

AnnotateImageRequest

Solicitudes de anotación de imágenes individuales de este lote.

output_config

OutputConfig

Obligatorio. La ubicación de salida y los metadatos que quieras (por ejemplo, el formato).

AsyncBatchAnnotateImagesResponse

Respuesta a una solicitud de anotación de imágenes por lotes asíncrona.

Campos
output_config

OutputConfig

Ubicación de salida y metadatos de AsyncBatchAnnotateImagesRequest.

BatchAnnotateFilesRequest

Lista de solicitudes para anotar archivos mediante la API BatchAnnotateFiles.

Campos
requests[]

AnnotateFileRequest

Lista de solicitudes de anotación de archivos. Por el momento, solo admitimos un AnnotateFileRequest en BatchAnnotateFilesRequest.

BatchAnnotateFilesResponse

Lista de respuestas de anotaciones de archivos.

Campos
responses[]

AnnotateFileResponse

Lista de respuestas de anotación de archivos. Cada respuesta corresponde a un AnnotateFileRequest de BatchAnnotateFilesRequest.

BatchAnnotateImagesRequest

Varias solicitudes de anotación de imágenes se agrupan en una sola llamada de servicio.

Campos
requests[]

AnnotateImageRequest

Solicitudes de anotación de imágenes individuales de este lote.

BatchAnnotateImagesResponse

Respuesta a una solicitud de anotación de imágenes por lotes.

Campos
responses[]

AnnotateImageResponse

Respuestas individuales a las solicitudes de anotación de imágenes del lote.

BatchOperationMetadata

Metadatos de las operaciones por lotes, como el estado actual.

Se incluye en el campo metadata del Operation devuelto por la llamada GetOperation del servicio google::longrunning::Operations.

Campos
state
(deprecated)

State

El estado actual de la operación por lotes.

submit_time

Timestamp

La hora a la que se envió la petición del lote al servidor.

end_time

Timestamp

La hora en la que se completa la solicitud por lotes y google.longrunning.Operation.done se establece en true.

Estado

Enumera los posibles estados en los que puede estar la solicitud en lote.

Enumeraciones
STATE_UNSPECIFIED No es válida.
PROCESSING La solicitud se está procesando.
SUCCESSFUL La solicitud se ha completado y se ha procesado correctamente al menos un elemento.
FAILED La solicitud se ha completado y no se ha procesado ningún elemento correctamente.
CANCELLED La solicitud se realiza después de que el usuario haya llamado a longrunning.Operations.CancelOperation. Los registros que se hayan procesado antes del comando de cancelación se mostrarán tal como se especifica en la solicitud.

Bloquear

Elemento lógico de la página.

Campos
property

TextProperty

Se ha detectado información adicional sobre el bloque.

bounding_box

BoundingPoly

Cuadro delimitador del bloque. Los vértices se indican en el siguiente orden: superior izquierda, superior derecha, inferior derecha e inferior izquierda. Cuando se detecta una rotación del cuadro delimitador, se representa alrededor de la esquina superior izquierda, tal como se define cuando el texto se lee en la orientación "natural". Por ejemplo:

  • Si el texto es horizontal, puede tener este aspecto:
    0----1
    |    |
    3----2
  • Cuando se gira 180 grados alrededor de la esquina superior izquierda, se convierte en lo siguiente:
    2----3
    |    |
    1----0

y el orden de los vértices seguirá siendo (0, 1, 2, 3).

paragraphs[]

Paragraph

Lista de párrafos de este bloque (si el bloque es de tipo texto).

block_type

BlockType

Tipo de bloque detectado (texto, imagen, etc.) de este bloque.

confidence

float

Confianza de los resultados de OCR en el bloque. Intervalo [0, 1].

BlockType

Tipo de bloque (texto, imagen, etc.) identificado por el OCR.

Enumeraciones
UNKNOWN Tipo de bloque desconocido.
TEXT Bloque de texto normal.
TABLE Bloque de tabla.
PICTURE Bloque de imagen.
RULER Cuadro de línea horizontal o vertical.
BARCODE Bloque de código de barras.

BoundingPoly

Polígono delimitador de la anotación de imagen detectada.

Campos
vertices[]

Vertex

Vértices del polígono delimitador.

normalized_vertices[]

NormalizedVertex

Vértices normalizados del polígono delimitador.

ColorInfo

La información de color consta de canales RGB, una puntuación y la fracción de la imagen que ocupa el color en la imagen.

Campos
color

Color

Componentes RGB del color.

score

float

Puntuación específica de la imagen para este color. Valor en el intervalo [0, 1].

pixel_fraction

float

La fracción de píxeles que ocupa el color en la imagen. Valor en el intervalo [0, 1].

CreateProductRequest

Mensaje de solicitud del método CreateProduct.

Campos
parent

string

Proyecto en el que se debe crear el producto.

El formato es projects/PROJECT_ID/locations/LOC_ID.

product

Product

Producto que se va a crear.

product_id

string

ID de recurso proporcionado por el usuario para este producto. Si se define, el servidor intentará usar este valor como ID de recurso. Si ya se está usando, se devuelve un error con el código ALREADY_EXISTS. Debe tener 128 caracteres como máximo. No puede contener el carácter /.

CreateProductSetRequest

Mensaje de solicitud del método CreateProductSet.

Campos
parent

string

Proyecto en el que se debe crear el ProductSet.

El formato es projects/PROJECT_ID/locations/LOC_ID.

product_set

ProductSet

ProductSet que se va a crear.

product_set_id

string

ID de recurso proporcionado por el usuario para este ProductSet. Si se define, el servidor intentará usar este valor como ID de recurso. Si ya se está usando, se devuelve un error con el código ALREADY_EXISTS. Debe tener 128 caracteres como máximo. No puede contener el carácter /.

CreateReferenceImageRequest

Mensaje de solicitud del método CreateReferenceImage.

Campos
parent

string

Nombre de recurso del producto en el que se va a crear la imagen de referencia.

El formato es projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

reference_image

ReferenceImage

Imagen de referencia que se va a crear. Si se especifica un ID de imagen, se ignora.

reference_image_id

string

ID de recurso proporcionado por el usuario de la imagen de referencia que se va a añadir. Si se define, el servidor intentará usar este valor como ID de recurso. Si ya se está usando, se devuelve un error con el código ALREADY_EXISTS. Debe tener 128 caracteres como máximo. No puede contener el carácter /.

CropHint

Sugerencia de recorte único que se usa para generar un nuevo recorte al servir una imagen.

Campos
bounding_poly

BoundingPoly

Polígono delimitador de la zona de recorte. Las coordenadas del cuadro delimitador están en la escala de la imagen original.

confidence

float

Confianza de que se trata de una región destacada. Intervalo [0, 1].

importance_fraction

float

Fracción de la importancia de esta región destacada con respecto a la imagen original.

CropHintsAnnotation

Conjunto de sugerencias de recorte que se usan para generar nuevos recortes al servir imágenes.

Campos
crop_hints[]

CropHint

Resultados de las pistas de recorte.

CropHintsParams

Parámetros de la solicitud de anotación de sugerencias de recorte.

Campos
aspect_ratios[]

float

Relaciones de aspecto en números de coma flotante, que representan la relación entre la anchura y la altura de la imagen. Por ejemplo, si la relación de aspecto que quieres es 4/3, el valor flotante correspondiente debe ser 1,33333. Si no se especifica, se devuelve el mejor recorte posible. El número de relaciones de aspecto proporcionadas está limitado a un máximo de 16. Las relaciones de aspecto que se proporcionen después de la decimosexta se ignorarán.

DeleteProductRequest

Mensaje de solicitud del método DeleteProduct.

Campos
name

string

Nombre de recurso del producto que se va a eliminar.

El formato es projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

DeleteProductSetRequest

Mensaje de solicitud del método DeleteProductSet.

Campos
name

string

Nombre de recurso del ProductSet que se va a eliminar.

El formato es projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.

DeleteReferenceImageRequest

Mensaje de solicitud del método DeleteReferenceImage.

Campos
name

string

Nombre de recurso de la imagen de referencia que se va a eliminar.

El formato es el siguiente:

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

DominantColorsAnnotation

Conjunto de colores predominantes y sus puntuaciones correspondientes.

Campos
colors[]

ColorInfo

Valores de color RGB con su puntuación y fracción de píxeles.

EntityAnnotation

Conjunto de características de la entidad detectada.

Campos
mid

string

ID de entidad opaco. Algunos IDs pueden estar disponibles en la API Search de gráfico de conocimiento de Google.

locale

string

Código de idioma de la configuración regional en la que se expresa el texto de la entidad description.

description

string

Descripción textual de la entidad, expresada en su idioma locale.

score

float

Puntuación general del resultado. Intervalo [0, 1].

confidence
(deprecated)

float

Obsoleto. En su lugar, usa score. La precisión de la detección de entidades en una imagen. Por ejemplo, en una imagen en la que se detecta la entidad "Torre Eiffel", este campo representa la confianza de que hay una torre en la imagen de la consulta. Intervalo [0, 1].

topicality

float

La relevancia de la etiqueta ICA (anotación de contenido de imagen) para la imagen. Por ejemplo, la relevancia de "torre" es probablemente mayor para una imagen que contiene la "Torre Eiffel" detectada que para una imagen que contiene un edificio alto detectado a lo lejos, aunque la confianza de que hay una torre en cada imagen sea la misma. Intervalo [0, 1].

bounding_poly

BoundingPoly

Región de la imagen a la que pertenece esta entidad. No se ha producido para las funciones de LABEL_DETECTION.

locations[]

LocationInfo

Información de la ubicación de la entidad detectada. Puede haber varios elementos LocationInfo, ya que una ubicación puede indicar el lugar de la escena de la imagen y otra, el lugar donde se tomó la imagen. La información de ubicación suele estar disponible para los puntos de referencia.

properties[]

Property

Algunas entidades pueden tener campos Property (nombre/valor) opcionales proporcionados por el usuario, como una puntuación o una cadena que califique a la entidad.

FaceAnnotation

Un objeto de anotación de cara contiene los resultados de la detección de caras.

Campos
bounding_poly

BoundingPoly

Polígono delimitador alrededor de la cara. Las coordenadas del cuadro delimitador están en la escala de la imagen original. El cuadro delimitador se calcula para "encuadrar" la cara de acuerdo con las expectativas de los humanos. Se basa en los resultados de los puntos de referencia. Ten en cuenta que es posible que no se generen una o varias coordenadas X o Y en BoundingPoly (el polígono no tendrá límites) si solo aparece una parte de la cara en la imagen que se va a anotar.

fd_bounding_poly

BoundingPoly

El polígono envolvente fd_bounding_poly es más ajustado que el boundingPoly y solo incluye la parte de la cara que corresponde a la piel. Normalmente, se usa para eliminar la cara de cualquier análisis de imagen que detecte la "cantidad de piel" visible en una imagen. No se basa en los resultados de los puntos de referencia, sino solo en la detección inicial de la cara, por lo que

fd

(detección de caras).

landmarks[]

Landmark

Puntos de referencia de la cara detectados.

roll_angle

float

Ángulo de inclinación, que indica el grado de rotación de la cara en el sentido de las agujas del reloj o en el contrario con respecto a la vertical de la imagen en torno al eje perpendicular a la cara. Intervalo [-180,180].

pan_angle

float

Ángulo de guiño, que indica el ángulo hacia la izquierda o hacia la derecha al que mira la cara con respecto al plano vertical perpendicular a la imagen. Intervalo [-180,180].

tilt_angle

float

Ángulo de inclinación, que indica el ángulo hacia arriba o hacia abajo al que apunta la cara con respecto al plano horizontal de la imagen. Intervalo [-180,180].

detection_confidence

float

Confianza de detección. Intervalo [0, 1].

landmarking_confidence

float

Confianza de los puntos de referencia faciales. Intervalo [0, 1].

joy_likelihood

Likelihood

Probabilidad de alegría.

sorrow_likelihood

Likelihood

Probabilidad de tristeza.

anger_likelihood

Likelihood

Probabilidad de enfado.

surprise_likelihood

Likelihood

Probabilidad de sorpresa.

under_exposed_likelihood

Likelihood

Probabilidad de que no se muestren suficientes anuncios.

blurred_likelihood

Likelihood

Probabilidad de desenfoque.

headwear_likelihood

Likelihood

Probabilidad de llevar accesorios para la cabeza.

Punto de referencia

Un punto de referencia específico de la cara (por ejemplo, un rasgo facial).

Campos
type

Type

Tipo de punto de referencia facial.

position

Position

Posición de los puntos de referencia de la cara.

Tipo

Tipo de punto de referencia (característica) facial. La izquierda y la derecha se definen desde el punto de vista de la persona que ve la imagen, sin tener en cuenta las proyecciones de espejo típicas de las fotos. Por lo tanto, LEFT_EYE suele ser el ojo derecho de la persona.

Enumeraciones
UNKNOWN_LANDMARK Se ha detectado un punto de referencia facial desconocido. No debe rellenarse.
LEFT_EYE Ojo izquierdo.
RIGHT_EYE Ojo derecho.
LEFT_OF_LEFT_EYEBROW A la izquierda de la ceja izquierda.
RIGHT_OF_LEFT_EYEBROW A la derecha de la ceja izquierda.
LEFT_OF_RIGHT_EYEBROW A la izquierda de la ceja derecha.
RIGHT_OF_RIGHT_EYEBROW Derecha de la ceja derecha.
MIDPOINT_BETWEEN_EYES Punto medio entre los ojos.
NOSE_TIP Punta de la nariz.
UPPER_LIP Labio superior.
LOWER_LIP Labio inferior.
MOUTH_LEFT Boca a la izquierda.
MOUTH_RIGHT Boca a la derecha.
MOUTH_CENTER Centro de la boca.
NOSE_BOTTOM_RIGHT Nariz, abajo a la derecha.
NOSE_BOTTOM_LEFT Nariz, abajo a la izquierda.
NOSE_BOTTOM_CENTER Nariz, parte inferior central.
LEFT_EYE_TOP_BOUNDARY Borde superior del ojo izquierdo.
LEFT_EYE_RIGHT_CORNER Ojo izquierdo, esquina derecha.
LEFT_EYE_BOTTOM_BOUNDARY Borde inferior del ojo izquierdo.
LEFT_EYE_LEFT_CORNER Ojo izquierdo, esquina izquierda.
RIGHT_EYE_TOP_BOUNDARY Borde superior del ojo derecho.
RIGHT_EYE_RIGHT_CORNER Ojo derecho, esquina derecha.
RIGHT_EYE_BOTTOM_BOUNDARY Ojo derecho, límite inferior.
RIGHT_EYE_LEFT_CORNER Ojo derecho, esquina izquierda.
LEFT_EYEBROW_UPPER_MIDPOINT Parte superior central de la ceja izquierda.
RIGHT_EYEBROW_UPPER_MIDPOINT Cejas derecha, punto medio superior.
LEFT_EAR_TRAGION Trago de la oreja izquierda.
RIGHT_EAR_TRAGION Trago de la oreja derecha.
LEFT_EYE_PUPIL Pupila del ojo izquierdo.
RIGHT_EYE_PUPIL Pupila del ojo derecho.
FOREHEAD_GLABELLA Entrecejo.
CHIN_GNATHION Mentón (gnation).
CHIN_LEFT_GONION Mentón izquierdo.
CHIN_RIGHT_GONION Mentón derecho.

Función

El tipo de detección de la API Cloud Vision de Google que se va a realizar y el número máximo de resultados que se devolverán para ese tipo. Se pueden especificar varios objetos Feature en la lista features.

Campos
type

Type

El tipo de función.

max_results

int32

Número máximo de resultados de este tipo. No se aplica a TEXT_DETECTION, DOCUMENT_TEXT_DETECTION ni CROP_HINTS.

model

string

Modelo que se usará para la función. Valores admitidos: "builtin/stable" (valor predeterminado si no se define) y "builtin/latest".

Tipo

Tipo de función de la API Google Cloud Vision que se va a extraer.

Enumeraciones
TYPE_UNSPECIFIED Tipo de función no especificado.
FACE_DETECTION Ejecuta la detección de caras.
LANDMARK_DETECTION Ejecuta la detección de puntos de referencia.
LOGO_DETECTION Ejecuta la detección de logotipos.
LABEL_DETECTION Ejecuta la detección de etiquetas.
TEXT_DETECTION Ejecuta la detección de texto o el reconocimiento óptico de caracteres (OCR). La detección de texto está optimizada para las partes en las que el texto está disperso dentro de una imagen más grande. Si la imagen es un documento, utiliza DOCUMENT_TEXT_DETECTION en su lugar.
DOCUMENT_TEXT_DETECTION Aplica OCR a documentos con mucho texto. Tiene prioridad cuando tanto DOCUMENT_TEXT_DETECTION como TEXT_DETECTION están presentes.
SAFE_SEARCH_DETECTION Ejecuta Búsqueda Segura para detectar contenido potencialmente no seguro o no deseado.
IMAGE_PROPERTIES Calcula un conjunto de propiedades de la imagen, como los colores predominantes.
CROP_HINTS Ejecuta pistas de recorte.
WEB_DETECTION Ejecuta la detección web.
OBJECT_LOCALIZATION Ejecuta el localizador para la detección de objetos.

GcsDestination

Ubicación de Google Cloud Storage en la que se escribirá la salida.

Campos
uri

string

Prefijo del URI de Google Cloud Storage donde se almacenarán los resultados. Los resultados estarán en formato JSON y precedidos por el prefijo del URI de entrada correspondiente. Este campo puede representar un prefijo de archivo de Google Cloud Storage o un directorio de Google Cloud Storage. En cualquier caso, el URI debe ser único, ya que, para obtener todos los archivos de salida, tendrás que hacer una búsqueda con comodín en Google Cloud Storage con el prefijo de URI que proporciones.

Ejemplos:

Si hay varias salidas, cada respuesta sigue siendo AnnotateFileResponse, y cada una de ellas contiene un subconjunto de la lista completa de AnnotateImageResponse. Esto puede ocurrir si, por ejemplo, el JSON de salida es demasiado grande y se desborda en varios archivos fragmentados.

GcsSource

Ubicación de Google Cloud Storage desde la que se leerá la entrada.

Campos
uri

string

URI de Google Cloud Storage del archivo de entrada. Solo puede ser un objeto de Google Cloud Storage. Actualmente no se admiten comodines.

GetProductRequest

Mensaje de solicitud del método GetProduct.

Campos
name

string

Nombre de recurso del producto que se va a obtener.

El formato es projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

GetProductSetRequest

Mensaje de solicitud del método GetProductSet.

Campos
name

string

Nombre de recurso del ProductSet que se va a obtener.

El formato es projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.

GetReferenceImageRequest

Mensaje de solicitud del método GetReferenceImage.

Campos
name

string

Nombre de recurso de la imagen de referencia que se va a obtener.

El formato es el siguiente:

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

Imagen

Imagen de cliente para realizar tareas de la API Cloud Vision de Google.

Campos
content

bytes

Contenido de la imagen, representado como un flujo de bytes. Nota: Al igual que con todos los campos bytes, los protobuffers usan una representación binaria pura, mientras que las representaciones JSON usan base64.

source

ImageSource

Ubicación de la imagen en Google Cloud Storage o URL de la imagen de acceso público. Si se proporcionan content y source para una imagen, content tiene prioridad y se usa para realizar la solicitud de anotación de la imagen.

ImageAnnotationContext

Si una imagen se ha generado a partir de un archivo (por ejemplo, un PDF), este mensaje proporciona información sobre la fuente de la imagen.

Campos
uri

string

El URI del archivo usado para generar la imagen.

page_number

int32

Si el archivo era un PDF o un TIFF, este campo indica el número de página del archivo que se ha usado para generar la imagen.

ImageContext

Contexto de la imagen o parámetros específicos de la función.

Campos
lat_long_rect

LatLongRect

No se usa.

language_hints[]

string

Lista de idiomas que se van a usar para TEXT_DETECTION. En la mayoría de los casos, un valor vacío da los mejores resultados, ya que permite la detección automática del idioma. En los idiomas basados en el alfabeto latino, no es necesario definir language_hints. En casos excepcionales, cuando se conoce el idioma del texto de la imagen, definir una pista ayudará a obtener mejores resultados (aunque será un obstáculo importante si la pista es incorrecta). La detección de texto devuelve un error si uno o varios de los idiomas especificados no se encuentran entre los idiomas admitidos.

crop_hints_params

CropHintsParams

Parámetros de la solicitud de anotación de sugerencias de recorte.

product_search_params

ProductSearchParams

Parámetros de búsqueda de productos.

web_detection_params

WebDetectionParams

Parámetros de detección web.

ImageProperties

Almacena propiedades de la imagen, como los colores predominantes.

Campos
dominant_colors

DominantColorsAnnotation

Si está presente, los colores dominantes se han completado correctamente.

ImageSource

Fuente de imagen externa (Google Cloud Storage o ubicación de imagen de URL web).

Campos
gcs_image_uri

string

Usa image_uri en su lugar.

El URI de Google Cloud Storage con el formato gs://bucket_name/object_name. No se admite el control de versiones de objetos. Consulta más información sobre los URIs de solicitud de Google Cloud Storage.

image_uri

string

URI de la imagen de origen. Puede ser:

  1. Un URI de Google Cloud Storage con el formato gs://bucket_name/object_name. No se admite el control de versiones de objetos. Consulta más información sobre los URIs de solicitud de Google Cloud Storage.

  2. Una URL HTTP o HTTPS de una imagen de acceso público. Cuando se obtienen imágenes de URLs HTTP o HTTPS, Google no puede garantizar que la solicitud se complete. Es posible que tu solicitud falle si el host especificado la deniega (por ejemplo, debido a la limitación de solicitudes o a la prevención de ataques DoS) o si Google limita las solicitudes al sitio para evitar abusos. No debes depender de imágenes alojadas externamente para las aplicaciones de producción.

Si se especifican tanto gcs_image_uri como image_uri, image_uri tiene prioridad.

ImportProductSetsGcsSource

Ubicación de Google Cloud Storage de un archivo CSV que conserva una lista de ImportProductSetRequests en cada línea.

Campos
csv_file_uri

string

El URI de Google Cloud Storage del archivo CSV de entrada.

El URI debe empezar por gs://.

El formato del archivo CSV de entrada debe ser una imagen por línea. Cada línea tiene 8 columnas.

  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

Las columnas image-uri, product-set-id, product-id y product-category son obligatorias. Todas las demás columnas son opcionales.

Si no existe el ProductSet o el Product especificado por los valores product-set-id y product-id, el sistema creará un ProductSet o un Product para la imagen. En este caso, la columna product-display-name hace referencia a display_name, la columna product-category hace referencia a product_category y la columna labels hace referencia a product_labels.

La columna image-id es opcional, pero debe ser única si se proporciona. Si está vacío, el sistema asignará automáticamente un ID único a la imagen.

La columna product-display-name es opcional. Si está vacío, el sistema asigna un espacio (" ") al campo display_name del producto. Puede actualizar el campo display_name más adelante mediante la API.

Si ya existe un Product con el product-id especificado, el sistema ignora las columnas product-display-name, product-category y labels.

La columna labels (opcional) es una línea que contiene una lista de pares clave-valor separados por comas con el siguiente formato:

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

La columna bounding-poly (opcional) identifica una región de interés de la imagen de la misma forma que CreateReferenceImage. Si no especifica la columna bounding-poly, el sistema intentará detectar las regiones de interés automáticamente.

Se permite una columna bounding-poly como máximo por línea. Si la imagen contiene varias regiones de interés, añada una línea al archivo CSV que incluya la misma información del producto y los valores bounding-poly de cada región de interés.

La columna bounding-poly debe contener un número par de números separados por comas con el formato "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Usa números enteros no negativos para los polígonos envolventes absolutos y valores flotantes en [0, 1] para los polígonos envolventes normalizados.

El sistema cambiará el tamaño de la imagen si la resolución es demasiado grande para procesarla (más de 20 MP).

ImportProductSetsInputConfig

El contenido de entrada del método ImportProductSets.

Campos
gcs_source

ImportProductSetsGcsSource

Ubicación de Google Cloud Storage de un archivo CSV que conserva una lista de ImportProductSetRequests en cada línea.

ImportProductSetsRequest

Mensaje de solicitud del método ImportProductSets.

Campos
parent

string

Proyecto en el que se deben importar los ProductSets.

El formato es projects/PROJECT_ID/locations/LOC_ID.

input_config

ImportProductSetsInputConfig

El contenido de entrada de la lista de solicitudes.

ImportProductSetsResponse

Mensaje de respuesta del método ImportProductSets.

Este mensaje lo devuelve el método google.longrunning.Operations.GetOperation en el campo google.longrunning.Operation.response devuelto.

Campos
reference_images[]

ReferenceImage

Lista de reference_images que se han importado correctamente.

statuses[]

Status

El estado de RPC de cada solicitud ImportProductSet, incluidos los éxitos y los errores.

El número de estados que se muestran aquí coincide con el número de líneas del archivo CSV. Además, statuses[i] almacena el estado de éxito o de error del procesamiento de la línea i-ésima del archivo CSV, empezando por la línea 0.

InputConfig

La ubicación de entrada y los metadatos que quieras.

Campos
gcs_source

GcsSource

Ubicación de Google Cloud Storage desde la que se leerá la entrada.

content

bytes

Contenido del archivo, representado como un flujo de bytes. Nota: Al igual que con todos los campos bytes, los protobuffers usan una representación binaria pura, mientras que las representaciones JSON usan base64.

Por el momento, este campo solo funciona en las solicitudes BatchAnnotateFiles. No funciona con las solicitudes AsyncBatchAnnotateFiles.

mime_type

string

El tipo de archivo. Actualmente, solo se admiten "application/pdf", "image/tiff" e "image/gif". No se admiten comodines.

LatLongRect

Rectángulo determinado por pares de valores mínimos y máximos LatLng.

Campos
min_lat_lng

LatLng

Par de latitud y longitud mínimo.

max_lat_lng

LatLng

Par de latitud y longitud máximo.

Likelihood

Representación en contenedores de la probabilidad, cuyo objetivo es ofrecer a los clientes resultados muy estables en las actualizaciones del modelo.

Enumeraciones
UNKNOWN Probabilidad desconocida.
VERY_UNLIKELY Es muy poco probable que la imagen pertenezca a la vertical especificada.
UNLIKELY Es poco probable que la imagen pertenezca al vertical especificado.
POSSIBLE Es posible que la imagen pertenezca a la vertical especificada.
LIKELY Es probable que la imagen pertenezca al vertical especificado.
VERY_LIKELY Es muy probable que la imagen pertenezca al vertical especificado.

ListProductSetsRequest

Mensaje de solicitud del método ListProductSets.

Campos
parent

string

Proyecto del que se deben enumerar los ProductSets.

El formato es projects/PROJECT_ID/locations/LOC_ID.

page_size

int32

Número máximo de elementos que se devolverán. El valor predeterminado es 10 y el máximo es 100.

page_token

string

El valor de next_page_token devuelto por una solicitud List anterior, si existe.

ListProductSetsResponse

Mensaje de respuesta del método ListProductSets.

Campos
product_sets[]

ProductSet

Lista de ProductSets.

next_page_token

string

Token para obtener la siguiente página de resultados. Si no hay más resultados en la lista, se devuelve un valor vacío.

ListProductsInProductSetRequest

Mensaje de solicitud del método ListProductsInProductSet.

Campos
name

string

Recurso ProductSet del que se van a obtener los productos.

El formato es projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.

page_size

int32

Número máximo de elementos que se devolverán. El valor predeterminado es 10 y el máximo es 100.

page_token

string

El valor de next_page_token devuelto por una solicitud List anterior, si existe.

ListProductsInProductSetResponse

Mensaje de respuesta del método ListProductsInProductSet.

Campos
products[]

Product

Lista de productos.

next_page_token

string

Token para obtener la siguiente página de resultados. Si no hay más resultados en la lista, se devuelve un valor vacío.

ListProductsRequest

Mensaje de solicitud del método ListProducts.

Campos
parent

string

Proyecto o ProductSet del que se deben enumerar los productos.

Formato: projects/PROJECT_ID/locations/LOC_ID

page_size

int32

Número máximo de elementos que se devolverán. El valor predeterminado es 10 y el máximo es 100.

page_token

string

El valor de next_page_token devuelto por una solicitud List anterior, si existe.

ListProductsResponse

Mensaje de respuesta del método ListProducts.

Campos
products[]

Product

Lista de productos.

next_page_token

string

Token para obtener la siguiente página de resultados. Si no hay más resultados en la lista, se devuelve un valor vacío.

ListReferenceImagesRequest

Mensaje de solicitud del método ListReferenceImages.

Campos
parent

string

Nombre de recurso del producto que contiene las imágenes de referencia.

El formato es projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

page_size

int32

Número máximo de elementos que se devolverán. El valor predeterminado es 10 y el máximo es 100.

page_token

string

Token que identifica la página de resultados que se va a devolver. Es el valor de nextPageToken devuelto en una solicitud de lista de imágenes de referencia anterior.

Si no se especifica, el valor predeterminado será la primera página.

ListReferenceImagesResponse

Mensaje de respuesta del método ListReferenceImages.

Campos
reference_images[]

ReferenceImage

Lista de imágenes de referencia.

page_size

int32

Número máximo de elementos que se devolverán. El valor predeterminado es 10 y el máximo es 100.

next_page_token

string

El valor de next_page_token devuelto por una solicitud List anterior, si existe.

LocalizedObjectAnnotation

Conjunto de objetos detectados con cuadros delimitadores.

Campos
mid

string

ID de objeto que debe coincidir con el MID de EntityAnnotation.

language_code

string

Se trata del código de idioma BCP-47, como "en-US" o "sr-Latn". Para obtener más información, consulta http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

name

string

Nombre del objeto, expresado en el idioma language_code.

score

float

Puntuación del resultado. Intervalo [0, 1].

bounding_poly

BoundingPoly

Región de la imagen a la que pertenece este objeto. Este campo es obligatorio.

LocationInfo

Información de la ubicación de la entidad detectada.

Campos
lat_lng

LatLng

Coordenadas de latitud y longitud de la ubicación.

NormalizedVertex

Un vértice representa un punto 2D de la imagen. NOTA: Las coordenadas de los vértices normalizadas son relativas a la imagen original y están comprendidas entre 0 y 1.

Campos
x

float

Coordenada X.

y

float

Coordenada Y.

OperationMetadata

Contiene metadatos de la operación BatchAnnotateImages.

Campos
state
(deprecated)

State

Estado actual de la operación por lotes.

create_time

Timestamp

La hora en la que se recibió la solicitud por lotes.

update_time

Timestamp

Hora a la que se actualizó el resultado de la operación por última vez.

Estado

Estados de las operaciones por lotes.

Enumeraciones
STATE_UNSPECIFIED No es válida.
CREATED Solicitud recibida.
RUNNING La solicitud se está procesando.
DONE El procesamiento por lotes se ha completado.
CANCELLED Se ha cancelado el procesamiento por lotes.

OutputConfig

La ubicación de salida y los metadatos que quieras.

Campos
gcs_destination

GcsDestination

Ubicación de Google Cloud Storage en la que se escribirán los resultados.

batch_size

int32

Número máximo de protos de respuesta que se pueden incluir en cada archivo JSON de salida de Google Cloud Storage. El intervalo válido es [1, 100]. Si no se especifica, el valor predeterminado es 20.

Por ejemplo, en el caso de un archivo PDF de 100 páginas, se generarán 100 protos de respuesta. Si batch_size = 20, se escribirán 5 archivos JSON, cada uno de ellos con 20 protos de respuesta, con el prefijo gcs_destination.uri.

Actualmente, batch_size solo se aplica a GcsDestination, pero es posible que se admita en otras configuraciones de salida en el futuro.

Página

Página detectada mediante OCR.

Campos
property

TextProperty

Se ha detectado información adicional en la página.

width

int32

Ancho de la página. En el caso de los PDFs, la unidad son puntos. En el caso de las imágenes (incluidos los TIFFs), la unidad son los píxeles.

height

int32

Altura de la página. En el caso de los PDFs, la unidad son puntos. En el caso de las imágenes (incluidos los TIFFs), la unidad son los píxeles.

blocks[]

Block

Lista de bloques de texto, imágenes, etc. de esta página.

confidence

float

Confianza de los resultados de OCR en la página. Intervalo [0, 1].

Párrafo

Unidad estructural de texto que representa un número de palabras en un orden determinado.

Campos
property

TextProperty

Información adicional detectada en el párrafo.

bounding_box

BoundingPoly

El cuadro delimitador del párrafo. Los vértices se indican en el siguiente orden: superior izquierda, superior derecha, inferior derecha e inferior izquierda. Cuando se detecta una rotación del cuadro delimitador, se representa alrededor de la esquina superior izquierda, tal como se define cuando el texto se lee en la orientación "natural". Por ejemplo: * Si el texto es horizontal, podría tener este aspecto: 0----1 | | 3----2 * Si se gira 180 grados alrededor de la esquina superior izquierda, se convierte en: 2----3 | | 1----0 y el orden de los vértices seguirá siendo (0, 1, 2, 3).

words[]

Word

Lista de palabras de este párrafo.

confidence

float

Confianza de los resultados de OCR del párrafo. Intervalo [0, 1].

Posición

Una posición 3D en la imagen, que se usa principalmente para los puntos de referencia de la detección de caras. Una posición válida debe tener coordenadas x e y. Las coordenadas de posición están en la misma escala que la imagen original.

Campos
x

float

Coordenada X.

y

float

Coordenada Y.

z

float

Coordenada Z (o profundidad).

Producto

Un producto contiene ReferenceImages.

Campos
name

string

Nombre de recurso del producto.

El formato es projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

Este campo se ignora al crear un producto.

display_name

string

Nombre que ha proporcionado el usuario para este producto. No puede estar vacío. Debe tener 4096 caracteres como máximo.

description

string

Metadatos proporcionados por el usuario que se almacenarán con este producto. Debe tener 4096 caracteres como máximo.

product_category

string

Categoría del producto identificado por la imagen de referencia. Debe ser "homegoods-v2", "apparel-v2", "toys-v2" o "packagedgoods-v1". Las categorías antiguas "homegoods", "apparel" y "toys" siguen estando disponibles, pero quedarán obsoletas. En el caso de los productos nuevos, utilice "homegoods-v2", "apparel-v2" o "toys-v2" para que la búsqueda de productos sea más precisa. También se recomienda migrar los productos que ya tenga a estas categorías.

Este campo no se puede modificar.

product_labels[]

KeyValue

Pares clave-valor que se pueden adjuntar a un producto. En el momento de la consulta, se pueden especificar restricciones basadas en product_labels.

Ten en cuenta que los valores enteros se pueden proporcionar como cadenas; por ejemplo, "1199". Solo las cadenas con valores enteros pueden coincidir con una restricción basada en intervalos, que se admitirá próximamente.

Se pueden asignar varios valores a la misma clave. Un producto puede tener hasta 100 valores de product_label.

KeyValue

Una etiqueta de producto representada como un par clave-valor.

Campos
key

string

Clave de la etiqueta adjunta al producto. No puede estar vacío y no puede superar los 128 bytes.

value

string

Valor de la etiqueta asociada al producto. No puede estar vacío y no puede superar los 128 bytes.

ProductSearchParams

Parámetros de una solicitud de búsqueda de productos.

Campos
bounding_poly

BoundingPoly

Polígono delimitador alrededor del área de interés de la imagen. Opcional. Si no se especifica, se aplicará el criterio del sistema.

product_set

string

Nombre de recurso de un ProductSet para buscar imágenes similares.

El formato es projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.

product_categories[]

string

Lista de categorías de productos en las que se buscará. Por el momento, solo tenemos en cuenta la primera categoría y debe especificarse "homegoods-v2", "apparel-v2" o "toys-v2". Las categorías antiguas "homegoods", "apparel" y "toys" siguen estando disponibles, pero quedarán obsoletas. En el caso de los productos nuevos, utilice "homegoods-v2", "apparel-v2" o "toys-v2" para mejorar la precisión de la búsqueda de productos. También se recomienda migrar los productos que ya tenga a estas categorías.

filter

string

La expresión de filtrado. Se puede usar para restringir los resultados de búsqueda en función de las etiquetas de producto. Actualmente, admitimos una expresión AND de OR de pares clave-valor, donde cada expresión de una OR debe tener la misma clave. Se debe usar el signo "=" para conectar la clave y el valor.

Por ejemplo, "(color = rojo OR color = azul) AND marca = Google" es aceptable, pero "(color = rojo OR marca = Google)" no lo es. "color: red" no es aceptable porque usa ":" en lugar de "=".

ProductSearchResults

Resultados de una solicitud de búsqueda de producto.

Campos
index_time

Timestamp

Marca de tiempo del índice que ha proporcionado estos resultados. Los productos que se hayan añadido o quitado del conjunto de productos después de esa hora no se reflejarán en los resultados actuales.

results[]

Result

Lista de resultados, uno por cada producto coincidente.

product_grouped_results[]

GroupedResult

Lista de resultados agrupados por los productos detectados en la imagen de la consulta. Cada entrada corresponde a un polígono envolvente de la imagen de consulta y contiene los productos coincidentes específicos de esa región. Puede haber coincidencias de productos duplicadas en la unión de todos los resultados por producto.

GroupedResult

Información sobre los productos similares a un solo producto de una imagen de consulta.

Campos
bounding_poly

BoundingPoly

El polígono delimitador que rodea el producto detectado en la imagen de consulta.

results[]

Result

Lista de resultados, uno por cada producto coincidente.

Resultado

Información sobre un producto.

Campos
product

Product

El Producto.

score

float

Nivel de confianza de la coincidencia, que va de 0 (sin confianza) a 1 (confianza total).

image

string

Nombre de recurso de la imagen del producto que más se ajusta a la consulta.

ProductSet

Un ProductSet contiene Products. Un ProductSet puede contener un máximo de 1 millón de imágenes de referencia. Si se supera el límite, la indexación periódica fallará.

Campos
name

string

Nombre de recurso de ProductSet.

El formato es projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.

Este campo se ignora al crear un ProductSet.

display_name

string

Nombre proporcionado por el usuario para este ProductSet. No puede estar vacío. Debe tener 4096 caracteres como máximo.

index_time

Timestamp

Solo de salida. Hora a la que se indexó este ProductSet por última vez. Los resultados de la consulta reflejarán todas las actualizaciones anteriores a esa hora. Si este ProductSet nunca se ha indexado, esta marca de tiempo es el valor predeterminado "1970-01-01T00:00:00Z".

Este campo se ignora al crear un ProductSet.

index_error

Status

Solo de salida. Si se ha producido un error al indexar el conjunto de productos, se rellenará este campo.

Este campo se ignora al crear un ProductSet.

Propiedad

Un Property consta de un par nombre/valor proporcionado por el usuario.

Campos
name

string

Nombre de la propiedad.

value

string

Valor de la propiedad.

uint64_value

uint64

Valor de las propiedades numéricas.

ReferenceImage

Un ReferenceImage representa una imagen de producto y sus metadatos asociados, como los cuadros delimitadores.

Campos
name

string

Nombre de recurso de la imagen de referencia.

El formato es el siguiente:

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

Este campo se ignora al crear una imagen de referencia.

uri

string

El URI de Google Cloud Storage de la imagen de referencia.

El URI debe empezar por gs://.

Obligatorio.

bounding_polys[]

BoundingPoly

Polígonos delimitadores alrededor de las áreas de interés de la imagen de referencia. Opcional. Si este campo está vacío, el sistema intentará detectar las regiones de interés. Se usarán 10 polígonos envolventes como máximo.

La forma proporcionada se convierte en un rectángulo sin rotación. Una vez convertida, el lado más pequeño del rectángulo debe ser igual o superior a 300 píxeles. La relación de aspecto debe ser de 1:4 o inferior (por ejemplo, 1:3 es aceptable, pero 1:5 no).

RemoveProductFromProductSetRequest

Mensaje de solicitud del método RemoveProductFromProductSet.

Campos
name

string

Nombre de recurso del ProductSet que se va a modificar.

El formato es projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.

product

string

Nombre de recurso del producto que se va a quitar de este ProductSet.

El formato es projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

SafeSearchAnnotation

Conjunto de funciones relacionadas con la imagen, calculadas mediante métodos de visión artificial en verticales de búsqueda segura (por ejemplo, contenido para adultos, falsificaciones, contenido médico o violencia).

Campos
adult

Likelihood

Representa la probabilidad de que la imagen incluya contenido para adultos. El contenido para adultos puede incluir elementos como desnudos, imágenes o dibujos pornográficos, o actividades sexuales.

spoof

Likelihood

Probabilidad de suplantación. Probabilidad de que se haya modificado la versión canónica de la imagen para que parezca divertida u ofensiva.

medical

Likelihood

Probabilidad de que se trate de una imagen médica.

violence

Likelihood

Probabilidad de que esta imagen incluya contenido violento.

racy

Likelihood

Probabilidad de que la imagen de la solicitud incluya contenido subido de tono. El contenido subido de tono puede incluir, entre otros, ropa escasa o transparente, desnudos cubiertos estratégicamente, posturas lascivas o provocativas, o primeros planos de zonas sensibles del cuerpo.

Símbolo

Representación de un solo símbolo.

Campos
property

TextProperty

Se ha detectado información adicional sobre el símbolo.

bounding_box

BoundingPoly

Cuadro delimitador del símbolo. Los vértices se indican en el siguiente orden: superior izquierda, superior derecha, inferior derecha e inferior izquierda. Cuando se detecta una rotación del cuadro delimitador, se representa alrededor de la esquina superior izquierda, tal como se define cuando el texto se lee en la orientación "natural". Por ejemplo: * Si el texto es horizontal, podría tener este aspecto: 0----1 | | 3----2 * Si se gira 180 grados alrededor de la esquina superior izquierda, se convierte en: 2----3 | | 1----0 y el orden de los vértices seguirá siendo (0, 1, 2, 3).

text

string

La representación UTF-8 real del símbolo.

confidence

float

Confianza de los resultados de OCR del símbolo. Intervalo [0, 1].

TextAnnotation

TextAnnotation contiene una representación estructurada del texto extraído mediante OCR. La jerarquía de una estructura de texto extraída por OCR es la siguiente: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol. Cada componente estructural, empezando por Page, puede tener sus propias propiedades. Las propiedades describen los idiomas detectados, los saltos, etc. Consulta la TextAnnotation.TextPropertydefinición del mensaje que aparece más abajo para obtener más información.

Campos
pages[]

Page

Lista de páginas detectadas por OCR.

text

string

Se ha detectado texto UTF-8 en las páginas.

DetectedBreak

Se ha detectado el inicio o el final de un componente estructural.

Campos
type

BreakType

Tipo de salto detectado.

is_prefix

bool

Devuelve el valor true si el salto precede al elemento.

BreakType

Enum para indicar el tipo de salto encontrado. Nueva línea, espacio, etc.

Enumeraciones
UNKNOWN Tipo de etiqueta de salto desconocido.
SPACE Espacio normal.
SURE_SPACE Espacio seguro (muy amplio).
EOL_SURE_SPACE Salto de ajuste de línea.
HYPHEN Guion de final de línea que no está presente en el texto. No se da simultáneamente con SPACE, LEADER_SPACE ni LINE_BREAK.
LINE_BREAK Salto de línea que termina un párrafo.

Idioma detectado

Idioma detectado de un componente estructural.

Campos
language_code

string

Se trata del código de idioma BCP-47, como "en-US" o "sr-Latn". Para obtener más información, consulta http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

confidence

float

Confianza del idioma detectado. Intervalo [0, 1].

TextProperty

Se ha detectado información adicional en el componente estructural.

Campos
detected_languages[]

DetectedLanguage

Lista de idiomas detectados junto con la confianza.

detected_break

DetectedBreak

Se ha detectado el inicio o el final de un segmento de texto.

UpdateProductRequest

Mensaje de solicitud del método UpdateProduct.

Campos
product

Product

El recurso de producto que sustituye al del servidor. product.name es inmutable.

update_mask

FieldMask

El FieldMask que especifica qué campos se van a actualizar. Si no se especifica update_mask, se actualizarán todos los campos mutables. Las rutas de máscara válidas son product_labels, display_name y description.

UpdateProductSetRequest

Mensaje de solicitud del método UpdateProductSet.

Campos
product_set

ProductSet

El recurso ProductSet que sustituye al del servidor.

update_mask

FieldMask

El FieldMask que especifica qué campos se van a actualizar. Si no se especifica update_mask, se actualizarán todos los campos mutables. La ruta de máscara válida es display_name.

Vertex

Un vértice representa un punto 2D de la imagen. NOTA: Las coordenadas de los vértices están en la misma escala que la imagen original.

Campos
x

int32

Coordenada X.

y

int32

Coordenada Y.

WebDetection

Información relevante sobre la imagen de Internet.

Campos
web_entities[]

WebEntity

Entidades deducidas a partir de imágenes similares en Internet.

full_matching_images[]

WebImage

Imágenes que coinciden totalmente de Internet. Puede incluir copias de la imagen de consulta con un tamaño diferente.

partial_matching_images[]

WebImage

Imágenes coincidentes parciales de Internet. Esas imágenes son lo suficientemente similares como para compartir algunas características de puntos clave. Por ejemplo, es probable que una imagen original tenga coincidencias parciales con sus recortes.

pages_with_matching_images[]

WebPage

Páginas web que contienen las imágenes coincidentes de Internet.

visually_similar_images[]

WebImage

Los resultados de imágenes visualmente similares.

best_guess_labels[]

WebLabel

La mejor estimación del servicio sobre el tema de la imagen solicitada. Se infiere a partir de imágenes similares de la Web abierta.

WebEntity

Entidad deducida a partir de imágenes similares en Internet.

Campos
entity_id

string

ID de entidad opaco.

score

float

Puntuación de relevancia general de la entidad. No está normalizada y no se puede comparar entre diferentes consultas de imágenes.

description

string

Descripción canónica de la entidad en inglés.

WebImage

Metadatos de imágenes online.

Campos
url

string

URL de la imagen de resultado.

score

float

(Obsoleto) Puntuación de relevancia general de la imagen.

WebLabel

Etiqueta para proporcionar metadatos adicionales para la detección web.

Campos
label

string

Etiqueta de metadatos adicionales.

language_code

string

El código de idioma BCP-47 de label, como "en-US" o "sr-Latn". Para obtener más información, consulta http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

WebPage

Metadatos de páginas web.

Campos
url

string

La URL de la página web de resultados.

score

float

(Obsoleto) Puntuación de relevancia general de la página web.

page_title

string

Título de la página web. Puede contener marcas HTML.

full_matching_images[]

WebImage

Imágenes de la página que coinciden por completo. Puede incluir copias de la imagen de consulta con un tamaño diferente.

partial_matching_images[]

WebImage

Imágenes de la página que coinciden parcialmente. Esas imágenes son lo suficientemente similares como para compartir algunas características de puntos clave. Por ejemplo, es probable que una imagen original tenga coincidencias parciales con sus recortes.

WebDetectionParams

Parámetros de la solicitud de detección web.

Campos
include_geo_results

bool

Indica si se deben incluir los resultados derivados de la información geográfica de la imagen.

Word

Representación de una palabra.

Campos
property

TextProperty

Se ha detectado información adicional sobre la palabra.

bounding_box

BoundingPoly

El cuadro delimitador de la palabra. Los vértices se indican en el siguiente orden: superior izquierda, superior derecha, inferior derecha e inferior izquierda. Cuando se detecta una rotación del cuadro delimitador, se representa alrededor de la esquina superior izquierda, tal como se define cuando el texto se lee en la orientación "natural". Por ejemplo: * Si el texto es horizontal, podría tener este aspecto: 0----1 | | 3----2 * Si se gira 180 grados alrededor de la esquina superior izquierda, se convierte en: 2----3 | | 1----0 y el orden de los vértices seguirá siendo (0, 1, 2, 3).

symbols[]

Symbol

Lista de símbolos de la palabra. El orden de los símbolos sigue el orden de lectura natural.

confidence

float

Confianza de los resultados de OCR de la palabra. Intervalo [0, 1].