Package Classes (3.10.2)

Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images.

Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images.

Manages Products and ProductSets of reference images for use in product search. It uses the following resource model:

• The API has a collection of ProductSet resources, named projects/*/locations/*/productSets/*, which acts as a way to put different products into groups to limit identification.

In parallel,

• The API has a collection of Product resources, named projects/*/locations/*/products/*

• Each Product has a collection of ReferenceImage resources, named projects/*/locations/*/products/*/referenceImages/*

Manages Products and ProductSets of reference images for use in product search. It uses the following resource model:

• The API has a collection of ProductSet resources, named projects/*/locations/*/productSets/*, which acts as a way to put different products into groups to limit identification.

In parallel,

• The API has a collection of Product resources, named projects/*/locations/*/products/*

• Each Product has a collection of ReferenceImage resources, named projects/*/locations/*/products/*/referenceImages/*

A pager for iterating through list_product_sets requests.

This class thinly wraps an initial ListProductSetsResponse object, and provides an __aiter__ method to iterate through its product_sets field.

If there are more pages, the __aiter__ method will make additional ListProductSets requests and continue to iterate through the product_sets field on the corresponding responses.

All the usual ListProductSetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_product_sets requests.

This class thinly wraps an initial ListProductSetsResponse object, and provides an __iter__ method to iterate through its product_sets field.

If there are more pages, the __iter__ method will make additional ListProductSets requests and continue to iterate through the product_sets field on the corresponding responses.

All the usual ListProductSetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_products requests.

This class thinly wraps an initial ListProductsResponse object, and provides an __aiter__ method to iterate through its products field.

If there are more pages, the __aiter__ method will make additional ListProducts requests and continue to iterate through the products field on the corresponding responses.

All the usual ListProductsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_products_in_product_set requests.

This class thinly wraps an initial ListProductsInProductSetResponse object, and provides an __aiter__ method to iterate through its products field.

If there are more pages, the __aiter__ method will make additional ListProductsInProductSet requests and continue to iterate through the products field on the corresponding responses.

All the usual ListProductsInProductSetResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_products_in_product_set requests.

This class thinly wraps an initial ListProductsInProductSetResponse object, and provides an __iter__ method to iterate through its products field.

If there are more pages, the __iter__ method will make additional ListProductsInProductSet requests and continue to iterate through the products field on the corresponding responses.

All the usual ListProductsInProductSetResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_products requests.

This class thinly wraps an initial ListProductsResponse object, and provides an __iter__ method to iterate through its products field.

If there are more pages, the __iter__ method will make additional ListProducts requests and continue to iterate through the products field on the corresponding responses.

All the usual ListProductsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_reference_images requests.

This class thinly wraps an initial ListReferenceImagesResponse object, and provides an __aiter__ method to iterate through its reference_images field.

If there are more pages, the __aiter__ method will make additional ListReferenceImages requests and continue to iterate through the reference_images field on the corresponding responses.

All the usual ListReferenceImagesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_reference_images requests.

This class thinly wraps an initial ListReferenceImagesResponse object, and provides an __iter__ method to iterate through its reference_images field.

If there are more pages, the __iter__ method will make additional ListReferenceImages requests and continue to iterate through the reference_images field on the corresponding responses.

All the usual ListReferenceImagesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Request message for the AddProductToProductSet method.

A request to annotate one single file, e.g. a PDF, TIFF or GIF file.

Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.

Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features, and with context information.

Response to an image annotation request.

An offline file annotation request.

The response for a single offline file annotation request.

Multiple async file annotation requests are batched into a single service call.

The abstract base class for a message.

Response to an async batch file annotation request.

Request for async image annotation for a list of images.

The abstract base class for a message.

Response to an async batch image annotation request.

A list of requests to annotate files using the BatchAnnotateFiles API.

The abstract base class for a message.

A list of file annotation responses.

Multiple image annotation requests are batched into a single service call.

The abstract base class for a message.

Response to a batch image annotation request.

Metadata for the batch operations such as the current state.

This is included in the metadata field of the Operation returned by the GetOperation call of the google::longrunning::Operations service.

Enumerates the possible states that the batch request can be in.

Logical element on the page.

Type of a block (text, image etc) as identified by OCR.

A bounding polygon for the detected image annotation.

Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.

Request message for the CreateProduct method.

Request message for the CreateProductSet method.

Request message for the CreateReferenceImage method.

Single crop hint that is used to generate a new crop when serving an image.

Set of crop hints that are used to generate new crops when serving images.

Parameters for crop hints annotation request.

Request message for the DeleteProduct method.

Request message for the DeleteProductSet method.

Request message for the DeleteReferenceImage method.

Set of dominant colors and their corresponding scores.

Set of detected entity features.

A face annotation object contains the results of face detection.

A face-specific landmark (for example, a face feature).

Face landmark (feature) type. Left and right are defined from the vantage of the viewer of the image without considering mirror projections typical of photos. So, LEFT_EYE, typically, is the person's right eye.

The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type. Multiple Feature objects can be specified in the features list.

Type of Google Cloud Vision API feature to be extracted.

The Google Cloud Storage location where the output will be written to.

The Google Cloud Storage location where the input will be read from.

Request message for the GetProduct method.

Request message for the GetProductSet method.

Request message for the GetReferenceImage method.

Client image to perform Google Cloud Vision API tasks over.

If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.

Image context and/or feature-specific parameters.

Stores image properties, such as dominant colors.

External image source (Google Cloud Storage or web URL image location).

The Google Cloud Storage location for a csv file which preserves a list of ImportProductSetRequests in each line.

The input content for the ImportProductSets method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request message for the ImportProductSets method.

Response message for the ImportProductSets method.

This message is returned by the google.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation] method in the returned google.longrunning.Operation.response][google.longrunning.Operation.response] field.

The desired input location and metadata.

Rectangle determined by min and max LatLng pairs.

A bucketized representation of likelihood, which is intended to give clients highly stable results across model upgrades.

Request message for the ListProductSets method.

Response message for the ListProductSets method.

Request message for the ListProductsInProductSet method.

Response message for the ListProductsInProductSet method.

Request message for the ListProducts method.

Response message for the ListProducts method.

Request message for the ListReferenceImages method.

Response message for the ListReferenceImages method.

Set of detected objects with bounding boxes.

Detected entity location information.

A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.

Contains metadata for the BatchAnnotateImages operation.

Batch operation states.

The desired output location and metadata.

Detected page from OCR.

Structural unit of text representing a number of words in certain order.

A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.

A Product contains ReferenceImages.

A product label represented as a key-value pair.

Parameters for a product search request.

Results for a product search request.

Information about the products similar to a single product in a query image.

Prediction for what the object in the bounding box is.

Information about a product.

A ProductSet contains Products. A ProductSet can contain a maximum of 1 million reference images. If the limit is exceeded, periodic indexing will fail.

Config to control which ProductSet contains the Products to be deleted.

A Property consists of a user-supplied name/value pair.

Request message for the PurgeProducts method.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A ReferenceImage represents a product image and its associated metadata, such as bounding boxes.

Request message for the RemoveProductFromProductSet method.

Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).

A single symbol representation.

TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.

Detected start or end of a structural component.

Enum to denote the type of break found. New line, space etc.

Detected language for a structural component.

Additional information detected on the structural component.

Parameters for text detections. This is used to control TEXT_DETECTION and DOCUMENT_TEXT_DETECTION features.

Request message for the UpdateProduct method.

Request message for the UpdateProductSet method.

A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

Relevant information for the image from the Internet.

Entity deduced from similar images on the Internet.

Metadata for online images.

Label to provide extra metadata for the web detection.

Metadata for web pages.

Parameters for web detection request.

A word representation.

Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images.

Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images.

Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features.

Response to an image annotation request.

Multiple image annotation requests are batched into a single service call.

Response to a batch image annotation request.

Logical element on the page.

Type of a block (text, image etc) as identified by OCR.

A bounding polygon for the detected image annotation.

Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.

Single crop hint that is used to generate a new crop when serving an image.

Set of crop hints that are used to generate new crops when serving images.

Parameters for crop hints annotation request.

Set of dominant colors and their corresponding scores.

Set of detected entity features.

A face annotation object contains the results of face detection.

A face-specific landmark (for example, a face feature).

Face landmark (feature) type. Left and right are defined from the vantage of the viewer of the image without considering mirror projections typical of photos. So, LEFT_EYE, typically, is the person's right eye.

Users describe the type of Google Cloud Vision API tasks to perform over images by using Feature\ s. Each Feature indicates a type of image detection task to perform. Features encode the Cloud Vision API vertical to operate on and the number of top-scoring results to return.

Type of image feature.

Client image to perform Google Cloud Vision API tasks over.

Image context and/or feature-specific parameters.

Stores image properties, such as dominant colors.

External image source (Google Cloud Storage image location).

Rectangle determined by min and max LatLng pairs.

A bucketized representation of likelihood, which is intended to give clients highly stable results across model upgrades.

Detected entity location information.

Detected page from OCR.

Structural unit of text representing a number of words in certain order.

A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.

A Property consists of a user-supplied name/value pair.

Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).

A single symbol representation.

TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.

Detected start or end of a structural component.

Enum to denote the type of break found. New line, space etc.

Detected language for a structural component.

Additional information detected on the structural component.

Parameters for text detections. This is used to control TEXT_DETECTION and DOCUMENT_TEXT_DETECTION features.

A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

Relevant information for the image from the Internet.

Entity deduced from similar images on the Internet.

Metadata for online images.

Label to provide extra metadata for the web detection.

Metadata for web pages.

Parameters for web detection request.

A word representation.

Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images.

Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images.

Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.

Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features.

Response to an image annotation request.

An offline file annotation request.

The response for a single offline file annotation request.

Multiple async file annotation requests are batched into a single service call.

Response to an async batch file annotation request.

Multiple image annotation requests are batched into a single service call.

Response to a batch image annotation request.

Logical element on the page.

Type of a block (text, image etc) as identified by OCR.

A bounding polygon for the detected image annotation.

Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.

Single crop hint that is used to generate a new crop when serving an image.

Set of crop hints that are used to generate new crops when serving images.

Parameters for crop hints annotation request.

Set of dominant colors and their corresponding scores.

Set of detected entity features.

A face annotation object contains the results of face detection.

A face-specific landmark (for example, a face feature).

Face landmark (feature) type. Left and right are defined from the vantage of the viewer of the image without considering mirror projections typical of photos. So, LEFT_EYE, typically, is the person's right eye.

The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type. Multiple Feature objects can be specified in the features list.

Type of Google Cloud Vision API feature to be extracted.

The Google Cloud Storage location where the output will be written to.

The Google Cloud Storage location where the input will be read from.

Client image to perform Google Cloud Vision API tasks over.

If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.

Image context and/or feature-specific parameters.

Stores image properties, such as dominant colors.

External image source (Google Cloud Storage or web URL image location).

The desired input location and metadata.

Rectangle determined by min and max LatLng pairs.

A bucketized representation of likelihood, which is intended to give clients highly stable results across model upgrades.

Detected entity location information.

A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.

Contains metadata for the BatchAnnotateImages operation.

Batch operation states.

The desired output location and metadata.

Detected page from OCR.

Structural unit of text representing a number of words in certain order.

A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.

A Property consists of a user-supplied name/value pair.

Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).

A single symbol representation.

TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.

Detected start or end of a structural component.

Enum to denote the type of break found. New line, space etc.

Detected language for a structural component.

Additional information detected on the structural component.

Parameters for text detections. This is used to control TEXT_DETECTION and DOCUMENT_TEXT_DETECTION features.

A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

Relevant information for the image from the Internet.

Entity deduced from similar images on the Internet.

Metadata for online images.

Label to provide extra metadata for the web detection.

Metadata for web pages.

Parameters for web detection request.

A word representation.

Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images.

Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images.

Manages Products and ProductSets of reference images for use in product search. It uses the following resource model:

• The API has a collection of ProductSet resources, named projects/*/locations/*/productSets/*, which acts as a way to put different products into groups to limit identification.

In parallel,

• The API has a collection of Product resources, named projects/*/locations/*/products/*

• Each Product has a collection of ReferenceImage resources, named projects/*/locations/*/products/*/referenceImages/*

Manages Products and ProductSets of reference images for use in product search. It uses the following resource model:

• The API has a collection of ProductSet resources, named projects/*/locations/*/productSets/*, which acts as a way to put different products into groups to limit identification.

In parallel,

• The API has a collection of Product resources, named projects/*/locations/*/products/*

• Each Product has a collection of ReferenceImage resources, named projects/*/locations/*/products/*/referenceImages/*

A pager for iterating through list_product_sets requests.

This class thinly wraps an initial ListProductSetsResponse object, and provides an __aiter__ method to iterate through its product_sets field.

If there are more pages, the __aiter__ method will make additional ListProductSets requests and continue to iterate through the product_sets field on the corresponding responses.

All the usual ListProductSetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_product_sets requests.

This class thinly wraps an initial ListProductSetsResponse object, and provides an __iter__ method to iterate through its product_sets field.

If there are more pages, the __iter__ method will make additional ListProductSets requests and continue to iterate through the product_sets field on the corresponding responses.

All the usual ListProductSetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_products requests.

This class thinly wraps an initial ListProductsResponse object, and provides an __aiter__ method to iterate through its products field.

If there are more pages, the __aiter__ method will make additional ListProducts requests and continue to iterate through the products field on the corresponding responses.

All the usual ListProductsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_products_in_product_set requests.

This class thinly wraps an initial ListProductsInProductSetResponse object, and provides an __aiter__ method to iterate through its products field.

If there are more pages, the __aiter__ method will make additional ListProductsInProductSet requests and continue to iterate through the products field on the corresponding responses.

All the usual ListProductsInProductSetResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_products_in_product_set requests.

This class thinly wraps an initial ListProductsInProductSetResponse object, and provides an __iter__ method to iterate through its products field.

If there are more pages, the __iter__ method will make additional ListProductsInProductSet requests and continue to iterate through the products field on the corresponding responses.

All the usual ListProductsInProductSetResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_products requests.

This class thinly wraps an initial ListProductsResponse object, and provides an __iter__ method to iterate through its products field.

If there are more pages, the __iter__ method will make additional ListProducts requests and continue to iterate through the products field on the corresponding responses.

All the usual ListProductsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_reference_images requests.

This class thinly wraps an initial ListReferenceImagesResponse object, and provides an __aiter__ method to iterate through its reference_images field.

If there are more pages, the __aiter__ method will make additional ListReferenceImages requests and continue to iterate through the reference_images field on the corresponding responses.

All the usual ListReferenceImagesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_reference_images requests.

This class thinly wraps an initial ListReferenceImagesResponse object, and provides an __iter__ method to iterate through its reference_images field.

If there are more pages, the __iter__ method will make additional ListReferenceImages requests and continue to iterate through the reference_images field on the corresponding responses.

All the usual ListReferenceImagesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Request message for the AddProductToProductSet method.

Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.

Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features.

Response to an image annotation request.

An offline file annotation request.

The response for a single offline file annotation request.

Multiple async file annotation requests are batched into a single service call.

Response to an async batch file annotation request.

Multiple image annotation requests are batched into a single service call.

Response to a batch image annotation request.

Metadata for the batch operations such as the current state.

This is included in the metadata field of the Operation returned by the GetOperation call of the google::longrunning::Operations service.

Enumerates the possible states that the batch request can be in.

Logical element on the page.

Type of a block (text, image etc) as identified by OCR.

A bounding polygon for the detected image annotation.

Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.

Request message for the CreateProduct method.

Request message for the CreateProductSet method.

Request message for the CreateReferenceImage method.

Single crop hint that is used to generate a new crop when serving an image.

Set of crop hints that are used to generate new crops when serving images.

Parameters for crop hints annotation request.

Request message for the DeleteProduct method.

Request message for the DeleteProductSet method.

Request message for the DeleteReferenceImage method.

Set of dominant colors and their corresponding scores.

Set of detected entity features.

A face annotation object contains the results of face detection.

A face-specific landmark (for example, a face feature).

Face landmark (feature) type. Left and right are defined from the vantage of the viewer of the image without considering mirror projections typical of photos. So, LEFT_EYE, typically, is the person's right eye.

The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type. Multiple Feature objects can be specified in the features list.

Type of Google Cloud Vision API feature to be extracted.

The Google Cloud Storage location where the output will be written to.

The Google Cloud Storage location where the input will be read from.

Request message for the GetProduct method.

Request message for the GetProductSet method.

Request message for the GetReferenceImage method.

Client image to perform Google Cloud Vision API tasks over.

If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.

Image context and/or feature-specific parameters.

Stores image properties, such as dominant colors.

External image source (Google Cloud Storage or web URL image location).

The Google Cloud Storage location for a csv file which preserves a list of ImportProductSetRequests in each line.

The input content for the ImportProductSets method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request message for the ImportProductSets method.

Response message for the ImportProductSets method.

This message is returned by the google.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation] method in the returned google.longrunning.Operation.response][google.longrunning.Operation.response] field.

The desired input location and metadata.

Rectangle determined by min and max LatLng pairs.

A bucketized representation of likelihood, which is intended to give clients highly stable results across model upgrades.

Request message for the ListProductSets method.

Response message for the ListProductSets method.

Request message for the ListProductsInProductSet method.

Response message for the ListProductsInProductSet method.

Request message for the ListProducts method.

Response message for the ListProducts method.

Request message for the ListReferenceImages method.

Response message for the ListReferenceImages method.

Set of detected objects with bounding boxes.

Detected entity location information.

A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.

Contains metadata for the BatchAnnotateImages operation.

Batch operation states.

The desired output location and metadata.

Detected page from OCR.

Structural unit of text representing a number of words in certain order.

A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.

A Product contains ReferenceImages.

A product label represented as a key-value pair.

Parameters for a product search request.

Results for a product search request.

Information about the products similar to a single product in a query image.

Prediction for what the object in the bounding box is.

Information about a product.

A ProductSet contains Products. A ProductSet can contain a maximum of 1 million reference images. If the limit is exceeded, periodic indexing will fail.

A Property consists of a user-supplied name/value pair.

A ReferenceImage represents a product image and its associated metadata, such as bounding boxes.

Request message for the RemoveProductFromProductSet method.

Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).

A single symbol representation.

TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.

Detected start or end of a structural component.

Enum to denote the type of break found. New line, space etc.

Detected language for a structural component.

Additional information detected on the structural component.

Parameters for text detections. This is used to control TEXT_DETECTION and DOCUMENT_TEXT_DETECTION features.

Request message for the UpdateProduct method.

Request message for the UpdateProductSet method.

A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

Relevant information for the image from the Internet.

Entity deduced from similar images on the Internet.

Metadata for online images.

Label to provide extra metadata for the web detection.

Metadata for web pages.

Parameters for web detection request.

A word representation.

Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images.

Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images.

Manages Products and ProductSets of reference images for use in product search. It uses the following resource model:

• The API has a collection of ProductSet resources, named projects/*/locations/*/productSets/*, which acts as a way to put different products into groups to limit identification.

In parallel,

• The API has a collection of Product resources, named projects/*/locations/*/products/*

• Each Product has a collection of ReferenceImage resources, named projects/*/locations/*/products/*/referenceImages/*

Manages Products and ProductSets of reference images for use in product search. It uses the following resource model:

• The API has a collection of ProductSet resources, named projects/*/locations/*/productSets/*, which acts as a way to put different products into groups to limit identification.

In parallel,

• The API has a collection of Product resources, named projects/*/locations/*/products/*

• Each Product has a collection of ReferenceImage resources, named projects/*/locations/*/products/*/referenceImages/*

A pager for iterating through list_product_sets requests.

This class thinly wraps an initial ListProductSetsResponse object, and provides an __aiter__ method to iterate through its product_sets field.

If there are more pages, the __aiter__ method will make additional ListProductSets requests and continue to iterate through the product_sets field on the corresponding responses.

All the usual ListProductSetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_product_sets requests.

This class thinly wraps an initial ListProductSetsResponse object, and provides an __iter__ method to iterate through its product_sets field.

If there are more pages, the __iter__ method will make additional ListProductSets requests and continue to iterate through the product_sets field on the corresponding responses.

All the usual ListProductSetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_products requests.

This class thinly wraps an initial ListProductsResponse object, and provides an __aiter__ method to iterate through its products field.

If there are more pages, the __aiter__ method will make additional ListProducts requests and continue to iterate through the products field on the corresponding responses.

All the usual ListProductsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_products_in_product_set requests.

This class thinly wraps an initial ListProductsInProductSetResponse object, and provides an __aiter__ method to iterate through its products field.

If there are more pages, the __aiter__ method will make additional ListProductsInProductSet requests and continue to iterate through the products field on the corresponding responses.

All the usual ListProductsInProductSetResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_products_in_product_set requests.

This class thinly wraps an initial ListProductsInProductSetResponse object, and provides an __iter__ method to iterate through its products field.

If there are more pages, the __iter__ method will make additional ListProductsInProductSet requests and continue to iterate through the products field on the corresponding responses.

All the usual ListProductsInProductSetResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_products requests.

This class thinly wraps an initial ListProductsResponse object, and provides an __iter__ method to iterate through its products field.

If there are more pages, the __iter__ method will make additional ListProducts requests and continue to iterate through the products field on the corresponding responses.

All the usual ListProductsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_reference_images requests.

This class thinly wraps an initial ListReferenceImagesResponse object, and provides an __aiter__ method to iterate through its reference_images field.

If there are more pages, the __aiter__ method will make additional ListReferenceImages requests and continue to iterate through the reference_images field on the corresponding responses.

All the usual ListReferenceImagesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_reference_images requests.

This class thinly wraps an initial ListReferenceImagesResponse object, and provides an __iter__ method to iterate through its reference_images field.

If there are more pages, the __iter__ method will make additional ListReferenceImages requests and continue to iterate through the reference_images field on the corresponding responses.

All the usual ListReferenceImagesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Request message for the AddProductToProductSet method.

A request to annotate one single file, e.g. a PDF, TIFF or GIF file.

Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.

Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features, and with context information.

Response to an image annotation request.

An offline file annotation request.

The response for a single offline file annotation request.

Multiple async file annotation requests are batched into a single service call.

Response to an async batch file annotation request.

Request for async image annotation for a list of images.

Response to an async batch image annotation request.

A list of requests to annotate files using the BatchAnnotateFiles API.

A list of file annotation responses.

Multiple image annotation requests are batched into a single service call.

Response to a batch image annotation request.

Metadata for the batch operations such as the current state.

This is included in the metadata field of the Operation returned by the GetOperation call of the google::longrunning::Operations service.

Enumerates the possible states that the batch request can be in.

Logical element on the page.

Type of a block (text, image etc) as identified by OCR.

A bounding polygon for the detected image annotation.

A Celebrity is a group of Faces with an identity.

Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.

Request message for the CreateProduct method.

Request message for the CreateProductSet method.

Request message for the CreateReferenceImage method.

Single crop hint that is used to generate a new crop when serving an image.

Set of crop hints that are used to generate new crops when serving images.

Parameters for crop hints annotation request.

Request message for the DeleteProduct method.

Request message for the DeleteProductSet method.

Request message for the DeleteReferenceImage method.

Set of dominant colors and their corresponding scores.

Set of detected entity features.

A face annotation object contains the results of face detection.

A face-specific landmark (for example, a face feature).

Face landmark (feature) type. Left and right are defined from the vantage of the viewer of the image without considering mirror projections typical of photos. So, LEFT_EYE, typically, is the person's right eye.

Parameters for a celebrity recognition request.

Information about a face's identity.

The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type. Multiple Feature objects can be specified in the features list.

Type of Google Cloud Vision API feature to be extracted.

The Google Cloud Storage location where the output will be written to.

The Google Cloud Storage location where the input will be read from.

Request message for the GetProduct method.

Request message for the GetProductSet method.

Request message for the GetReferenceImage method.

Client image to perform Google Cloud Vision API tasks over.

If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.

Image context and/or feature-specific parameters.

Stores image properties, such as dominant colors.

External image source (Google Cloud Storage or web URL image location).

The Google Cloud Storage location for a csv file which preserves a list of ImportProductSetRequests in each line.

The input content for the ImportProductSets method.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request message for the ImportProductSets method.

Response message for the ImportProductSets method.

This message is returned by the google.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation] method in the returned google.longrunning.Operation.response][google.longrunning.Operation.response] field.

The desired input location and metadata.

Rectangle determined by min and max LatLng pairs.

A bucketized representation of likelihood, which is intended to give clients highly stable results across model upgrades.

Request message for the ListProductSets method.

Response message for the ListProductSets method.

Request message for the ListProductsInProductSet method.

Response message for the ListProductsInProductSet method.

Request message for the ListProducts method.

Response message for the ListProducts method.

Request message for the ListReferenceImages method.

Response message for the ListReferenceImages method.

Set of detected objects with bounding boxes.

Detected entity location information.

A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.

Contains metadata for the BatchAnnotateImages operation.

Batch operation states.

The desired output location and metadata.

Detected page from OCR.

Structural unit of text representing a number of words in certain order.

A 3D position in the image, used primarily for Face detection landmarks. A valid Position must have both x and y coordinates. The position coordinates are in the same scale as the original image.

A Product contains ReferenceImages.

A product label represented as a key-value pair.

Parameters for a product search request.

Results for a product search request.

Information about the products similar to a single product in a query image.

Prediction for what the object in the bounding box is.

Information about a product.

A ProductSet contains Products. A ProductSet can contain a maximum of 1 million reference images. If the limit is exceeded, periodic indexing will fail.

Config to control which ProductSet contains the Products to be deleted.

A Property consists of a user-supplied name/value pair.

Request message for the PurgeProducts method.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A ReferenceImage represents a product image and its associated metadata, such as bounding boxes.

Request message for the RemoveProductFromProductSet method.

Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).

A single symbol representation.

TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation.TextProperty message definition below for more detail.

Detected start or end of a structural component.

Enum to denote the type of break found. New line, space etc.

Detected language for a structural component.

Additional information detected on the structural component.

Parameters for text detections. This is used to control TEXT_DETECTION and DOCUMENT_TEXT_DETECTION features.

Request message for the UpdateProduct method.

Request message for the UpdateProductSet method.

A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

Relevant information for the image from the Internet.

Entity deduced from similar images on the Internet.

Metadata for online images.

Label to provide extra metadata for the web detection.

Metadata for web pages.

Parameters for web detection request.

A word representation.

API documentation for vision_v1.services.product_search.pagers module.

API documentation for vision_v1p3beta1.services.product_search.pagers module.

API documentation for vision_v1p4beta1.services.product_search.pagers module.