Package google.cloud.vision.v1p3beta1

Índice

ImageAnnotator

Servicio que realiza tareas de detección de la API de Google Cloud Vision a través de imágenes de clientes, como detección de rostros, puntos de referencia, logotipos, etiquetas y texto. El servicio ImageAnnotator muestra entidades detectadas a partir de las imágenes.

AsyncBatchAnnotateFiles

rpc AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest) returns (Operation)

Ejecuta la detección y anotación asíncrona de imágenes para obtener 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 recuperar mediante la interfaz google.longrunning.Operations. Operation.metadata contiene OperationMetadata (metadatos). Operation.response contiene AsyncBatchAnnotateFilesResponse (resultados).

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

BatchAnnotateImages

rpc BatchAnnotateImages(BatchAnnotateImagesRequest) returns (BatchAnnotateImagesResponse)

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

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

ProductSearch

Administra Products y ProductSets de imágenes de referencia para usar en la búsqueda de productos. Usa el siguiente modelo de recursos:

  • La API tiene una colección de recursos ProductSet, llamada projects/*/locations/*/productSets/*, que actúa como una forma de agrupar productos diferentes en grupos para limitar la identificación.

Al mismo tiempo,

  • 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)

Agrega un Product al ProductSet especificado. Si el Product ya está presente, no se realizará ningún cambio.

Se puede agregar un Producto a 100 ProductSets como máximo.

A continuación, se indican los posibles errores:

  • Muestra NOT_FOUND si el Product o el ProductSet no existe.
Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

CreateProduct

rpc CreateProduct(CreateProductRequest) returns (Product)

Crea y muestra un recurso de producto nuevo.

A continuación, se indican los posibles errores:

  • Muestra INVALID_ARGUMENT si falta un display_name o tiene más de 4,096 caracteres.
  • Muestra INVALID_ARGUMENT si la descripción supera los 4,096 caracteres.
  • Muestra INVALID_ARGUMENT si falta el campo product_category o no es válido.
Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

CreateProductSet

rpc CreateProductSet(CreateProductSetRequest) returns (ProductSet)

Crea y muestra un recurso ProductSet nuevo.

A continuación, se indican los posibles errores:

  • Muestra INVALID_ARGUMENT si falta el display_name o tiene más de 4,096 caracteres.
Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

CreateReferenceImage

rpc CreateReferenceImage(CreateReferenceImageRequest) returns (ReferenceImage)

Crea y muestra un recurso ReferenceImage nuevo.

El campo bounding_poly es opcional. Si no se especifica bounding_poly, el sistema intentará detectar las regiones de interés en la imagen que sean compatibles con el product_category en el producto superior. Si se especifica, la detección se realiza en SIEMPRE omitida. El sistema convierte los polígonos en rectángulos no rotados.

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

A continuación, se indican los posibles errores:

  • Muestra INVALID_ARGUMENT si falta el valor image_uri o es superior a 4,096 caracteres.
  • Muestra INVALID_ARGUMENT si el producto no existe.
  • Muestra INVALID_ARGUMENT si no se proporciona bounding_poly y no se detecta nada compatible con el product_category del producto superior.
  • Muestra INVALID_ARGUMENT si bounding_poly contiene más de 10 polígonos.
Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

DeleteProduct

rpc DeleteProduct(DeleteProductRequest) returns (Empty)

Borra de manera permanente un producto y sus imágenes de referencia.

Se borrarán inmediatamente los metadatos del producto y todas sus imágenes, pero las búsquedas en los ProductSets que contengan el producto aún funcionarán hasta que se actualicen todas las memorias caché relacionadas.

A continuación, se indican los posibles errores:

  • Muestra NOT_FOUND si el producto no existe.
Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

DeleteProductSet

rpc DeleteProductSet(DeleteProductSetRequest) returns (Empty)

Borra de manera permanente un ProductSet Los Products y los ReferenceImages del ProductSet no se borran.

Los archivos de imagen reales no se borran de Google Cloud Storage.

A continuación, se indican los posibles errores:

  • Muestra NOT_FOUND si el ProductSet no existe.
Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

DeleteReferenceImage

rpc DeleteReferenceImage(DeleteReferenceImageRequest) returns (Empty)

Borra de forma permanente una imagen de referencia

Los metadatos de la imagen se borrarán de inmediato, pero las búsquedas en los ProductSets que contengan la imagen podrían funcionar hasta que se actualicen todas las cachés relacionadas.

Los archivos de imagen reales no se borran de Google Cloud Storage.

A continuación, se indican los posibles errores:

  • Muestra NOT_FOUND si la imagen de referencia no existe.
Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

GetProduct

rpc GetProduct(GetProductRequest) returns (Product)

Obtiene información asociada con un Product.

A continuación, se indican los posibles errores:

  • Muestra NOT_FOUND si el Producto no existe.
Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

GetProductSet

rpc GetProductSet(GetProductSetRequest) returns (ProductSet)

Obtiene información asociada con un ProductSet.

A continuación, se indican los posibles errores:

  • Muestra NOT_FOUND si el ProductSet no existe.
Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

GetReferenceImage

rpc GetReferenceImage(GetReferenceImageRequest) returns (ReferenceImage)

Obtiene información asociada a ReferenceImage.

A continuación, se indican los posibles errores:

  • Muestra NOT_FOUND si la imagen de referencia no existe.
Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

Para obtener más información, consulta 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 específicos según una lista de información de las imágenes.

La API google.longrunning.Operation se puede usar para realizar un seguimiento del 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 obtener más información sobre el formato de archivo CSV, consulta ImportProductSetsGcsSource.csv_file_uri.

Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

Para obtener más información, consulta 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:

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

Se necesita uno de los siguientes alcances de OAuth:

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

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

ListProducts

rpc ListProducts(ListProductsRequest) returns (ListProductsResponse)

Muestra una lista de productos en un orden no especificado.

A continuación, se indican los posibles errores:

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

Se necesita uno de los siguientes alcances de OAuth:

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

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

ListProductsInProductSet

rpc ListProductsInProductSet(ListProductsInProductSetRequest) returns (ListProductsInProductSetResponse)

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

A continuación, se indican los posibles errores:

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

Se necesita uno de los siguientes alcances de OAuth:

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

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

ListReferenceImages

rpc ListReferenceImages(ListReferenceImagesRequest) returns (ListReferenceImagesResponse)

Enumera imágenes de referencia.

A continuación, se indican los posibles errores:

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

Se necesita uno de los siguientes alcances de OAuth:

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

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

RemoveProductFromProductSet

rpc RemoveProductFromProductSet(RemoveProductFromProductSetRequest) returns (Empty)

Quita un Product del ProductSet especificado.

A continuación, se indican los posibles errores:

  • Muestra NOT_FOUND si el Product no se encuentra en el ProductSet.
Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

UpdateProduct

rpc UpdateProduct(UpdateProductRequest) returns (Product)

Realiza cambios en un recurso del Product. Solo los campos display_name, description y labels se pueden actualizar en este momento.

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:

  • Muestra NOT_FOUND si el Producto no existe.
  • Muestra INVALID_ARGUMENT si el display_name está presente en update_mask, pero no está en la solicitud o supera los 4,096 caracteres.
  • Muestra INVALID_ARGUMENT si la descripción está presente en update_mask, pero supera los 4,096 caracteres.
  • Muestra INVALID_ARGUMENT si product_category está presente en update_mask.
Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

UpdateProductSet

rpc UpdateProductSet(UpdateProductSetRequest) returns (ProductSet)

Realiza cambios en un recurso ProductSet. Solo se puede actualizar display_name actualmente.

A continuación, se indican los posibles errores:

  • Muestra NOT_FOUND si el ProductSet no existe.
  • Muestra INVALID_ARGUMENT si display_name está presente en update_mask, pero no está en la solicitud o supera los 4,096 caracteres.
Alcances de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

AddProductToProductSetRequest

Mensaje de la solicitud para el método AddProductToProductSet.

Campos
name

string

Es el nombre del recurso que se debe modificar para el ProductSet.

Formato: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

product

string

Es el nombre del Product que se agregará al ProductSet.

Formato: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

AnnotateFileResponse

Respuesta a una solicitud de anotación de archivo único. Un archivo puede contener una o más imágenes, que tienen sus propias respuestas individuales.

Campos
input_config

InputConfig

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

responses[]

AnnotateImageResponse

Respuestas individuales a las imágenes que se encuentran en el archivo.

AnnotateImageRequest

Solicitud para realizar tareas de la API de Google Cloud Vision con una imagen proporcionada por el usuario, con funciones solicitadas por el usuario.

Campos
image

Image

La imagen que se 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 de rostro se completó correctamente.

landmark_annotations[]

EntityAnnotation

Si está presente, la detección de punto de referencia se completó correctamente.

logo_annotations[]

EntityAnnotation

Si está presente, la detección de logotipo se completó correctamente.

label_annotations[]

EntityAnnotation

Si está presente, la detección de etiquetas se completó correctamente.

localized_object_annotations[]

LocalizedObjectAnnotation

Si está presente, la detección de objetos localizados se completó correctamente. Esto se ordenará de forma descendente por puntuación de confianza.

text_annotations[]

EntityAnnotation

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

full_text_annotation

TextAnnotation

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

safe_search_annotation

SafeSearchAnnotation

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

image_properties_annotation

ImageProperties

Si está presente, se extrajeron las propiedades de imagen correctamente.

crop_hints_annotation

CropHintsAnnotation

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

web_detection

WebDetection

Si está presente, la detección de web se completó correctamente.

product_search_results

ProductSearchResults

Si está presente, la búsqueda de productos se completó correctamente.

error

Status

Si se configura, representa el mensaje de error de la operación. Ten en cuenta que se garantiza que las anotaciones de imagen completadas sean correctas, incluso cuando se establece error.

context

ImageAnnotationContext

Si está presente, se necesita información contextual para comprender de dónde proviene esta 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 en el archivo.

output_config

OutputConfig

Obligatorio. La ubicación de salida y los metadatos deseados (p. ej., el formato).

AsyncAnnotateFileResponse

La respuesta para una única solicitud de anotación de archivos sin conexión.

Campos
output_config

OutputConfig

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

AsyncBatchAnnotateFilesRequest

Las distintas solicitudes de anotación de archivos asíncronos se agrupan en una sola llamada de servicio.

Campos
requests[]

AsyncAnnotateFileRequest

Solicitudes de anotaciones de archivos asíncronos individuales para este lote.

AsyncBatchAnnotateFilesResponse

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

Campos
responses[]

AsyncAnnotateFileResponse

La lista de respuestas de anotación de archivos, una para cada solicitud en AsyncBatchAnnotateFilesRequest.

BatchAnnotateImagesRequest

Las solicitudes de anotaciones de imágenes se agrupan en una sola llamada de servicio.

Campos
requests[]

AnnotateImageRequest

Solicitudes de anotación de imágenes individuales para 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 dentro del lote.

BatchOperationMetadata

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

Esto se incluye en el campo metadata de la Operation que muestra la llamada GetOperation del servicio google::longrunning::Operations.

Campos
state

State

El estado actual de la operación por lotes.

submit_time

Timestamp

La hora a la que se envió la solicitud por lotes al servidor.

end_time

Timestamp

La hora a la que finaliza la solicitud por lotes y google.longrunning.Operation.done se establece como verdadero.

Estado

Enumera los estados posibles en los que se puede encontrar la solicitud por lotes.

Enums
STATE_UNSPECIFIED No válido.
PROCESSING La solicitud se está procesando de forma activa.
SUCCESSFUL La solicitud está lista y al menos un elemento se procesó de manera correcta.
FAILED La solicitud se completó y no se procesó ningún elemento.
CANCELLED La solicitud se completó después de que el usuario llamó a longrunning.Operations.CancelOperation. Cualquier registro que se procesó antes del comando de cancelación se muestra como se especifica en la solicitud.

Bloquear

Elemento lógico en la página.

Campos
property

TextProperty

Se detectó información adicional para el bloque.

bounding_box

BoundingPoly

El cuadro de límite del bloque. Los vértices están en el orden de la parte superior izquierda, la parte superior derecha, la parte inferior derecha y la parte inferior izquierda. Cuando se detecta una rotación del cuadro de límite, esta se representa como alrededor de la esquina superior izquierda, según se define cuando el texto se lee en la orientación “natural”. Por ejemplo:

  • Cuando el texto sea horizontal, podría verse de la siguiente manera:
    0----1
    |    |
    3----2
  • Cuando se rota 180 grados alrededor de la esquina superior izquierda, se convierte en:
    2----3
    |    |
    1----0

y el orden de vértices se mantendrá como (0, 1, 2, 3).

paragraphs[]

Paragraph

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

block_type

BlockType

Se detectó un tipo de bloque (texto, imagen, etc.) para este bloque.

confidence

float

La confianza de los resultados de OCR en el bloque. Rango [0, 1].

BlockType

Tipo de bloque (texto, imagen, etc.) que identifica el OCR.

Enums
UNKNOWN Tipo de bloqueo desconocido.
TEXT Bloque de texto común.
TABLE Bloque de tabla.
PICTURE Bloque de imagen.
RULER Cuadro de línea horizontal/vertical.
BARCODE Bloque de código de barras.

BoundingPoly

Un polígono de límite para la anotación de imagen detectada.

Campos
vertices[]

Vertex

Vértices del polígono de límite.

normalized_vertices[]

NormalizedVertex

Vértices normalizados del polígono de límite.

ColorInfo

La información de color está compuesta por los canales RGB, la puntuación y la fracción de la imagen que el color ocupa 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 rango [0, 1].

pixel_fraction

float

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

CreateProductRequest

Mensaje de la solicitud para el método CreateProduct.

Campos
parent

string

El proyecto en el que se debe crear el Product.

El formato es projects/PROJECT_ID/locations/LOC_ID.

product

Product

El producto que se creará.

product_id

string

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

CreateProductSetRequest

Mensaje de la solicitud para el método CreateProductSet.

Campos
parent

string

El proyecto en el que se debe crear el ProductSet.

El formato es projects/PROJECT_ID/locations/LOC_ID.

product_set

ProductSet

El ProductSet que se creará.

product_set_id

string

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

CreateReferenceImageRequest

Mensaje de la solicitud para el método CreateReferenceImage.

Campos
parent

string

Nombre del recurso en el que se creará la imagen de referencia.

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

reference_image

ReferenceImage

La imagen de referencia que se creará. Si se especifica un ID de imagen, se ignora.

reference_image_id

string

Un ID de recurso proporcionado por el usuario para que se agregue la ReferenceImage. Si se configura, el servidor intentará usar este valor como el ID del recurso. Si ya está en uso, se muestra un error con el código ALREADY_EXISTS. Debe tener como máximo 128 caracteres. No puede contener el carácter /.

CropHint

Sugerencia de recorte única que se utiliza para generar un nuevo recorte cuando se entrega una imagen.

Campos
bounding_poly

BoundingPoly

El polígono de límite para la región de recorte. Las coordenadas del cuadro de límite están en la escala de la imagen original, como se muestra en ImageParams.

confidence

float

La confianza de que esto sea una región destacada. Rango [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 cuando se entregan imágenes.

Campos
crop_hints[]

CropHint

Resultados de la sugerencia de recorte.

CropHintsParams

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

Campos
aspect_ratios[]

float

Las relaciones de aspecto en números de punto flotante, que representan la proporción del ancho y la altura de la imagen. Por ejemplo, si la relación de aspecto deseada es 4/3, el valor flotante correspondiente debe ser 1.33333. Si no se especifica, se muestra el mejor recorte posible. La cantidad de relaciones de aspecto proporcionadas se limita a un máximo de 16. Se ignoran todas las relaciones de aspecto proporcionadas después de la decimosexta.

DeleteProductRequest

Mensaje de la solicitud para el método DeleteProduct.

Campos
name

string

Nombre del recurso que se borrará.

Formato: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

DeleteProductSetRequest

Mensaje de la solicitud para el método DeleteProductSet.

Campos
name

string

Nombre del ProductSet que se borrará.

Formato: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

DeleteReferenceImageRequest

Mensaje de la solicitud para el método DeleteReferenceImage.

Campos
name

string

El nombre del recurso de la imagen de referencia que se borrará.

Formato:

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

DominantColorsAnnotation

Conjunto de colores dominantes y sus puntuaciones correspondientes.

Campos
colors[]

ColorInfo

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

EntityAnnotation

Conjunto de atributos de la entidad detectada.

Campos
mid

string

ID de entidad opaca. Es posible que algunos ID estén disponibles en la API de búsqueda en el Gráfico de conocimiento de Google.

locale

string

El código de idioma de la configuración regional en la que se expresa la description textual de la entidad.

description

string

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

score

float

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

confidence
(deprecated)

float

Obsoleto. Utiliza score en lugar de esta función. La precisión de la detección de entidades en una imagen. Por ejemplo, en el caso de una imagen en la que se detecta la entidad "Torre Eiffel", este campo representa la confianza en que hay una altura en la imagen de la consulta. Rango [0, 1].

topicality

float

La relevancia de la etiqueta ICA (Anotación del contenido de la imagen) de la imagen. Por ejemplo, la relevancia de "torre" probablemente sea más alta para una imagen que contiene la "Torre Eiffel", que para una imagen que contiene un edificio alto alejado detectado, aunque la confianza en que exista una torre en cada imagen puede ser la misma. Rango [0, 1].

bounding_poly

BoundingPoly

Región de la imagen a la que pertenece esta entidad. No se produjo para características LABEL_DETECTION.

locations[]

LocationInfo

La información de ubicación para la entidad detectada. Es posible tener varios elementos LocationInfo, ya que una ubicación puede indicar la ubicación de la escena en la imagen, y otro puede indicar la ubicación del lugar donde se tomó la imagen. Por lo general, los puntos de referencia incluyen información de ubicación.

properties[]

Property

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

FaceAnnotation

Un objeto de anotación de rostros contiene los resultados de la detección de rostro.

Campos
bounding_poly

BoundingPoly

El polígono de límite en torno al rostro. Las coordenadas del cuadro de límite están en la escala de la imagen original, como se muestra en ImageParams. El cuadro de límite se calcula para “enmarcar” el rostro de acuerdo con las expectativas humanas. Se basa en los resultados del punto de referencia. Ten en cuenta que es posible que una o más coordenadas Y o X no se generen en BoundingPoly (el polígono no estará delimitado) si solo aparece un rostro parcial en la imagen para anotar.

fd_bounding_poly

BoundingPoly

El polígono de límite fd_bounding_poly es más pequeño que el de boundingPoly y abarca solo la parte de la piel del rostro. Por lo general, se usa para eliminar el rostro de cualquier análisis de imagen que detecte la “cantidad de piel” visible en una imagen. No se basa en los resultados del punto de referencia, solo en la detección inicial de rostros; esa es la razón del uso del

fd

prefijo (detección de rostro).

landmarks[]

Landmark

Puntos de referencia del rostro detectados.

roll_angle

float

El ángulo de alabeo, que indica la rotación en sentido horario/antihorario del rostro en relación con el eje vertical de la imagen perpendicular al rostro. Rango [-180,180].

pan_angle

float

El ángulo de guiñada, que indica el ángulo hacia la izquierda/derecha al que el rostro apunta en relación con el plano vertical perpendicular de la imagen. Rango [-180,180].

tilt_angle

float

El ángulo de cabeceo, que indica el ángulo hacia arriba/abajo al que el rostro apunta en relación con el plano horizontal de la imagen. Rango [-180,180].

detection_confidence

float

Confianza en la detección. Rango [0, 1].

landmarking_confidence

float

Confianza en la asignación de puntos de referencia del rostro. Rango [0, 1].

joy_likelihood

Likelihood

Probabilidad de alegría.

sorrow_likelihood

Likelihood

Probabilidad de tristeza.

anger_likelihood

Likelihood

Probabilidad de enojo.

surprise_likelihood

Likelihood

Probabilidad de sorpresa.

under_exposed_likelihood

Likelihood

Probabilidad de exposición.

blurred_likelihood

Likelihood

Probabilidad de desenfoque.

headwear_likelihood

Likelihood

Probabilidad de sombreros.

Punto de referencia

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

Campos
type

Type

Tipo de punto de referencia facial.

position

Position

Posición del punto de referencia facial.

Tipo

Tipo de punto de referencia facial (función). Izquierda y derecha se definen desde el punto de vista del usuario que mira la imagen sin considerar las proyecciones de espejo típicas de las fotos. Por lo tanto, LEFT_EYE, por lo general, es el ojo derecho de la persona.

Enums
UNKNOWN_LANDMARK Punto de referencia desconocido detectado en el rostro. No debe completarse.
LEFT_EYE Ojo izquierdo.
RIGHT_EYE Ojo derecho.
LEFT_OF_LEFT_EYEBROW Izquierda de la ceja izquierda.
RIGHT_OF_LEFT_EYEBROW Derecha de la ceja izquierda.
LEFT_OF_RIGHT_EYEBROW 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 Izquierda de la boca.
MOUTH_RIGHT Derecha de la boca.
MOUTH_CENTER Centro de la boca.
NOSE_BOTTOM_RIGHT Nariz, parte inferior derecha.
NOSE_BOTTOM_LEFT Nariz, parte inferior izquierda.
NOSE_BOTTOM_CENTER Nariz, parte inferior central.
LEFT_EYE_TOP_BOUNDARY Ojo izquierdo, límite superior.
LEFT_EYE_RIGHT_CORNER Ojo izquierdo, esquina derecha.
LEFT_EYE_BOTTOM_BOUNDARY Ojo izquierdo, límite inferior.
LEFT_EYE_LEFT_CORNER Ojo izquierdo, esquina izquierda.
RIGHT_EYE_TOP_BOUNDARY Ojo derecho, límite superior.
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 Ceja izquierda, punto medio superior.
RIGHT_EYEBROW_UPPER_MIDPOINT Ceja derecha, punto medio superior.
LEFT_EAR_TRAGION Tragión de la oreja izquierda.
RIGHT_EAR_TRAGION Tragión de la oreja derecha.
LEFT_EYE_PUPIL Pupila del ojo izquierdo.
RIGHT_EYE_PUPIL Pupila del ojo derecho.
FOREHEAD_GLABELLA Glabela de la frente.
CHIN_GNATHION Gnation del mentón.
CHIN_LEFT_GONION Gonion izquierdo del mentón.
CHIN_RIGHT_GONION Gonion derecho del mentón.

Función

El tipo de detección de la API de Google Cloud Vision que se debe realizar y la cantidad máxima de resultados que se mostrarán para ese tipo. Se pueden especificar varios objetos Feature en la lista features.

Campos
type

Type

El tipo de característica.

max_results

int32

Configura la cantidad máxima 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: "integrado/estable" (predeterminado si no se configura) y "integrado/más reciente".

Tipo

Tipo de característica de la API de Google Cloud Vision que se extraerá.

Enums
TYPE_UNSPECIFIED Tipo de característica no especificada.
FACE_DETECTION Ejecuta la detección de rostros.
LANDMARK_DETECTION Ejecutar la detección de puntos de referencia
LOGO_DETECTION Ejecutar la detección de logotipos.
LABEL_DETECTION Ejecutar la detección de etiquetas.
TEXT_DETECTION Ejecutar detección de texto / reconocimiento óptico de caracteres (OCR). La detección de texto está optimizada para áreas de texto dentro de una imagen más grande. Si la imagen es un documento, usa DOCUMENT_TEXT_DETECTION en su lugar.
DOCUMENT_TEXT_DETECTION Ejecuta el OCR de documentos de texto denso. Tiene prioridad cuando están presentes DOCUMENT_TEXT_DETECTION y TEXT_DETECTION.
SAFE_SEARCH_DETECTION Ejecuta Safe Search para detectar contenido inseguro o no deseado.
IMAGE_PROPERTIES Procesa un conjunto de propiedades de la imagen, como sus colores predominantes.
CROP_HINTS Ejecuta sugerencias de recorte.
WEB_DETECTION Ejecuta la detección web.
OBJECT_LOCALIZATION Ejecuta el localizador para detectar objetos.

GcsDestination

La ubicación de Google Cloud Storage en la que se escribe el resultado.

Campos
uri

string

URI de Google Cloud Storage donde se almacenarán los resultados. Los resultados estarán en formato JSON y precedidos por el URI de entrada correspondiente Este campo puede representar un solo archivo o un prefijo para varias salidas Los prefijos deben terminar en /.

Ejemplos:

Si hay varios resultados, cada respuesta sigue siendo AnnotateFileResponse, cada una de las cuales contiene algún subconjunto de la lista completa de AnnotateImageResponse. Es posible que se produzcan varios resultados si, por ejemplo, el resultado de JSON es demasiado grande y se desborda en varios archivos fragmentados.

GcsSource

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

Campos
uri

string

URI de Google Cloud Storage para el archivo de entrada. Este solo debe ser un objeto de Google Cloud Storage. Por el momento, no se admiten los comodines.

GetProductRequest

Mensaje de la solicitud para el método GetProduct.

Campos
name

string

Nombre del recurso del Product que se obtendrá.

Formato: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

GetProductSetRequest

Mensaje de la solicitud para el método GetProductSet.

Campos
name

string

Nombre del ProductSet que se debe obtener.

Formato: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.

GetReferenceImageRequest

Mensaje de la solicitud para el método GetReferenceImage.

Campos
name

string

El nombre del recurso de ReferenceImage que se debe obtener.

Formato:

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

Imagen

Imagen de cliente en la que se realizarán tareas de la API de Google Cloud Vision.

Campos
content

bytes

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

source

ImageSource

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

ImageAnnotationContext

Si se produjo una imagen a partir de un archivo (p. ej., un PDF), este mensaje contiene información sobre la fuente de la imagen.

Campos
uri

string

El URI del archivo que se usa para producir la imagen.

page_number

int32

Si el archivo era PDF o TIFF, este campo indica el número de página dentro del archivo que se usó para producir la imagen.

ImageContext

Contexto de imagen o parámetros específicos de las características.

Campos
lat_long_rect

LatLongRect

No se usa.

language_hints[]

string

Lista de idiomas que se usan en TEXT_DETECTION. En la mayoría de los casos, un valor vacío genera mejores resultados, ya que permite la detección automática del idioma. Para los idiomas que se basan en el alfabeto latino, no es necesario configurar language_hints. En casos excepcionales, cuando se conoce el idioma del texto en la imagen, establecer una sugerencia ayudará a obtener mejores resultados (aunque será un impedimento importante si la sugerencia no es correcta). La detección de texto muestra un error si uno o más de los idiomas especificados no es uno de los idiomas compatibles.

crop_hints_params

CropHintsParams

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

product_search_params

ProductSearchParams

Parámetros para la búsqueda de productos.

web_detection_params

WebDetectionParams

Parámetros para la detección web.

ImageProperties

Almacena propiedades de imagen, como los colores predominantes.

Campos
dominant_colors

DominantColorsAnnotation

Si están presente, los colores predominantes se completaron correctamente.

ImageSource

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

Campos
gcs_image_uri

string

En su lugar, usa image_uri.

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

image_uri

string

El URI de la imagen de origen. Puede ser una de estas opciones:

  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 los URI de solicitud de Google Cloud Storage para obtener más información.

  2. Una imagen HTTP/HTTPS de acceso público. Cuando se recuperan imágenes de URL HTTP/HTTPS, Google no puede garantizar que se completará la solicitud. Tu solicitud puede fallar si el host especificado niega la solicitud (p. ej., debido a una regulación de solicitud o una prevención de DoS) o si Google regula las solicitudes al sitio para evitar abusos. No debes depender de imágenes alojadas de forma externa para las aplicaciones de producción.

Cuando se especifican gcs_image_uri y image_uri, image_uri tiene prioridad.

ImportProductSetsGcsSource

La ubicación de Google Cloud Storage para 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 comenzar con gs://.

El formato del archivo csv de entrada debe ser una imagen por línea. En cada línea, hay 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 los valores ProductSet o Product que especifican los valores product-set-id y product-id no existen, el sistema creará un ProductSet o un Product nuevo para la imagen. En este caso, la columna product-display-name se refiere a display_name, la columna product-category se refiere a product_category y la columna labels se refiere 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 establece el campo display_name del producto en un espacio (“ ”). Puedes actualizar display_name más adelante con 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, en 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 manera que CreateReferenceImage. Si no especificas la columna bounding-poly, el sistema intentará detectar las regiones de interés de forma automática.

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

La columna bounding-poly debe contener una cantidad par de números separados por comas, en el formato “p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y”. Usa números enteros que no sean negativos para polígonos de límite absolutos y valores flotantes en [0, 1] para polígonos de límite normalizados.

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

ImportProductSetsInputConfig

El contenido de entrada para el método ImportProductSets.

Campos
gcs_source

ImportProductSetsGcsSource

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

ImportProductSetsRequest

Mensaje de la solicitud para el método ImportProductSets.

Campos
parent

string

El 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 para la lista de solicitudes.

ImportProductSetsResponse

Mensaje de respuesta para el método ImportProductSets.

El método google.longrunning.Operations.GetOperation muestra este mensaje en el campo google.longrunning.Operation.response que se muestra.

Campos
reference_images[]

ReferenceImage

La lista de referencias_images se importan con éxito.

statuses[]

Status

El estado de la rpc para cada solicitud de ImportProductSet, incluidos los éxitos y los errores.

En este caso, la cantidad de estados coincide con la cantidad de líneas del archivo csv, y los estados [i] almacenan el estado de éxito o de falla del procesamiento de la línea i-th del csv, a partir de la línea 0.

InputConfig

La ubicación y los metadatos de entrada deseados.

Campos
gcs_source

GcsSource

La ubicación de Google Cloud Storage desde la que se lee la entrada.

mime_type

string

El tipo de archivo. Actualmente, solo se admiten "application/pdf" e "image/tiff". Los comodines no son compatibles.

LatLongRect

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

Campos
min_lat_lng

LatLng

Par mínima latitud/longitud.

max_lat_lng

LatLng

Par máxima latitud/longitud.

Likelihood

Se trata de una representación en buckets de la probabilidad, que tiene el objetivo de ofrecer a los clientes resultados muy estables en las actualizaciones de modelos.

Enums
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 a la vertical especificada.
POSSIBLE Es posible que la imagen pertenezca a la vertical especificada.
LIKELY Es probable que la imagen pertenezca a la vertical especificada.
VERY_LIKELY Es muy probable que la imagen pertenezca a la vertical especificada.

ListProductSetsRequest

Mensaje de la solicitud para el método ListProductSets.

Campos
parent

string

El proyecto del que se deben mostrar los ProductSets.

El formato es projects/PROJECT_ID/locations/LOC_ID.

page_size

int32

La cantidad máxima de elementos que se mostrarán. 10 es el valor predeterminado, 100 el máximo.

page_token

string

El next_page_token que se muestra de una solicitud de lista anterior, si existe.

ListProductSetsResponse

Mensaje de respuesta para el método ListProductSets.

Campos
product_sets[]

ProductSet

Lista de ProductSets.

next_page_token

string

Token para recuperar la página siguiente de resultados o vaciar si no hay más resultados en la lista.

ListProductsInProductSetRequest

Mensaje de la solicitud para el método ListProductsInProductSet.

Campos
name

string

El recurso ProductSet para el que se deben recuperar los Products.

Formato: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

page_size

int32

La cantidad máxima de elementos que se mostrarán. 10 es el valor predeterminado, 100 el máximo.

page_token

string

El next_page_token que se muestra de una solicitud de lista anterior, si existe.

ListProductsInProductSetResponse

Mensaje de respuesta para el método ListProductsInProductSet.

Campos
products[]

Product

Es la lista de Products.

next_page_token

string

Token para recuperar la página siguiente de resultados o vaciar si no hay más resultados en la lista.

ListProductsRequest

Mensaje de la solicitud para el método ListProducts.

Campos
parent

string

El proyecto o el ProductSet para el que se deben enumerar los Products.

Formato: projects/PROJECT_ID/locations/LOC_ID

page_size

int32

La cantidad máxima de elementos que se mostrarán. 10 es el valor predeterminado, 100 el máximo.

page_token

string

El next_page_token que se muestra de una solicitud de lista anterior, si existe.

ListProductsResponse

Mensaje de respuesta para el método ListProducts.

Campos
products[]

Product

Lista de productos.

next_page_token

string

Token para recuperar la página siguiente de resultados o vaciar si no hay más resultados en la lista.

ListReferenceImagesRequest

Mensaje de la solicitud para el método ListReferenceImages.

Campos
parent

string

El nombre del 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

La cantidad máxima de elementos que se mostrarán. 10 es el valor predeterminado, 100 el máximo.

page_token

string

Un token que identifica una página de resultados que se mostrarán. Este es el valor de nextPageToken que se muestra en una solicitud de lista de imagen de referencia anterior.

Se configura de forma predeterminada como la primera página si no se especifica.

ListReferenceImagesResponse

Mensaje de respuesta para el método ListReferenceImages.

Campos
reference_images[]

ReferenceImage

La lista de imágenes de referencia.

page_size

int32

La cantidad máxima de elementos que se mostrarán. 10 es el valor predeterminado, 100 el máximo.

next_page_token

string

El next_page_token que se muestra de una solicitud de lista anterior, si existe.

LocalizedObjectAnnotation

Conjunto de objetos detectados con cuadros de límite.

Campos
mid

string

ID de objeto que debe alinearse con el mid de EntityAnnotation.

language_code

string

El 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 su lenguaje de language_code.

score

float

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

bounding_poly

BoundingPoly

Región de la imagen a la que pertenece este objeto. Esto debe propagarse.

LocationInfo

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

Campos
lat_lng

LatLng

Coordenadas de ubicación de latitud/longitud.

NormalizedVertex

Un vértice representa un punto 2D en la imagen. NOTA: Las coordenadas de vértices normalizadas están relacionadas con la imagen original y varían de 0 a 1.

Campos
x

float

Coordenada de X.

y

float

Coordenada de 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

Contiene metadatos para la operación BatchAnnotateImages.

Campos
state

State

Estado actual de la operación por lotes.

create_time

Timestamp

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

update_time

Timestamp

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

Estado

Estados de la operación por lotes.

Enums
STATE_UNSPECIFIED No válido.
CREATED Se recibió la solicitud.
RUNNING La solicitud se está procesando de forma activa.
DONE El procesamiento por lotes está completo.
CANCELLED El procesamiento por lotes se canceló.

OutputConfig

La ubicación de salida y los metadatos deseados.

Campos
gcs_destination

GcsDestination

La ubicación de Google Cloud Storage en la que se escriben los resultados.

batch_size

int32

La cantidad máxima de protos de respuesta que se deben colocar en cada archivo JSON de salida en Google Cloud Storage. El rango válido es [1, 100]. Si no se especifica, el valor predeterminado es 20.

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

Actualmente, batchSize solo se aplica a GcsDestination, y es posible que se admita otra configuración de salida en el futuro.

Página

Página detectada de OCR.

Campos
property

TextProperty

Información adicional detectada en la página.

width

int32

Ancho de página. Para los archivos PDF, la unidad es puntos. Para las imágenes (incluidos los TIFF), la unidad es de píxeles.

height

int32

Altura de la página. Para los archivos PDF, la unidad es puntos. Para las imágenes (incluidos los TIFF), la unidad es de píxeles.

blocks[]

Block

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

confidence

float

La confianza de los resultados de OCR en la página Rango [0, 1].

Párrafo

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

Campos
property

TextProperty

Se detectó información adicional para el párrafo.

bounding_box

BoundingPoly

El cuadro de límite del párrafo. Los vértices están en el orden de la parte superior izquierda, la parte superior derecha, la parte inferior derecha y la parte inferior izquierda. Cuando se detecta una rotación del cuadro de límite, esta se representa como alrededor de la esquina superior izquierda, según se define cuando el texto se lee en la orientación “natural”. Por ejemplo: * cuando el texto es horizontal, puede verse así: 0----1 | | 3----2 * cuando se rota 180 grados alrededor de la esquina superior izquierda se convierte en: 2----3 | | 1----0 y el orden de vértices se mantendrá como (0, 1, 2, 3).

words[]

Word

Lista de palabras de este párrafo.

confidence

float

La confianza de los resultados de OCR del párrafo. Rango [0, 1].

Posición

Una posición 3D en la imagen, que se usa principalmente para los puntos de referencia de detección de rostros. Un punto válido debe tener las coordenadas tanto de la posición "x" como de la posición "y". Las coordenadas de posición tienen la misma escala que la imagen original.

Campos
x

float

Coordenada de X.

y

float

Coordenada de Y.

z

float

Coordenada de Z (o profundidad).

Producto

Un Product contiene ReferenceImages.

Campos
name

string

Es el nombre del recurso del producto.

Formato: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

Este campo se ignora cuando se crea un producto.

display_name

string

Es el nombre proporcionado por el usuario para este Product. No debe estar vacío. Debe tener como máximo 4,096 caracteres.

description

string

Los metadatos proporcionados por el usuario para almacenar en este producto. Debe tener como máximo 4,096 caracteres.

product_category

string

La categoría del producto identificada por la imagen de referencia. Debe ser “homegoods”, “apparel” o “toys”.

Este campo es inmutable.

product_labels[]

KeyValue

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

Ten en cuenta que los valores de número entero se pueden proporcionar como strings, p. ej., “1199”. Solo las strings con valores de números enteros pueden coincidir con una restricción basada en rangos, que pronto será compatible.

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

KeyValue

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

Campos
key

string

La clave de la etiqueta adjunta al producto. No puede estar vacío ni superar los 128 bytes.

value

string

El valor de la etiqueta adjunta al producto. No puede estar vacío ni superar los 128 bytes.

ProductSearchParams

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

Campos
bounding_poly

BoundingPoly

El polígono que delimita el área de interés en la imagen. Opcional. Si no se especifica, se aplicará la discreción del sistema.

product_set

string

El nombre de recurso de un ProductSet que se buscará para imágenes similares.

Formato: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.

product_categories[]

string

La lista de categorías de productos en las que se debe buscar. En este momento, solo consideramos la primera categoría y se debe especificar “homegoods”, “apparel” o “toys”.

filter

string

La expresión de filtrado. Se puede usar para restringir los resultados de la búsqueda en función de las etiquetas de producto. Actualmente se admite un operador AND u OR de expresiones clave-valor. Cada expresión dentro de un OR debe tener la misma clave.

Por ejemplo, “(color = rojo OR color = azul) AND marca = Google” es aceptable, pero no “(color = rojo OR marca = Google)” ni “color : rojo”.

ProductSearchResults

Resultados de una solicitud de búsqueda de productos.

Campos
index_time

Timestamp

Marca de tiempo del índice que proporcionó estos resultados. Los cambios que se realicen después de esta fecha no se reflejarán en los resultados actuales.

results[]

Result

Lista de resultados, uno para cada coincidencia de producto.

product_grouped_results[]

GroupedResult

Lista de resultados agrupados por productos detectados en la imagen de la consulta. Cada entrada corresponde a un polígono de límite en la imagen de la 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 en una imagen de consulta.

Campos
bounding_poly

BoundingPoly

El polígono de límite alrededor del producto detectado en la imagen de consulta.

results[]

Result

Lista de resultados, uno para cada coincidencia de producto.

Resultado

Información sobre un producto

Campos
product

Product

El producto.

score

float

Un nivel de confianza en la coincidencia, que varía de 0 (sin confianza) a 1 (confianza total).

image

string

El nombre de recurso de la imagen del producto que tiene la coincidencia más cercana con la consulta.

ProductSet

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

Campos
name

string

Es el nombre del recurso de ProductSet.

Formato: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.

Este campo se ignora cuando se crea un ProductSet.

display_name

string

El nombre proporcionado por el usuario para este ProductSet. No debe estar vacío. Debe tener como máximo 4,096 caracteres.

index_time

Timestamp

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

Este campo se ignora cuando se crea un ProductSet.

index_error

Status

Solo salida. Si se produjo un error durante la indexación del conjunto de productos, el campo se propaga.

Este campo se ignora cuando se crea un ProductSet.

Propiedad

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

Campos
name

string

El nombre de la propiedad.

value

string

Valor de la propiedad.

uint64_value

uint64

Valor de propiedades numéricas.

ReferenceImage

ReferenceImage representa una imagen de producto y sus metadatos asociados, como cuadros de límite.

Campos
name

string

El nombre del recurso de la imagen de referencia

Formato:

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

Este campo se ignora cuando se crea una imagen de referencia.

uri

string

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

El URI debe comenzar con gs://.

Obligatorio.

bounding_polys[]

BoundingPoly

Límites de polígonos en las áreas de interés en la imagen de referencia. Opcional. Si este campo está vacío, el sistema intentará detectar las regiones de interés. Se usarán, como máximo, 10 polígonos de límite.

La forma proporcionada se convierte en un rectángulo no rotado. Una vez convertido, el borde pequeño del rectángulo debe ser mayor o igual que 300 píxeles. La relación de aspecto debe ser de 1:4 o menos (es decir, 1:3 es aceptable; 1:5 no).

RemoveProductFromProductSetRequest

Mensaje de la solicitud para el método RemoveProductFromProductSet.

Campos
name

string

Es el nombre del recurso que se debe modificar para el ProductSet.

Formato: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

product

string

El nombre de recurso del Product que se quitará de este ProductSet.

Formato: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

SafeSearchAnnotation

Conjunto de características de la imagen, calculadas mediante métodos de visión artificial sobre sectores verticales de búsqueda segura (por ejemplo, adulto, falsificación, medicina, violencia).

Campos
adult

Likelihood

Representa la probabilidad de que la imagen incluya contenido para adultos. El contenido para adultos puede contener elementos como desnudez, imágenes o caricaturas pornográficas, o actividades sexuales.

spoof

Likelihood

Probabilidad de falsificación. La 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 esta sea 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 (pero no se limita a) ropa escasa o transparente, desnudos cubiertos estratégicamente, poses obscenas o provocativas, o primeros planos de partes privadas del cuerpo.

Símbolo

Representación de un solo símbolo.

Campos
property

TextProperty

Se detectó información adicional para el símbolo.

bounding_box

BoundingPoly

El cuadro de límite del símbolo. Los vértices están en el orden de la parte superior izquierda, la parte superior derecha, la parte inferior derecha y la parte inferior izquierda. Cuando se detecta una rotación del cuadro de límite, esta se representa como alrededor de la esquina superior izquierda, según se define cuando el texto se lee en la orientación “natural”. Por ejemplo: * cuando el texto es horizontal, puede verse así: 0----1 | | 3----2 * cuando se rota 180 grados alrededor de la esquina superior izquierda se convierte en: 2----3 | | 1----0 y el orden de vértices seguirá siendo (0, 1, 2, 3).

text

string

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

confidence

float

Se obtiene la confianza de los resultados de OCR para el símbolo. Rango [0, 1].

TextAnnotation

TextAnnotation contiene una representación estructurada del texto extraído de OCR. La jerarquía de una estructura de texto extraída de OCR es así: TextAnnotation -> Página -> Bloque -> Párrafo -> Palabra -> Símbolo. Cada componente estructural, a partir de la página, puede tener sus propias propiedades. Las propiedades describen los idiomas detectados, los saltos de línea, etcétera. Consulta la definición de mensaje TextAnnotation.TextProperty a continuación para obtener más detalles.

Campos
pages[]

Page

Lista de páginas detectadas por OCR.

text

string

Texto UTF-8 detectado en las páginas.

DetectedBreak

Inicio o final detectado de un componente estructural.

Campos
type

BreakType

Se detectó un tipo de salto.

is_prefix

bool

Tiene el valor verdadero si el salto antecede al elemento.

BreakType

Enumeración que indica el tipo de salto encontrado. Línea nueva, espacio, etcétera.

Enums
UNKNOWN Tipo de etiqueta de salto desconocida.
SPACE Espacio normal.
SURE_SPACE Espacio grueso (muy ancho).
EOL_SURE_SPACE Salto de línea.
HYPHEN Guion de línea que no está presente en el texto no coincide con SPACE, LEADER_SPACE ni LINE_BREAK.
LINE_BREAK Salto de línea que termina en un párrafo.

DetectedLanguage

Idioma detectado en un componente estructural.

Campos
language_code

string

El 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

La confianza del idioma detectado. Rango [0, 1].

TextProperty

Información adicional detectada en el componente estructural.

Campos
detected_languages[]

DetectedLanguage

Una lista de idiomas detectados y la confianza.

detected_break

DetectedBreak

El inicio y el final detectados de un segmento de texto.

UpdateProductRequest

Mensaje de la solicitud para el método UpdateProduct.

Campos
product

Product

El recurso de Product que reemplaza al que está en el servidor. product.name es inmutable.

update_mask

FieldMask

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

UpdateProductSetRequest

Mensaje de la solicitud para el método UpdateProductSet.

Campos
product_set

ProductSet

El recurso ProductSet que reemplaza al que se encuentra en el servidor.

update_mask

FieldMask

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

Vertex

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

Campos
x

int32

Coordenada de X.

y

int32

Coordenada de 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

Información relevante para la imagen de Internet.

Campos
web_entities[]

WebEntity

Entidades deducidas de imágenes similares en Internet.

full_matching_images[]

WebImage

Imágenes completamente coincidentes de Internet. Puede incluir copias redimensionadas de la imagen de consulta.

partial_matching_images[]

WebImage

Imágenes de coincidencia parcial de Internet. Esas imágenes son lo suficientemente similares 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 que son similares visualmente.

best_guess_labels[]

WebLabel

La mejor suposición del sistema del tema de la imagen de la solicitud. Se deduce a partir de imágenes similares en la Web abierta.

WebEntity

Entidad deducida de imágenes similares en Internet.

Campos
entity_id

string

ID de entidad opaco.

score

float

Puntuación general de relevancia para la entidad. No se normaliza y no se puede comparar en diferentes consultas de imágenes.

description

string

La descripción canónica de la entidad, en inglés.

WebImage

Metadatos de imágenes en línea.

Campos
url

string

La URL de la imagen resultante.

score

float

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

WebLabel

Etiqueta que proporciona metadatos adicionales para la detección web.

Campos
label

string

Etiqueta para metadatos adicionales.

language_code

string

El código de idioma BCP-47 para 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) La puntuación de relevancia general para la página web.

page_title

string

El título de la página web puede contener lenguajes de marcado HTML.

full_matching_images[]

WebImage

Imágenes que coinciden por completo en la página. Puede incluir copias redimensionadas de la imagen de consulta.

partial_matching_images[]

WebImage

Imágenes que coinciden de forma parcial en la página. Esas imágenes son lo suficientemente similares 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 para la solicitud de detección web.

Campos
include_geo_results

bool

Indica si se incluyen o no los resultados derivados de la información geográfica de la imagen.

Word

Representación de palabras.

Campos
property

TextProperty

Información adicional para la palabra.

bounding_box

BoundingPoly

El cuadro de límite de la palabra. Los vértices están en el orden de la parte superior izquierda, la parte superior derecha, la parte inferior derecha y la parte inferior izquierda. Cuando se detecta una rotación del cuadro de límite, esta se representa como alrededor de la esquina superior izquierda, según se define cuando el texto se lee en la orientación “natural”. Por ejemplo: * cuando el texto es horizontal, puede verse así: 0----1 | | 3----2 * cuando se rota 180 grados alrededor de la esquina superior izquierda se convierte en: 2----3 | | 1----0 y el orden de vértices se mantendrá como (0, 1, 2, 3).

symbols[]

Symbol

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

confidence

float

La confianza de los resultados de OCR para la palabra. Rango [0, 1].