Classes
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.
AnnotateImageException
An error occurring when annotating an image.
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.
BatchOperationMetadata.Types
Container for nested types declared in the BatchOperationMetadata message type.
Block
Logical element on the page.
Block.Types
Container for nested types declared in the Block message type.
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.
FaceAnnotation.Types
Container for nested types declared in the FaceAnnotation message type.
FaceAnnotation.Types.Landmark
A face-specific landmark (for example, a face feature).
FaceAnnotation.Types.Landmark.Types
Container for nested types declared in the Landmark message type.
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.
Feature.Types
Container for nested types declared in the Feature message type.
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.
ImageAnnotator
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.
ImageAnnotator.ImageAnnotatorBase
Base class for server-side implementations of ImageAnnotator
ImageAnnotator.ImageAnnotatorClient
Client for ImageAnnotator
ImageAnnotatorClient
ImageAnnotator client wrapper, for convenient use.
ImageAnnotatorClientBuilder
Builder class for ImageAnnotatorClient to provide simple configuration of credentials, endpoint etc.
ImageAnnotatorClientImpl
ImageAnnotator client wrapper implementation, for convenient use.
ImageAnnotatorSettings
Settings for ImageAnnotatorClient instances.
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.
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.
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.
OperationMetadata.Types
Container for nested types declared in the OperationMetadata message type.
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.
Product.Types
Container for nested types declared in the Product message type.
Product.Types.KeyValue
A product label represented as a key-value pair.
ProductName
Resource name for the Product
resource.
ProductSearch
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][google.cloud.vision.v1.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][google.cloud.vision.v1.Product] resources, named
projects/*/locations/*/products/*
Each [Product][google.cloud.vision.v1.Product] has a collection of [ReferenceImage][google.cloud.vision.v1.ReferenceImage] resources, named
projects/*/locations/*/products/*/referenceImages/*
ProductSearch.ProductSearchBase
Base class for server-side implementations of ProductSearch
ProductSearch.ProductSearchClient
Client for ProductSearch
ProductSearchClient
ProductSearch client wrapper, for convenient use.
ProductSearchClientBuilder
Builder class for ProductSearchClient to provide simple configuration of credentials, endpoint etc.
ProductSearchClientImpl
ProductSearch client wrapper implementation, for convenient use.
ProductSearchParams
Parameters for a product search request.
ProductSearchResults
Results for a product search request.
ProductSearchResults.Types
Container for nested types declared in the ProductSearchResults message type.
ProductSearchResults.Types.GroupedResult
Information about the products similar to a single product in a query image.
ProductSearchResults.Types.ObjectAnnotation
Prediction for what the object in the bounding box is.
ProductSearchResults.Types.Result
Information about a product.
ProductSearchSettings
Settings for ProductSearchClient instances.
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.
ProductSetName
Resource name for the ProductSet
resource.
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.
ReferenceImage
A ReferenceImage
represents a product image and its associated metadata,
such as bounding boxes.
ReferenceImageName
Resource name for the ReferenceImage
resource.
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][google.cloud.vision.v1.TextAnnotation.TextProperty] message definition below for more detail.
TextAnnotation.Types
Container for nested types declared in the TextAnnotation message type.
TextAnnotation.Types.DetectedBreak
Detected start or end of a structural component.
TextAnnotation.Types.DetectedBreak.Types
Container for nested types declared in the DetectedBreak message type.
TextAnnotation.Types.DetectedLanguage
Detected language for a structural component.
TextAnnotation.Types.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.
WebDetection.Types
Container for nested types declared in the WebDetection message type.
WebDetection.Types.WebEntity
Entity deduced from similar images on the Internet.
WebDetection.Types.WebImage
Metadata for online images.
WebDetection.Types.WebLabel
Label to provide extra metadata for the web detection.
WebDetection.Types.WebPage
Metadata for web pages.
WebDetectionParams
Parameters for web detection request.
Word
A word representation.
Enums
BatchOperationMetadata.Types.State
Enumerates the possible states that the batch request can be in.
Block.Types.BlockType
Type of a block (text, image etc) as identified by OCR.
FaceAnnotation.Types.Landmark.Types.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.Types.Type
Type of Google Cloud Vision API feature to be extracted.
ImportProductSetsInputConfig.SourceOneofCase
Enum of possible cases for the "source" oneof.
Likelihood
A bucketized representation of likelihood, which is intended to give clients highly stable results across model upgrades.
OperationMetadata.Types.State
Batch operation states.
ProductName.ResourceNameType
The possible contents of ProductName.
ProductSetName.ResourceNameType
The possible contents of ProductSetName.
PurgeProductsRequest.TargetOneofCase
Enum of possible cases for the "target" oneof.
ReferenceImageName.ResourceNameType
The possible contents of ReferenceImageName.
TextAnnotation.Types.DetectedBreak.Types.BreakType
Enum to denote the type of break found. New line, space etc.