Package Classes (3.11.0) Stay organized with collections Save and categorize content based on your preferences.
Summary of entries of Classes for vision.
Classes
ImageAnnotatorAsyncClient
Service that performs Google Cloud Vision API detection tasksover client images, such as face, landmark, logo, label, andtext detection. The ImageAnnotator service returns detectedentities from the images.
ImageAnnotatorClient
Service that performs Google Cloud Vision API detection tasksover client images, such as face, landmark, logo, label, andtext detection. The ImageAnnotator service returns detectedentities from the images.
ProductSearchAsyncClient
Manages Products and ProductSets of reference images for use inproduct search. It uses the following resource model:
- The API has a collection ofProductSet resources, named
projects/*/locations/*/productSets/*, which acts as a way toput different products into groups to limit identification.
In parallel,
The API has a collection ofProduct resources, named
projects/*/locations/*/products/*EachProduct has a collection ofReferenceImage resources,named
projects/*/locations/*/products/*/referenceImages/*
ProductSearchClient
Manages Products and ProductSets of reference images for use inproduct search. It uses the following resource model:
- The API has a collection ofProductSet resources, named
projects/*/locations/*/productSets/*, which acts as a way toput different products into groups to limit identification.
In parallel,
The API has a collection ofProduct resources, named
projects/*/locations/*/products/*EachProduct has a collection ofReferenceImage resources,named
projects/*/locations/*/products/*/referenceImages/*
ListProductSetsAsyncPager
A pager for iterating throughlist_product_sets requests.
This class thinly wraps an initialListProductSetsResponse object, andprovides an__aiter__ method to iterate through itsproduct_sets field.
If there are more pages, the__aiter__ method will make additionalListProductSets requests and continue to iteratethrough theproduct_sets field on thecorresponding responses.
All the usualListProductSetsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListProductSetsPager
A pager for iterating throughlist_product_sets requests.
This class thinly wraps an initialListProductSetsResponse object, andprovides an__iter__ method to iterate through itsproduct_sets field.
If there are more pages, the__iter__ method will make additionalListProductSets requests and continue to iteratethrough theproduct_sets field on thecorresponding responses.
All the usualListProductSetsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListProductsAsyncPager
A pager for iterating throughlist_products requests.
This class thinly wraps an initialListProductsResponse object, andprovides an__aiter__ method to iterate through itsproducts field.
If there are more pages, the__aiter__ method will make additionalListProducts requests and continue to iteratethrough theproducts field on thecorresponding responses.
All the usualListProductsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListProductsInProductSetAsyncPager
A pager for iterating throughlist_products_in_product_set requests.
This class thinly wraps an initialListProductsInProductSetResponse object, andprovides an__aiter__ method to iterate through itsproducts field.
If there are more pages, the__aiter__ method will make additionalListProductsInProductSet requests and continue to iteratethrough theproducts field on thecorresponding responses.
All the usualListProductsInProductSetResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListProductsInProductSetPager
A pager for iterating throughlist_products_in_product_set requests.
This class thinly wraps an initialListProductsInProductSetResponse object, andprovides an__iter__ method to iterate through itsproducts field.
If there are more pages, the__iter__ method will make additionalListProductsInProductSet requests and continue to iteratethrough theproducts field on thecorresponding responses.
All the usualListProductsInProductSetResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListProductsPager
A pager for iterating throughlist_products requests.
This class thinly wraps an initialListProductsResponse object, andprovides an__iter__ method to iterate through itsproducts field.
If there are more pages, the__iter__ method will make additionalListProducts requests and continue to iteratethrough theproducts field on thecorresponding responses.
All the usualListProductsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListReferenceImagesAsyncPager
A pager for iterating throughlist_reference_images requests.
This class thinly wraps an initialListReferenceImagesResponse object, andprovides an__aiter__ method to iterate through itsreference_images field.
If there are more pages, the__aiter__ method will make additionalListReferenceImages requests and continue to iteratethrough thereference_images field on thecorresponding responses.
All the usualListReferenceImagesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListReferenceImagesPager
A pager for iterating throughlist_reference_images requests.
This class thinly wraps an initialListReferenceImagesResponse object, andprovides an__iter__ method to iterate through itsreference_images field.
If there are more pages, the__iter__ method will make additionalListReferenceImages requests and continue to iteratethrough thereference_images field on thecorresponding responses.
All the usualListReferenceImagesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
AddProductToProductSetRequest
Request message for theAddProductToProductSet method.
AnnotateFileRequest
A request to annotate one single file, e.g. a PDF, TIFF orGIF file.
AnnotateFileResponse
Response to a single file annotation request. A file maycontain one or more images, which individually have their ownresponses.
AnnotateImageRequest
Request for performing Google Cloud Vision API tasks over auser-provided image, with user-requested features, and withcontext 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 asingle 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 theBatchAnnotateFiles 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 singleservice 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 themetadata field of theOperationreturned by theGetOperation call of thegoogle::longrunning::Operations service.
State
Enumerates the possible states that the batch request can bein.
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 thefraction of the image that the color occupies in the image.
CreateProductRequest
Request message for theCreateProduct method.
CreateProductSetRequest
Request message for theCreateProductSet method.
CreateReferenceImageRequest
Request message for theCreateReferenceImage method.
CropHint
Single crop hint that is used to generate a new crop whenserving an image.
CropHintsAnnotation
Set of crop hints that are used to generate new crops whenserving images.
CropHintsParams
Parameters for crop hints annotation request.
DeleteProductRequest
Request message for theDeleteProduct method.
DeleteProductSetRequest
Request message for theDeleteProductSet method.
DeleteReferenceImageRequest
Request message for theDeleteReferenceImage 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 facedetection.
Landmark
A face-specific landmark (for example, a face feature).
Type
Face landmark (feature) type. Left and right are defined from thevantage of the viewer of the image without considering mirrorprojections typical of photos. So,LEFT_EYE, typically, is theperson's right eye.
Feature
The type of Google Cloud Vision API detection to perform, and themaximum number of results to return for that type. MultipleFeature objects can be specified in thefeatures list.
Type
Type of Google Cloud Vision API feature to be extracted.
GcsDestination
The Google Cloud Storage location where the output will bewritten to.
GcsSource
The Google Cloud Storage location where the input will beread from.
GetProductRequest
Request message for theGetProduct method.
GetProductSetRequest
Request message for theGetProductSet method.
GetReferenceImageRequest
Request message for theGetReferenceImage 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), thismessage 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 imagelocation).
ImportProductSetsGcsSource
The Google Cloud Storage location for a csv file whichpreserves a list of ImportProductSetRequests in each line.
ImportProductSetsInputConfig
The input content for theImportProductSets method.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ImportProductSetsRequest
Request message for theImportProductSets method.
ImportProductSetsResponse
Response message for theImportProductSets method.
This message is returned by thegoogle.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation]method in the returnedgoogle.longrunning.Operation.response][google.longrunning.Operation.response]field.
InputConfig
The desired input location and metadata.
LatLongRect
Rectangle determined by min and maxLatLng pairs.
Likelihood
A bucketized representation of likelihood, which is intendedto give clients highly stable results across model upgrades.
ListProductSetsRequest
Request message for theListProductSets method.
ListProductSetsResponse
Response message for theListProductSets method.
ListProductsInProductSetRequest
Request message for theListProductsInProductSet method.
ListProductsInProductSetResponse
Response message for theListProductsInProductSet method.
ListProductsRequest
Request message for theListProducts method.
ListProductsResponse
Response message for theListProducts method.
ListReferenceImagesRequest
Request message for theListReferenceImages method.
ListReferenceImagesResponse
Response message for theListReferenceImages 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 theoriginal 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 incertain order.
Position
A 3D position in the image, used primarily for Face detectionlandmarks. A valid Position must have both x and y coordinates.The position coordinates are in the same scale as the originalimage.
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 ina 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 amaximum of 1 million reference images. If the limit is exceeded,periodic indexing will fail.
ProductSetPurgeConfig
Config to control which ProductSet contains the Products tobe deleted.
Property
AProperty consists of a user-supplied name/value pair.
PurgeProductsRequest
Request message for thePurgeProducts method.
This message hasoneof_ 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 othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ReferenceImage
AReferenceImage represents a product image and its associatedmetadata, such as bounding boxes.
RemoveProductFromProductSetRequest
Request message for theRemoveProductFromProductSet method.
SafeSearchAnnotation
Set of features pertaining to the image, computed by computervision methods over safe-search verticals (for example, adult,spoof, medical, violence).
Symbol
A single symbol representation.
TextAnnotation
TextAnnotation contains a structured representation of OCR extractedtext. The hierarchy of an OCR extracted text structure is like this:TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Eachstructural component, starting from Page, may further have their ownproperties. Properties describe detected languages, breaks etc..Please refer to theTextAnnotation.TextPropertymessage 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 controlTEXT_DETECTION and DOCUMENT_TEXT_DETECTION features.
UpdateProductRequest
Request message for theUpdateProduct method.
UpdateProductSetRequest
Request message for theUpdateProductSet method.
Vertex
A vertex represents a 2D point in the image.NOTE: the vertex coordinates are in the same scale as theoriginal 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 tasksover client images, such as face, landmark, logo, label, andtext detection. The ImageAnnotator service returns detectedentities from the images.
ImageAnnotatorClient
Service that performs Google Cloud Vision API detection tasksover client images, such as face, landmark, logo, label, andtext detection. The ImageAnnotator service returns detectedentities from the images.
AnnotateImageRequest
Request for performing Google Cloud Vision API tasks over auser-provided image, with user-requested features.
AnnotateImageResponse
Response to an image annotation request.
BatchAnnotateImagesRequest
Multiple image annotation requests are batched into a singleservice 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 thefraction of the image that the color occupies in the image.
CropHint
Single crop hint that is used to generate a new crop whenserving an image.
CropHintsAnnotation
Set of crop hints that are used to generate new crops whenserving 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 facedetection.
Landmark
A face-specific landmark (for example, a face feature).
Type
Face landmark (feature) type. Left and right are defined from thevantage of the viewer of the image without considering mirrorprojections typical of photos. So,LEFT_EYE, typically, is theperson's right eye.
Feature
Users describe the type of Google Cloud Vision API tasks to performover images by usingFeature\ s. Each Feature indicates a type ofimage detection task to perform. Features encode the Cloud VisionAPI vertical to operate on and the number of top-scoring results toreturn.
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 maxLatLng pairs.
Likelihood
A bucketized representation of likelihood, which is intendedto 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 incertain order.
Position
A 3D position in the image, used primarily for Face detectionlandmarks. A valid Position must have both x and y coordinates.The position coordinates are in the same scale as the originalimage.
Property
AProperty consists of a user-supplied name/value pair.
SafeSearchAnnotation
Set of features pertaining to the image, computed by computervision methods over safe-search verticals (for example, adult,spoof, medical, violence).
Symbol
A single symbol representation.
TextAnnotation
TextAnnotation contains a structured representation of OCR extractedtext. The hierarchy of an OCR extracted text structure is like this:TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Eachstructural component, starting from Page, may further have their ownproperties. Properties describe detected languages, breaks etc..Please refer to theTextAnnotation.TextPropertymessage 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 controlTEXT_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 theoriginal 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 tasksover client images, such as face, landmark, logo, label, andtext detection. The ImageAnnotator service returns detectedentities from the images.
ImageAnnotatorClient
Service that performs Google Cloud Vision API detection tasksover client images, such as face, landmark, logo, label, andtext detection. The ImageAnnotator service returns detectedentities from the images.
AnnotateFileResponse
Response to a single file annotation request. A file maycontain one or more images, which individually have their ownresponses.
AnnotateImageRequest
Request for performing Google Cloud Vision API tasks over auser-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 asingle service call.
AsyncBatchAnnotateFilesResponse
Response to an async batch file annotation request.
BatchAnnotateImagesRequest
Multiple image annotation requests are batched into a singleservice 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 thefraction of the image that the color occupies in the image.
CropHint
Single crop hint that is used to generate a new crop whenserving an image.
CropHintsAnnotation
Set of crop hints that are used to generate new crops whenserving 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 facedetection.
Landmark
A face-specific landmark (for example, a face feature).
Type
Face landmark (feature) type. Left and right are defined from thevantage of the viewer of the image without considering mirrorprojections typical of photos. So,LEFT_EYE, typically, is theperson's right eye.
Feature
The type of Google Cloud Vision API detection to perform, and themaximum number of results to return for that type. MultipleFeature objects can be specified in thefeatures list.
Type
Type of Google Cloud Vision API feature to be extracted.
GcsDestination
The Google Cloud Storage location where the output will bewritten to.
GcsSource
The Google Cloud Storage location where the input will beread 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), thismessage 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 imagelocation).
InputConfig
The desired input location and metadata.
LatLongRect
Rectangle determined by min and maxLatLng pairs.
Likelihood
A bucketized representation of likelihood, which is intendedto 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 theoriginal 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 incertain order.
Position
A 3D position in the image, used primarily for Face detectionlandmarks. A valid Position must have both x and y coordinates.The position coordinates are in the same scale as the originalimage.
Property
AProperty consists of a user-supplied name/value pair.
SafeSearchAnnotation
Set of features pertaining to the image, computed by computervision methods over safe-search verticals (for example, adult,spoof, medical, violence).
Symbol
A single symbol representation.
TextAnnotation
TextAnnotation contains a structured representation of OCR extractedtext. The hierarchy of an OCR extracted text structure is like this:TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Eachstructural component, starting from Page, may further have their ownproperties. Properties describe detected languages, breaks etc..Please refer to theTextAnnotation.TextPropertymessage 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 controlTEXT_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 theoriginal 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 tasksover client images, such as face, landmark, logo, label, andtext detection. The ImageAnnotator service returns detectedentities from the images.
ImageAnnotatorClient
Service that performs Google Cloud Vision API detection tasksover client images, such as face, landmark, logo, label, andtext detection. The ImageAnnotator service returns detectedentities from the images.
ProductSearchAsyncClient
Manages Products and ProductSets of reference images for use inproduct search. It uses the following resource model:
- The API has a collection ofProductSet resources,named
projects/*/locations/*/productSets/*, which acts as away to put different products into groups to limit identification.
In parallel,
The API has a collection ofProduct resources, named
projects/*/locations/*/products/*EachProduct has acollection ofReferenceImageresources, named
projects/*/locations/*/products/*/referenceImages/*
ProductSearchClient
Manages Products and ProductSets of reference images for use inproduct search. It uses the following resource model:
- The API has a collection ofProductSet resources,named
projects/*/locations/*/productSets/*, which acts as away to put different products into groups to limit identification.
In parallel,
The API has a collection ofProduct resources, named
projects/*/locations/*/products/*EachProduct has acollection ofReferenceImageresources, named
projects/*/locations/*/products/*/referenceImages/*
ListProductSetsAsyncPager
A pager for iterating throughlist_product_sets requests.
This class thinly wraps an initialListProductSetsResponse object, andprovides an__aiter__ method to iterate through itsproduct_sets field.
If there are more pages, the__aiter__ method will make additionalListProductSets requests and continue to iteratethrough theproduct_sets field on thecorresponding responses.
All the usualListProductSetsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListProductSetsPager
A pager for iterating throughlist_product_sets requests.
This class thinly wraps an initialListProductSetsResponse object, andprovides an__iter__ method to iterate through itsproduct_sets field.
If there are more pages, the__iter__ method will make additionalListProductSets requests and continue to iteratethrough theproduct_sets field on thecorresponding responses.
All the usualListProductSetsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListProductsAsyncPager
A pager for iterating throughlist_products requests.
This class thinly wraps an initialListProductsResponse object, andprovides an__aiter__ method to iterate through itsproducts field.
If there are more pages, the__aiter__ method will make additionalListProducts requests and continue to iteratethrough theproducts field on thecorresponding responses.
All the usualListProductsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListProductsInProductSetAsyncPager
A pager for iterating throughlist_products_in_product_set requests.
This class thinly wraps an initialListProductsInProductSetResponse object, andprovides an__aiter__ method to iterate through itsproducts field.
If there are more pages, the__aiter__ method will make additionalListProductsInProductSet requests and continue to iteratethrough theproducts field on thecorresponding responses.
All the usualListProductsInProductSetResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListProductsInProductSetPager
A pager for iterating throughlist_products_in_product_set requests.
This class thinly wraps an initialListProductsInProductSetResponse object, andprovides an__iter__ method to iterate through itsproducts field.
If there are more pages, the__iter__ method will make additionalListProductsInProductSet requests and continue to iteratethrough theproducts field on thecorresponding responses.
All the usualListProductsInProductSetResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListProductsPager
A pager for iterating throughlist_products requests.
This class thinly wraps an initialListProductsResponse object, andprovides an__iter__ method to iterate through itsproducts field.
If there are more pages, the__iter__ method will make additionalListProducts requests and continue to iteratethrough theproducts field on thecorresponding responses.
All the usualListProductsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListReferenceImagesAsyncPager
A pager for iterating throughlist_reference_images requests.
This class thinly wraps an initialListReferenceImagesResponse object, andprovides an__aiter__ method to iterate through itsreference_images field.
If there are more pages, the__aiter__ method will make additionalListReferenceImages requests and continue to iteratethrough thereference_images field on thecorresponding responses.
All the usualListReferenceImagesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListReferenceImagesPager
A pager for iterating throughlist_reference_images requests.
This class thinly wraps an initialListReferenceImagesResponse object, andprovides an__iter__ method to iterate through itsreference_images field.
If there are more pages, the__iter__ method will make additionalListReferenceImages requests and continue to iteratethrough thereference_images field on thecorresponding responses.
All the usualListReferenceImagesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
AddProductToProductSetRequest
Request message for theAddProductToProductSet method.
AnnotateFileResponse
Response to a single file annotation request. A file maycontain one or more images, which individually have their ownresponses.
AnnotateImageRequest
Request for performing Google Cloud Vision API tasks over auser-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 asingle service call.
AsyncBatchAnnotateFilesResponse
Response to an async batch file annotation request.
BatchAnnotateImagesRequest
Multiple image annotation requests are batched into a singleservice call.
BatchAnnotateImagesResponse
Response to a batch image annotation request.
BatchOperationMetadata
Metadata for the batch operations such as the current state.
This is included in themetadata field of theOperationreturned by theGetOperation call of thegoogle::longrunning::Operations service.
State
Enumerates the possible states that the batch request can bein.
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 thefraction of the image that the color occupies in the image.
CreateProductRequest
Request message for theCreateProduct method.
CreateProductSetRequest
Request message for theCreateProductSet method.
CreateReferenceImageRequest
Request message for theCreateReferenceImage method.
CropHint
Single crop hint that is used to generate a new crop whenserving an image.
CropHintsAnnotation
Set of crop hints that are used to generate new crops whenserving images.
CropHintsParams
Parameters for crop hints annotation request.
DeleteProductRequest
Request message for theDeleteProduct method.
DeleteProductSetRequest
Request message for theDeleteProductSet method.
DeleteReferenceImageRequest
Request message for theDeleteReferenceImage 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 facedetection.
Landmark
A face-specific landmark (for example, a face feature).
Type
Face landmark (feature) type. Left and right are defined from thevantage of the viewer of the image without considering mirrorprojections typical of photos. So,LEFT_EYE, typically, is theperson's right eye.
Feature
The type of Google Cloud Vision API detection to perform, and themaximum number of results to return for that type. MultipleFeature objects can be specified in thefeatures list.
Type
Type of Google Cloud Vision API feature to be extracted.
GcsDestination
The Google Cloud Storage location where the output will bewritten to.
GcsSource
The Google Cloud Storage location where the input will beread from.
GetProductRequest
Request message for theGetProduct method.
GetProductSetRequest
Request message for theGetProductSet method.
GetReferenceImageRequest
Request message for theGetReferenceImage 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), thismessage 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 imagelocation).
ImportProductSetsGcsSource
The Google Cloud Storage location for a csv file whichpreserves a list of ImportProductSetRequests in each line.
ImportProductSetsInputConfig
The input content for theImportProductSets method.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ImportProductSetsRequest
Request message for theImportProductSets method.
ImportProductSetsResponse
Response message for theImportProductSets method.
This message is returned by thegoogle.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation]method in the returnedgoogle.longrunning.Operation.response][google.longrunning.Operation.response]field.
InputConfig
The desired input location and metadata.
LatLongRect
Rectangle determined by min and maxLatLng pairs.
Likelihood
A bucketized representation of likelihood, which is intendedto give clients highly stable results across model upgrades.
ListProductSetsRequest
Request message for theListProductSets method.
ListProductSetsResponse
Response message for theListProductSets method.
ListProductsInProductSetRequest
Request message for theListProductsInProductSet method.
ListProductsInProductSetResponse
Response message for theListProductsInProductSet method.
ListProductsRequest
Request message for theListProducts method.
ListProductsResponse
Response message for theListProducts method.
ListReferenceImagesRequest
Request message for theListReferenceImages method.
ListReferenceImagesResponse
Response message for theListReferenceImages 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 theoriginal 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 incertain order.
Position
A 3D position in the image, used primarily for Face detectionlandmarks. A valid Position must have both x and y coordinates.The position coordinates are in the same scale as the originalimage.
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 ina 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 amaximum of 1 million reference images. If the limit is exceeded,periodic indexing will fail.
Property
AProperty consists of a user-supplied name/value pair.
ReferenceImage
AReferenceImage represents a product image and its associatedmetadata, such as bounding boxes.
RemoveProductFromProductSetRequest
Request message for theRemoveProductFromProductSet method.
SafeSearchAnnotation
Set of features pertaining to the image, computed by computervision methods over safe-search verticals (for example, adult,spoof, medical, violence).
Symbol
A single symbol representation.
TextAnnotation
TextAnnotation contains a structured representation of OCR extractedtext. The hierarchy of an OCR extracted text structure is like this:TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Eachstructural component, starting from Page, may further have their ownproperties. Properties describe detected languages, breaks etc..Please refer to theTextAnnotation.TextPropertymessage 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 controlTEXT_DETECTION and DOCUMENT_TEXT_DETECTION features.
UpdateProductRequest
Request message for theUpdateProduct method.
UpdateProductSetRequest
Request message for theUpdateProductSet method.
Vertex
A vertex represents a 2D point in the image.NOTE: the vertex coordinates are in the same scale as theoriginal 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 tasksover client images, such as face, landmark, logo, label, andtext detection. The ImageAnnotator service returns detectedentities from the images.
ImageAnnotatorClient
Service that performs Google Cloud Vision API detection tasksover client images, such as face, landmark, logo, label, andtext detection. The ImageAnnotator service returns detectedentities from the images.
ProductSearchAsyncClient
Manages Products and ProductSets of reference images for use inproduct search. It uses the following resource model:
- The API has a collection ofProductSet resources,named
projects/*/locations/*/productSets/*, which acts as away to put different products into groups to limit identification.
In parallel,
The API has a collection ofProduct resources, named
projects/*/locations/*/products/*EachProduct has acollection ofReferenceImageresources, named
projects/*/locations/*/products/*/referenceImages/*
ProductSearchClient
Manages Products and ProductSets of reference images for use inproduct search. It uses the following resource model:
- The API has a collection ofProductSet resources,named
projects/*/locations/*/productSets/*, which acts as away to put different products into groups to limit identification.
In parallel,
The API has a collection ofProduct resources, named
projects/*/locations/*/products/*EachProduct has acollection ofReferenceImageresources, named
projects/*/locations/*/products/*/referenceImages/*
ListProductSetsAsyncPager
A pager for iterating throughlist_product_sets requests.
This class thinly wraps an initialListProductSetsResponse object, andprovides an__aiter__ method to iterate through itsproduct_sets field.
If there are more pages, the__aiter__ method will make additionalListProductSets requests and continue to iteratethrough theproduct_sets field on thecorresponding responses.
All the usualListProductSetsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListProductSetsPager
A pager for iterating throughlist_product_sets requests.
This class thinly wraps an initialListProductSetsResponse object, andprovides an__iter__ method to iterate through itsproduct_sets field.
If there are more pages, the__iter__ method will make additionalListProductSets requests and continue to iteratethrough theproduct_sets field on thecorresponding responses.
All the usualListProductSetsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListProductsAsyncPager
A pager for iterating throughlist_products requests.
This class thinly wraps an initialListProductsResponse object, andprovides an__aiter__ method to iterate through itsproducts field.
If there are more pages, the__aiter__ method will make additionalListProducts requests and continue to iteratethrough theproducts field on thecorresponding responses.
All the usualListProductsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListProductsInProductSetAsyncPager
A pager for iterating throughlist_products_in_product_set requests.
This class thinly wraps an initialListProductsInProductSetResponse object, andprovides an__aiter__ method to iterate through itsproducts field.
If there are more pages, the__aiter__ method will make additionalListProductsInProductSet requests and continue to iteratethrough theproducts field on thecorresponding responses.
All the usualListProductsInProductSetResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListProductsInProductSetPager
A pager for iterating throughlist_products_in_product_set requests.
This class thinly wraps an initialListProductsInProductSetResponse object, andprovides an__iter__ method to iterate through itsproducts field.
If there are more pages, the__iter__ method will make additionalListProductsInProductSet requests and continue to iteratethrough theproducts field on thecorresponding responses.
All the usualListProductsInProductSetResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListProductsPager
A pager for iterating throughlist_products requests.
This class thinly wraps an initialListProductsResponse object, andprovides an__iter__ method to iterate through itsproducts field.
If there are more pages, the__iter__ method will make additionalListProducts requests and continue to iteratethrough theproducts field on thecorresponding responses.
All the usualListProductsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListReferenceImagesAsyncPager
A pager for iterating throughlist_reference_images requests.
This class thinly wraps an initialListReferenceImagesResponse object, andprovides an__aiter__ method to iterate through itsreference_images field.
If there are more pages, the__aiter__ method will make additionalListReferenceImages requests and continue to iteratethrough thereference_images field on thecorresponding responses.
All the usualListReferenceImagesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListReferenceImagesPager
A pager for iterating throughlist_reference_images requests.
This class thinly wraps an initialListReferenceImagesResponse object, andprovides an__iter__ method to iterate through itsreference_images field.
If there are more pages, the__iter__ method will make additionalListReferenceImages requests and continue to iteratethrough thereference_images field on thecorresponding responses.
All the usualListReferenceImagesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
AddProductToProductSetRequest
Request message for theAddProductToProductSet method.
AnnotateFileRequest
A request to annotate one single file, e.g. a PDF, TIFF orGIF file.
AnnotateFileResponse
Response to a single file annotation request. A file maycontain one or more images, which individually have their ownresponses.
AnnotateImageRequest
Request for performing Google Cloud Vision API tasks over auser-provided image, with user-requested features, and withcontext 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 asingle 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 theBatchAnnotateFiles API.
BatchAnnotateFilesResponse
A list of file annotation responses.
BatchAnnotateImagesRequest
Multiple image annotation requests are batched into a singleservice call.
BatchAnnotateImagesResponse
Response to a batch image annotation request.
BatchOperationMetadata
Metadata for the batch operations such as the current state.
This is included in themetadata field of theOperationreturned by theGetOperation call of thegoogle::longrunning::Operations service.
State
Enumerates the possible states that the batch request can bein.
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 thefraction of the image that the color occupies in the image.
CreateProductRequest
Request message for theCreateProduct method.
CreateProductSetRequest
Request message for theCreateProductSet method.
CreateReferenceImageRequest
Request message for theCreateReferenceImage method.
CropHint
Single crop hint that is used to generate a new crop whenserving an image.
CropHintsAnnotation
Set of crop hints that are used to generate new crops whenserving images.
CropHintsParams
Parameters for crop hints annotation request.
DeleteProductRequest
Request message for theDeleteProduct method.
DeleteProductSetRequest
Request message for theDeleteProductSet method.
DeleteReferenceImageRequest
Request message for theDeleteReferenceImage 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 facedetection.
Landmark
A face-specific landmark (for example, a face feature).
Type
Face landmark (feature) type. Left and right are defined from thevantage of the viewer of the image without considering mirrorprojections typical of photos. So,LEFT_EYE, typically, is theperson'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 themaximum number of results to return for that type. MultipleFeature objects can be specified in thefeatures list.
Type
Type of Google Cloud Vision API feature to be extracted.
GcsDestination
The Google Cloud Storage location where the output will bewritten to.
GcsSource
The Google Cloud Storage location where the input will beread from.
GetProductRequest
Request message for theGetProduct method.
GetProductSetRequest
Request message for theGetProductSet method.
GetReferenceImageRequest
Request message for theGetReferenceImage 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), thismessage 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 imagelocation).
ImportProductSetsGcsSource
The Google Cloud Storage location for a csv file whichpreserves a list of ImportProductSetRequests in each line.
ImportProductSetsInputConfig
The input content for theImportProductSets method.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ImportProductSetsRequest
Request message for theImportProductSets method.
ImportProductSetsResponse
Response message for theImportProductSets method.
This message is returned by thegoogle.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation]method in the returnedgoogle.longrunning.Operation.response][google.longrunning.Operation.response]field.
InputConfig
The desired input location and metadata.
LatLongRect
Rectangle determined by min and maxLatLng pairs.
Likelihood
A bucketized representation of likelihood, which is intendedto give clients highly stable results across model upgrades.
ListProductSetsRequest
Request message for theListProductSets method.
ListProductSetsResponse
Response message for theListProductSets method.
ListProductsInProductSetRequest
Request message for theListProductsInProductSet method.
ListProductsInProductSetResponse
Response message for theListProductsInProductSet method.
ListProductsRequest
Request message for theListProducts method.
ListProductsResponse
Response message for theListProducts method.
ListReferenceImagesRequest
Request message for theListReferenceImages method.
ListReferenceImagesResponse
Response message for theListReferenceImages 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 theoriginal 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 incertain order.
Position
A 3D position in the image, used primarily for Face detectionlandmarks. A valid Position must have both x and y coordinates.The position coordinates are in the same scale as the originalimage.
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 ina 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 amaximum of 1 million reference images. If the limit is exceeded,periodic indexing will fail.
ProductSetPurgeConfig
Config to control which ProductSet contains the Products tobe deleted.
Property
AProperty consists of a user-supplied name/value pair.
PurgeProductsRequest
Request message for thePurgeProducts method.
This message hasoneof_ 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 othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ReferenceImage
AReferenceImage represents a product image and its associatedmetadata, such as bounding boxes.
RemoveProductFromProductSetRequest
Request message for theRemoveProductFromProductSet method.
SafeSearchAnnotation
Set of features pertaining to the image, computed by computervision methods over safe-search verticals (for example, adult,spoof, medical, violence).
Symbol
A single symbol representation.
TextAnnotation
TextAnnotation contains a structured representation of OCR extractedtext. The hierarchy of an OCR extracted text structure is like this:TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Eachstructural component, starting from Page, may further have their ownproperties. Properties describe detected languages, breaks etc..Please refer to theTextAnnotation.TextPropertymessage 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 controlTEXT_DETECTION and DOCUMENT_TEXT_DETECTION features.
UpdateProductRequest
Request message for theUpdateProduct method.
UpdateProductSetRequest
Request message for theUpdateProductSet method.
Vertex
A vertex represents a 2D point in the image.NOTE: the vertex coordinates are in the same scale as theoriginal 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 forvision_v1.services.product_search.pagers module.
pagers
API documentation forvision_v1p3beta1.services.product_search.pagers module.
pagers
API documentation forvision_v1p4beta1.services.product_search.pagers module.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.