Package Classes (3.7.4)

Summary of entries of Classes for vision.

Classes

ImageAnnotatorAsyncClient

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.

ImageAnnotatorClient

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.

ProductSearchAsyncClient

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/*

ProductSearchClient

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/*

ListProductSetsAsyncPager

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.

ListProductSetsPager

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.

ListProductsAsyncPager

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.

ListProductsInProductSetAsyncPager

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.

ListProductsInProductSetPager

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.

ListProductsPager

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.

ListReferenceImagesAsyncPager

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.

ListReferenceImagesPager

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.

AddProductToProductSetRequest

Request message for the AddProductToProductSet method.

AnnotateFileRequest

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

AnnotateFileResponse

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

AnnotateImageRequest

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

AnnotateImageResponse

Response to an image annotation request.

AsyncAnnotateFileRequest

An offline file annotation request.

AsyncAnnotateFileResponse

The response for a single offline file annotation request.

AsyncBatchAnnotateFilesRequest

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

LabelsEntry

The abstract base class for a message.

AsyncBatchAnnotateFilesResponse

Response to an async batch file annotation request.

AsyncBatchAnnotateImagesRequest

Request for async image annotation for a list of images.

LabelsEntry

The abstract base class for a message.

AsyncBatchAnnotateImagesResponse

Response to an async batch image annotation request.

BatchAnnotateFilesRequest

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

LabelsEntry

The abstract base class for a message.

BatchAnnotateFilesResponse

A list of file annotation responses.

BatchAnnotateImagesRequest

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

LabelsEntry

The abstract base class for a message.

BatchAnnotateImagesResponse

Response to a batch image annotation request.

BatchOperationMetadata

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.

State

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

Block

Logical element on the page.

BlockType

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

BoundingPoly

A bounding polygon for the detected image annotation.

ColorInfo

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

CreateProductRequest

Request message for the CreateProduct method.

CreateProductSetRequest

Request message for the CreateProductSet method.

CreateReferenceImageRequest

Request message for the CreateReferenceImage method.

CropHint

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

CropHintsAnnotation

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

CropHintsParams

Parameters for crop hints annotation request.

DeleteProductRequest

Request message for the DeleteProduct method.

DeleteProductSetRequest

Request message for the DeleteProductSet method.

DeleteReferenceImageRequest

Request message for the DeleteReferenceImage method.

DominantColorsAnnotation

Set of dominant colors and their corresponding scores.

EntityAnnotation

Set of detected entity features.

FaceAnnotation

A face annotation object contains the results of face detection.

Landmark

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

Type

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.

Feature

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

Type of Google Cloud Vision API feature to be extracted.

GcsDestination

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

GcsSource

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

GetProductRequest

Request message for the GetProduct method.

GetProductSetRequest

Request message for the GetProductSet method.

GetReferenceImageRequest

Request message for the GetReferenceImage method.

Image

Client image to perform Google Cloud Vision API tasks over.

ImageAnnotationContext

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

ImageContext

Image context and/or feature-specific parameters.

ImageProperties

Stores image properties, such as dominant colors.

ImageSource

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

ImportProductSetsGcsSource

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

ImportProductSetsInputConfig

The input content for the ImportProductSets method.

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

ImportProductSetsRequest

Request message for the ImportProductSets method.

ImportProductSetsResponse

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.

InputConfig

The desired input location and metadata.

LatLongRect

Rectangle determined by min and max LatLng pairs.

Likelihood

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

ListProductSetsRequest

Request message for the ListProductSets method.

ListProductSetsResponse

Response message for the ListProductSets method.

ListProductsInProductSetRequest

Request message for the ListProductsInProductSet method.

ListProductsInProductSetResponse

Response message for the ListProductsInProductSet method.

ListProductsRequest

Request message for the ListProducts method.

ListProductsResponse

Response message for the ListProducts method.

ListReferenceImagesRequest

Request message for the ListReferenceImages method.

ListReferenceImagesResponse

Response message for the ListReferenceImages method.

LocalizedObjectAnnotation

Set of detected objects with bounding boxes.

LocationInfo

Detected entity location information.

NormalizedVertex

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.

OperationMetadata

Contains metadata for the BatchAnnotateImages operation.

State

Batch operation states.

OutputConfig

The desired output location and metadata.

Page

Detected page from OCR.

Paragraph

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

Position

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.

Product

A Product contains ReferenceImages.

KeyValue

A product label represented as a key-value pair.

ProductSearchParams

Parameters for a product search request.

ProductSearchResults

Results for a product search request.

GroupedResult

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

ObjectAnnotation

Prediction for what the object in the bounding box is.

Result

Information about a product.

ProductSet

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

ProductSetPurgeConfig

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

Property

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

PurgeProductsRequest

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

ReferenceImage

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

RemoveProductFromProductSetRequest

Request message for the RemoveProductFromProductSet method.

SafeSearchAnnotation

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

Symbol

A single symbol representation.

TextAnnotation

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.

DetectedBreak

Detected start or end of a structural component.

BreakType

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

DetectedLanguage

Detected language for a structural component.

TextProperty

Additional information detected on the structural component.

TextDetectionParams

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

UpdateProductRequest

Request message for the UpdateProduct method.

UpdateProductSetRequest

Request message for the UpdateProductSet method.

Vertex

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

WebDetection

Relevant information for the image from the Internet.

WebEntity

Entity deduced from similar images on the Internet.

WebImage

Metadata for online images.

WebLabel

Label to provide extra metadata for the web detection.

WebPage

Metadata for web pages.

WebDetectionParams

Parameters for web detection request.

Word

A word representation.

ImageAnnotatorAsyncClient

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.

ImageAnnotatorClient

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.

AnnotateImageRequest

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

AnnotateImageResponse

Response to an image annotation request.

BatchAnnotateImagesRequest

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

BatchAnnotateImagesResponse

Response to a batch image annotation request.

Block

Logical element on the page.

BlockType

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

BoundingPoly

A bounding polygon for the detected image annotation.

ColorInfo

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

CropHint

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

CropHintsAnnotation

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

CropHintsParams

Parameters for crop hints annotation request.

DominantColorsAnnotation

Set of dominant colors and their corresponding scores.

EntityAnnotation

Set of detected entity features.

FaceAnnotation

A face annotation object contains the results of face detection.

Landmark

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

Type

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.

Feature

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

Type of image feature.

Image

Client image to perform Google Cloud Vision API tasks over.

ImageContext

Image context and/or feature-specific parameters.

ImageProperties

Stores image properties, such as dominant colors.

ImageSource

External image source (Google Cloud Storage image location).

LatLongRect

Rectangle determined by min and max LatLng pairs.

Likelihood

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

LocationInfo

Detected entity location information.

Page

Detected page from OCR.

Paragraph

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

Position

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.

Property

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

SafeSearchAnnotation

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

Symbol

A single symbol representation.

TextAnnotation

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.

DetectedBreak

Detected start or end of a structural component.

BreakType

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

DetectedLanguage

Detected language for a structural component.

TextProperty

Additional information detected on the structural component.

TextDetectionParams

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

Vertex

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

WebDetection

Relevant information for the image from the Internet.

WebEntity

Entity deduced from similar images on the Internet.

WebImage

Metadata for online images.

WebLabel

Label to provide extra metadata for the web detection.

WebPage

Metadata for web pages.

WebDetectionParams

Parameters for web detection request.

Word

A word representation.

ImageAnnotatorAsyncClient

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.

ImageAnnotatorClient

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.

AnnotateFileResponse

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

AnnotateImageRequest

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

AnnotateImageResponse

Response to an image annotation request.

AsyncAnnotateFileRequest

An offline file annotation request.

AsyncAnnotateFileResponse

The response for a single offline file annotation request.

AsyncBatchAnnotateFilesRequest

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

AsyncBatchAnnotateFilesResponse

Response to an async batch file annotation request.

BatchAnnotateImagesRequest

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

BatchAnnotateImagesResponse

Response to a batch image annotation request.

Block

Logical element on the page.

BlockType

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

BoundingPoly

A bounding polygon for the detected image annotation.

ColorInfo

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

CropHint

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

CropHintsAnnotation

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

CropHintsParams

Parameters for crop hints annotation request.

DominantColorsAnnotation

Set of dominant colors and their corresponding scores.

EntityAnnotation

Set of detected entity features.

FaceAnnotation

A face annotation object contains the results of face detection.

Landmark

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

Type

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.

Feature

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

Type of Google Cloud Vision API feature to be extracted.

GcsDestination

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

GcsSource

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

Image

Client image to perform Google Cloud Vision API tasks over.

ImageAnnotationContext

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

ImageContext

Image context and/or feature-specific parameters.

ImageProperties

Stores image properties, such as dominant colors.

ImageSource

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

InputConfig

The desired input location and metadata.

LatLongRect

Rectangle determined by min and max LatLng pairs.

Likelihood

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

LocationInfo

Detected entity location information.

NormalizedVertex

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.

OperationMetadata

Contains metadata for the BatchAnnotateImages operation.

State

Batch operation states.

OutputConfig

The desired output location and metadata.

Page

Detected page from OCR.

Paragraph

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

Position

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.

Property

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

SafeSearchAnnotation

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

Symbol

A single symbol representation.

TextAnnotation

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.

DetectedBreak

Detected start or end of a structural component.

BreakType

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

DetectedLanguage

Detected language for a structural component.

TextProperty

Additional information detected on the structural component.

TextDetectionParams

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

Vertex

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

WebDetection

Relevant information for the image from the Internet.

WebEntity

Entity deduced from similar images on the Internet.

WebImage

Metadata for online images.

WebLabel

Label to provide extra metadata for the web detection.

WebPage

Metadata for web pages.

WebDetectionParams

Parameters for web detection request.

Word

A word representation.

ImageAnnotatorAsyncClient

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.

ImageAnnotatorClient

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.

ProductSearchAsyncClient

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/*

ProductSearchClient

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/*

ListProductSetsAsyncPager

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.

ListProductSetsPager

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.

ListProductsAsyncPager

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.

ListProductsInProductSetAsyncPager

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.

ListProductsInProductSetPager

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.

ListProductsPager

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.

ListReferenceImagesAsyncPager

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.

ListReferenceImagesPager

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.

AddProductToProductSetRequest

Request message for the AddProductToProductSet method.

AnnotateFileResponse

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

AnnotateImageRequest

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

AnnotateImageResponse

Response to an image annotation request.

AsyncAnnotateFileRequest

An offline file annotation request.

AsyncAnnotateFileResponse

The response for a single offline file annotation request.

AsyncBatchAnnotateFilesRequest

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

AsyncBatchAnnotateFilesResponse

Response to an async batch file annotation request.

BatchAnnotateImagesRequest

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

BatchAnnotateImagesResponse

Response to a batch image annotation request.

BatchOperationMetadata

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.

State

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

Block

Logical element on the page.

BlockType

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

BoundingPoly

A bounding polygon for the detected image annotation.

ColorInfo

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

CreateProductRequest

Request message for the CreateProduct method.

CreateProductSetRequest

Request message for the CreateProductSet method.

CreateReferenceImageRequest

Request message for the CreateReferenceImage method.

CropHint

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

CropHintsAnnotation

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

CropHintsParams

Parameters for crop hints annotation request.

DeleteProductRequest

Request message for the DeleteProduct method.

DeleteProductSetRequest

Request message for the DeleteProductSet method.

DeleteReferenceImageRequest

Request message for the DeleteReferenceImage method.

DominantColorsAnnotation

Set of dominant colors and their corresponding scores.

EntityAnnotation

Set of detected entity features.

FaceAnnotation

A face annotation object contains the results of face detection.

Landmark

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

Type

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.

Feature

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

Type of Google Cloud Vision API feature to be extracted.

GcsDestination

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

GcsSource

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

GetProductRequest

Request message for the GetProduct method.

GetProductSetRequest

Request message for the GetProductSet method.

GetReferenceImageRequest

Request message for the GetReferenceImage method.

Image

Client image to perform Google Cloud Vision API tasks over.

ImageAnnotationContext

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

ImageContext

Image context and/or feature-specific parameters.

ImageProperties

Stores image properties, such as dominant colors.

ImageSource

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

ImportProductSetsGcsSource

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

ImportProductSetsInputConfig

The input content for the ImportProductSets method.

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

ImportProductSetsRequest

Request message for the ImportProductSets method.

ImportProductSetsResponse

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.

InputConfig

The desired input location and metadata.

LatLongRect

Rectangle determined by min and max LatLng pairs.

Likelihood

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

ListProductSetsRequest

Request message for the ListProductSets method.

ListProductSetsResponse

Response message for the ListProductSets method.

ListProductsInProductSetRequest

Request message for the ListProductsInProductSet method.

ListProductsInProductSetResponse

Response message for the ListProductsInProductSet method.

ListProductsRequest

Request message for the ListProducts method.

ListProductsResponse

Response message for the ListProducts method.

ListReferenceImagesRequest

Request message for the ListReferenceImages method.

ListReferenceImagesResponse

Response message for the ListReferenceImages method.

LocalizedObjectAnnotation

Set of detected objects with bounding boxes.

LocationInfo

Detected entity location information.

NormalizedVertex

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.

OperationMetadata

Contains metadata for the BatchAnnotateImages operation.

State

Batch operation states.

OutputConfig

The desired output location and metadata.

Page

Detected page from OCR.

Paragraph

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

Position

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.

Product

A Product contains ReferenceImages.

KeyValue

A product label represented as a key-value pair.

ProductSearchParams

Parameters for a product search request.

ProductSearchResults

Results for a product search request.

GroupedResult

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

ObjectAnnotation

Prediction for what the object in the bounding box is.

Result

Information about a product.

ProductSet

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

Property

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

ReferenceImage

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

RemoveProductFromProductSetRequest

Request message for the RemoveProductFromProductSet method.

SafeSearchAnnotation

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

Symbol

A single symbol representation.

TextAnnotation

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.

DetectedBreak

Detected start or end of a structural component.

BreakType

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

DetectedLanguage

Detected language for a structural component.

TextProperty

Additional information detected on the structural component.

TextDetectionParams

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

UpdateProductRequest

Request message for the UpdateProduct method.

UpdateProductSetRequest

Request message for the UpdateProductSet method.

Vertex

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

WebDetection

Relevant information for the image from the Internet.

WebEntity

Entity deduced from similar images on the Internet.

WebImage

Metadata for online images.

WebLabel

Label to provide extra metadata for the web detection.

WebPage

Metadata for web pages.

WebDetectionParams

Parameters for web detection request.

Word

A word representation.

ImageAnnotatorAsyncClient

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.

ImageAnnotatorClient

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.

ProductSearchAsyncClient

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/*

ProductSearchClient

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/*

ListProductSetsAsyncPager

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.

ListProductSetsPager

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.

ListProductsAsyncPager

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.

ListProductsInProductSetAsyncPager

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.

ListProductsInProductSetPager

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.

ListProductsPager

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.

ListReferenceImagesAsyncPager

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.

ListReferenceImagesPager

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.

AddProductToProductSetRequest

Request message for the AddProductToProductSet method.

AnnotateFileRequest

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

AnnotateFileResponse

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

AnnotateImageRequest

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

AnnotateImageResponse

Response to an image annotation request.

AsyncAnnotateFileRequest

An offline file annotation request.

AsyncAnnotateFileResponse

The response for a single offline file annotation request.

AsyncBatchAnnotateFilesRequest

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

AsyncBatchAnnotateFilesResponse

Response to an async batch file annotation request.

AsyncBatchAnnotateImagesRequest

Request for async image annotation for a list of images.

AsyncBatchAnnotateImagesResponse

Response to an async batch image annotation request.

BatchAnnotateFilesRequest

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

BatchAnnotateFilesResponse

A list of file annotation responses.

BatchAnnotateImagesRequest

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

BatchAnnotateImagesResponse

Response to a batch image annotation request.

BatchOperationMetadata

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.

State

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

Block

Logical element on the page.

BlockType

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

BoundingPoly

A bounding polygon for the detected image annotation.

Celebrity

A Celebrity is a group of Faces with an identity.

ColorInfo

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

CreateProductRequest

Request message for the CreateProduct method.

CreateProductSetRequest

Request message for the CreateProductSet method.

CreateReferenceImageRequest

Request message for the CreateReferenceImage method.

CropHint

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

CropHintsAnnotation

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

CropHintsParams

Parameters for crop hints annotation request.

DeleteProductRequest

Request message for the DeleteProduct method.

DeleteProductSetRequest

Request message for the DeleteProductSet method.

DeleteReferenceImageRequest

Request message for the DeleteReferenceImage method.

DominantColorsAnnotation

Set of dominant colors and their corresponding scores.

EntityAnnotation

Set of detected entity features.

FaceAnnotation

A face annotation object contains the results of face detection.

Landmark

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

Type

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.

FaceRecognitionParams

Parameters for a celebrity recognition request.

FaceRecognitionResult

Information about a face's identity.

Feature

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

Type of Google Cloud Vision API feature to be extracted.

GcsDestination

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

GcsSource

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

GetProductRequest

Request message for the GetProduct method.

GetProductSetRequest

Request message for the GetProductSet method.

GetReferenceImageRequest

Request message for the GetReferenceImage method.

Image

Client image to perform Google Cloud Vision API tasks over.

ImageAnnotationContext

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

ImageContext

Image context and/or feature-specific parameters.

ImageProperties

Stores image properties, such as dominant colors.

ImageSource

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

ImportProductSetsGcsSource

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

ImportProductSetsInputConfig

The input content for the ImportProductSets method.

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

ImportProductSetsRequest

Request message for the ImportProductSets method.

ImportProductSetsResponse

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.

InputConfig

The desired input location and metadata.

LatLongRect

Rectangle determined by min and max LatLng pairs.

Likelihood

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

ListProductSetsRequest

Request message for the ListProductSets method.

ListProductSetsResponse

Response message for the ListProductSets method.

ListProductsInProductSetRequest

Request message for the ListProductsInProductSet method.

ListProductsInProductSetResponse

Response message for the ListProductsInProductSet method.

ListProductsRequest

Request message for the ListProducts method.

ListProductsResponse

Response message for the ListProducts method.

ListReferenceImagesRequest

Request message for the ListReferenceImages method.

ListReferenceImagesResponse

Response message for the ListReferenceImages method.

LocalizedObjectAnnotation

Set of detected objects with bounding boxes.

LocationInfo

Detected entity location information.

NormalizedVertex

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.

OperationMetadata

Contains metadata for the BatchAnnotateImages operation.

State

Batch operation states.

OutputConfig

The desired output location and metadata.

Page

Detected page from OCR.

Paragraph

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

Position

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.

Product

A Product contains ReferenceImages.

KeyValue

A product label represented as a key-value pair.

ProductSearchParams

Parameters for a product search request.

ProductSearchResults

Results for a product search request.

GroupedResult

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

ObjectAnnotation

Prediction for what the object in the bounding box is.

Result

Information about a product.

ProductSet

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

ProductSetPurgeConfig

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

Property

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

PurgeProductsRequest

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

ReferenceImage

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

RemoveProductFromProductSetRequest

Request message for the RemoveProductFromProductSet method.

SafeSearchAnnotation

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

Symbol

A single symbol representation.

TextAnnotation

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.

DetectedBreak

Detected start or end of a structural component.

BreakType

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

DetectedLanguage

Detected language for a structural component.

TextProperty

Additional information detected on the structural component.

TextDetectionParams

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

UpdateProductRequest

Request message for the UpdateProduct method.

UpdateProductSetRequest

Request message for the UpdateProductSet method.

Vertex

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

WebDetection

Relevant information for the image from the Internet.

WebEntity

Entity deduced from similar images on the Internet.

WebImage

Metadata for online images.

WebLabel

Label to provide extra metadata for the web detection.

WebPage

Metadata for web pages.

WebDetectionParams

Parameters for web detection request.

Word

A word representation.

Modules

pagers

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

pagers

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

pagers

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