Package com.google.cloud.vision.v1 (3.1.0)

A client to Cloud Vision API

The interfaces provided are listed below, along with usage samples.

ImageAnnotatorClient

Service Description: 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.

Sample for ImageAnnotatorClient:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
   List<AnnotateImageRequest> requests = new ArrayList<>();
   BatchAnnotateImagesResponse response = imageAnnotatorClient.batchAnnotateImages(requests);
 }

ProductSearchClient

Service Description: 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/*

Sample for ProductSearchClient:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ProductSet productSet = ProductSet.newBuilder().build();
   String productSetId = "productSetId1003042158";
   ProductSet response = productSearchClient.createProductSet(parent, productSet, productSetId);
 }

Classes

AddProductToProductSetRequest

Request message for the AddProductToProductSet method.

Protobuf type google.cloud.vision.v1.AddProductToProductSetRequest

AddProductToProductSetRequest.Builder

Request message for the AddProductToProductSet method.

Protobuf type google.cloud.vision.v1.AddProductToProductSetRequest

AnnotateFileRequest

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

Protobuf type google.cloud.vision.v1.AnnotateFileRequest

AnnotateFileRequest.Builder

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

Protobuf type google.cloud.vision.v1.AnnotateFileRequest

AnnotateFileResponse

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

Protobuf type google.cloud.vision.v1.AnnotateFileResponse

AnnotateFileResponse.Builder

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

Protobuf type google.cloud.vision.v1.AnnotateFileResponse

AnnotateImageRequest

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

Protobuf type google.cloud.vision.v1.AnnotateImageRequest

AnnotateImageRequest.Builder

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

Protobuf type google.cloud.vision.v1.AnnotateImageRequest

AnnotateImageResponse

Response to an image annotation request.

Protobuf type google.cloud.vision.v1.AnnotateImageResponse

AnnotateImageResponse.Builder

Response to an image annotation request.

Protobuf type google.cloud.vision.v1.AnnotateImageResponse

AsyncAnnotateFileRequest

An offline file annotation request.

Protobuf type google.cloud.vision.v1.AsyncAnnotateFileRequest

AsyncAnnotateFileRequest.Builder

An offline file annotation request.

Protobuf type google.cloud.vision.v1.AsyncAnnotateFileRequest

AsyncAnnotateFileResponse

The response for a single offline file annotation request.

Protobuf type google.cloud.vision.v1.AsyncAnnotateFileResponse

AsyncAnnotateFileResponse.Builder

The response for a single offline file annotation request.

Protobuf type google.cloud.vision.v1.AsyncAnnotateFileResponse

AsyncBatchAnnotateFilesRequest

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

Protobuf type google.cloud.vision.v1.AsyncBatchAnnotateFilesRequest

AsyncBatchAnnotateFilesRequest.Builder

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

Protobuf type google.cloud.vision.v1.AsyncBatchAnnotateFilesRequest

AsyncBatchAnnotateFilesResponse

Response to an async batch file annotation request.

Protobuf type google.cloud.vision.v1.AsyncBatchAnnotateFilesResponse

AsyncBatchAnnotateFilesResponse.Builder

Response to an async batch file annotation request.

Protobuf type google.cloud.vision.v1.AsyncBatchAnnotateFilesResponse

AsyncBatchAnnotateImagesRequest

Request for async image annotation for a list of images.

Protobuf type google.cloud.vision.v1.AsyncBatchAnnotateImagesRequest

AsyncBatchAnnotateImagesRequest.Builder

Request for async image annotation for a list of images.

Protobuf type google.cloud.vision.v1.AsyncBatchAnnotateImagesRequest

AsyncBatchAnnotateImagesResponse

Response to an async batch image annotation request.

Protobuf type google.cloud.vision.v1.AsyncBatchAnnotateImagesResponse

AsyncBatchAnnotateImagesResponse.Builder

Response to an async batch image annotation request.

Protobuf type google.cloud.vision.v1.AsyncBatchAnnotateImagesResponse

BatchAnnotateFilesRequest

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

Protobuf type google.cloud.vision.v1.BatchAnnotateFilesRequest

BatchAnnotateFilesRequest.Builder

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

Protobuf type google.cloud.vision.v1.BatchAnnotateFilesRequest

BatchAnnotateFilesResponse

A list of file annotation responses.

Protobuf type google.cloud.vision.v1.BatchAnnotateFilesResponse

BatchAnnotateFilesResponse.Builder

A list of file annotation responses.

Protobuf type google.cloud.vision.v1.BatchAnnotateFilesResponse

BatchAnnotateImagesRequest

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

Protobuf type google.cloud.vision.v1.BatchAnnotateImagesRequest

BatchAnnotateImagesRequest.Builder

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

Protobuf type google.cloud.vision.v1.BatchAnnotateImagesRequest

BatchAnnotateImagesResponse

Response to a batch image annotation request.

Protobuf type google.cloud.vision.v1.BatchAnnotateImagesResponse

BatchAnnotateImagesResponse.Builder

Response to a batch image annotation request.

Protobuf type google.cloud.vision.v1.BatchAnnotateImagesResponse

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.

Protobuf type google.cloud.vision.v1.BatchOperationMetadata

BatchOperationMetadata.Builder

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.

Protobuf type google.cloud.vision.v1.BatchOperationMetadata

Block

Logical element on the page.

Protobuf type google.cloud.vision.v1.Block

Block.Builder

Logical element on the page.

Protobuf type google.cloud.vision.v1.Block

BoundingPoly

A bounding polygon for the detected image annotation.

Protobuf type google.cloud.vision.v1.BoundingPoly

BoundingPoly.Builder

A bounding polygon for the detected image annotation.

Protobuf type google.cloud.vision.v1.BoundingPoly

ColorInfo

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

Protobuf type google.cloud.vision.v1.ColorInfo

ColorInfo.Builder

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

Protobuf type google.cloud.vision.v1.ColorInfo

CreateProductRequest

Request message for the CreateProduct method.

Protobuf type google.cloud.vision.v1.CreateProductRequest

CreateProductRequest.Builder

Request message for the CreateProduct method.

Protobuf type google.cloud.vision.v1.CreateProductRequest

CreateProductSetRequest

Request message for the CreateProductSet method.

Protobuf type google.cloud.vision.v1.CreateProductSetRequest

CreateProductSetRequest.Builder

Request message for the CreateProductSet method.

Protobuf type google.cloud.vision.v1.CreateProductSetRequest

CreateReferenceImageRequest

Request message for the CreateReferenceImage method.

Protobuf type google.cloud.vision.v1.CreateReferenceImageRequest

CreateReferenceImageRequest.Builder

Request message for the CreateReferenceImage method.

Protobuf type google.cloud.vision.v1.CreateReferenceImageRequest

CropHint

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

Protobuf type google.cloud.vision.v1.CropHint

CropHint.Builder

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

Protobuf type google.cloud.vision.v1.CropHint

CropHintsAnnotation

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

Protobuf type google.cloud.vision.v1.CropHintsAnnotation

CropHintsAnnotation.Builder

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

Protobuf type google.cloud.vision.v1.CropHintsAnnotation

CropHintsParams

Parameters for crop hints annotation request.

Protobuf type google.cloud.vision.v1.CropHintsParams

CropHintsParams.Builder

Parameters for crop hints annotation request.

Protobuf type google.cloud.vision.v1.CropHintsParams

DeleteProductRequest

Request message for the DeleteProduct method.

Protobuf type google.cloud.vision.v1.DeleteProductRequest

DeleteProductRequest.Builder

Request message for the DeleteProduct method.

Protobuf type google.cloud.vision.v1.DeleteProductRequest

DeleteProductSetRequest

Request message for the DeleteProductSet method.

Protobuf type google.cloud.vision.v1.DeleteProductSetRequest

DeleteProductSetRequest.Builder

Request message for the DeleteProductSet method.

Protobuf type google.cloud.vision.v1.DeleteProductSetRequest

DeleteReferenceImageRequest

Request message for the DeleteReferenceImage method.

Protobuf type google.cloud.vision.v1.DeleteReferenceImageRequest

DeleteReferenceImageRequest.Builder

Request message for the DeleteReferenceImage method.

Protobuf type google.cloud.vision.v1.DeleteReferenceImageRequest

DominantColorsAnnotation

Set of dominant colors and their corresponding scores.

Protobuf type google.cloud.vision.v1.DominantColorsAnnotation

DominantColorsAnnotation.Builder

Set of dominant colors and their corresponding scores.

Protobuf type google.cloud.vision.v1.DominantColorsAnnotation

EntityAnnotation

Set of detected entity features.

Protobuf type google.cloud.vision.v1.EntityAnnotation

EntityAnnotation.Builder

Set of detected entity features.

Protobuf type google.cloud.vision.v1.EntityAnnotation

FaceAnnotation

A face annotation object contains the results of face detection.

Protobuf type google.cloud.vision.v1.FaceAnnotation

FaceAnnotation.Builder

A face annotation object contains the results of face detection.

Protobuf type google.cloud.vision.v1.FaceAnnotation

FaceAnnotation.Landmark

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

Protobuf type google.cloud.vision.v1.FaceAnnotation.Landmark

FaceAnnotation.Landmark.Builder

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

Protobuf type google.cloud.vision.v1.FaceAnnotation.Landmark

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.

Protobuf type google.cloud.vision.v1.Feature

Feature.Builder

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.

Protobuf type google.cloud.vision.v1.Feature

GcsDestination

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

Protobuf type google.cloud.vision.v1.GcsDestination

GcsDestination.Builder

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

Protobuf type google.cloud.vision.v1.GcsDestination

GcsSource

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

Protobuf type google.cloud.vision.v1.GcsSource

GcsSource.Builder

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

Protobuf type google.cloud.vision.v1.GcsSource

GeometryProto

GetProductRequest

Request message for the GetProduct method.

Protobuf type google.cloud.vision.v1.GetProductRequest

GetProductRequest.Builder

Request message for the GetProduct method.

Protobuf type google.cloud.vision.v1.GetProductRequest

GetProductSetRequest

Request message for the GetProductSet method.

Protobuf type google.cloud.vision.v1.GetProductSetRequest

GetProductSetRequest.Builder

Request message for the GetProductSet method.

Protobuf type google.cloud.vision.v1.GetProductSetRequest

GetReferenceImageRequest

Request message for the GetReferenceImage method.

Protobuf type google.cloud.vision.v1.GetReferenceImageRequest

GetReferenceImageRequest.Builder

Request message for the GetReferenceImage method.

Protobuf type google.cloud.vision.v1.GetReferenceImageRequest

Image

Client image to perform Google Cloud Vision API tasks over.

Protobuf type google.cloud.vision.v1.Image

Image.Builder

Client image to perform Google Cloud Vision API tasks over.

Protobuf type google.cloud.vision.v1.Image

ImageAnnotationContext

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

Protobuf type google.cloud.vision.v1.ImageAnnotationContext

ImageAnnotationContext.Builder

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

Protobuf type google.cloud.vision.v1.ImageAnnotationContext

ImageAnnotatorClient

Service Description: 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.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
   List<AnnotateImageRequest> requests = new ArrayList<>();
   BatchAnnotateImagesResponse response = imageAnnotatorClient.batchAnnotateImages(requests);
 }

Note: close() needs to be called on the ImageAnnotatorClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ImageAnnotatorSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ImageAnnotatorSettings imageAnnotatorSettings =
     ImageAnnotatorSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create(imageAnnotatorSettings);

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ImageAnnotatorSettings imageAnnotatorSettings =
     ImageAnnotatorSettings.newBuilder().setEndpoint(myEndpoint).build();
 ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create(imageAnnotatorSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ImageAnnotatorSettings imageAnnotatorSettings =
     ImageAnnotatorSettings.newBuilder()
         .setTransportChannelProvider(
             ImageAnnotatorSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create(imageAnnotatorSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

ImageAnnotatorGrpc

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.

ImageAnnotatorGrpc.ImageAnnotatorBlockingStub

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.

ImageAnnotatorGrpc.ImageAnnotatorFutureStub

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.

ImageAnnotatorGrpc.ImageAnnotatorImplBase

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.

ImageAnnotatorGrpc.ImageAnnotatorStub

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.

ImageAnnotatorProto

ImageAnnotatorSettings

Settings class to configure an instance of ImageAnnotatorClient.

The default instance has everything set to sensible defaults:

  • The default service address (vision.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of batchAnnotateImages to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ImageAnnotatorSettings.Builder imageAnnotatorSettingsBuilder =
     ImageAnnotatorSettings.newBuilder();
 imageAnnotatorSettingsBuilder
     .batchAnnotateImagesSettings()
     .setRetrySettings(
         imageAnnotatorSettingsBuilder
             .batchAnnotateImagesSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ImageAnnotatorSettings imageAnnotatorSettings = imageAnnotatorSettingsBuilder.build();

ImageAnnotatorSettings.Builder

Builder for ImageAnnotatorSettings.

ImageContext

Image context and/or feature-specific parameters.

Protobuf type google.cloud.vision.v1.ImageContext

ImageContext.Builder

Image context and/or feature-specific parameters.

Protobuf type google.cloud.vision.v1.ImageContext

ImageName

ImageName.Builder

Builder for ImageName.

ImageProperties

Stores image properties, such as dominant colors.

Protobuf type google.cloud.vision.v1.ImageProperties

ImageProperties.Builder

Stores image properties, such as dominant colors.

Protobuf type google.cloud.vision.v1.ImageProperties

ImageSource

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

Protobuf type google.cloud.vision.v1.ImageSource

ImageSource.Builder

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

Protobuf type google.cloud.vision.v1.ImageSource

ImportProductSetsGcsSource

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

Protobuf type google.cloud.vision.v1.ImportProductSetsGcsSource

ImportProductSetsGcsSource.Builder

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

Protobuf type google.cloud.vision.v1.ImportProductSetsGcsSource

ImportProductSetsInputConfig

The input content for the ImportProductSets method.

Protobuf type google.cloud.vision.v1.ImportProductSetsInputConfig

ImportProductSetsInputConfig.Builder

The input content for the ImportProductSets method.

Protobuf type google.cloud.vision.v1.ImportProductSetsInputConfig

ImportProductSetsRequest

Request message for the ImportProductSets method.

Protobuf type google.cloud.vision.v1.ImportProductSetsRequest

ImportProductSetsRequest.Builder

Request message for the ImportProductSets method.

Protobuf type google.cloud.vision.v1.ImportProductSetsRequest

ImportProductSetsResponse

Response message for the ImportProductSets method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.

Protobuf type google.cloud.vision.v1.ImportProductSetsResponse

ImportProductSetsResponse.Builder

Response message for the ImportProductSets method. This message is returned by the google.longrunning.Operations.GetOperation method in the returned google.longrunning.Operation.response field.

Protobuf type google.cloud.vision.v1.ImportProductSetsResponse

InputConfig

The desired input location and metadata.

Protobuf type google.cloud.vision.v1.InputConfig

InputConfig.Builder

The desired input location and metadata.

Protobuf type google.cloud.vision.v1.InputConfig

LatLongRect

Rectangle determined by min and max LatLng pairs.

Protobuf type google.cloud.vision.v1.LatLongRect

LatLongRect.Builder

Rectangle determined by min and max LatLng pairs.

Protobuf type google.cloud.vision.v1.LatLongRect

ListProductSetsRequest

Request message for the ListProductSets method.

Protobuf type google.cloud.vision.v1.ListProductSetsRequest

ListProductSetsRequest.Builder

Request message for the ListProductSets method.

Protobuf type google.cloud.vision.v1.ListProductSetsRequest

ListProductSetsResponse

Response message for the ListProductSets method.

Protobuf type google.cloud.vision.v1.ListProductSetsResponse

ListProductSetsResponse.Builder

Response message for the ListProductSets method.

Protobuf type google.cloud.vision.v1.ListProductSetsResponse

ListProductsInProductSetRequest

Request message for the ListProductsInProductSet method.

Protobuf type google.cloud.vision.v1.ListProductsInProductSetRequest

ListProductsInProductSetRequest.Builder

Request message for the ListProductsInProductSet method.

Protobuf type google.cloud.vision.v1.ListProductsInProductSetRequest

ListProductsInProductSetResponse

Response message for the ListProductsInProductSet method.

Protobuf type google.cloud.vision.v1.ListProductsInProductSetResponse

ListProductsInProductSetResponse.Builder

Response message for the ListProductsInProductSet method.

Protobuf type google.cloud.vision.v1.ListProductsInProductSetResponse

ListProductsRequest

Request message for the ListProducts method.

Protobuf type google.cloud.vision.v1.ListProductsRequest

ListProductsRequest.Builder

Request message for the ListProducts method.

Protobuf type google.cloud.vision.v1.ListProductsRequest

ListProductsResponse

Response message for the ListProducts method.

Protobuf type google.cloud.vision.v1.ListProductsResponse

ListProductsResponse.Builder

Response message for the ListProducts method.

Protobuf type google.cloud.vision.v1.ListProductsResponse

ListReferenceImagesRequest

Request message for the ListReferenceImages method.

Protobuf type google.cloud.vision.v1.ListReferenceImagesRequest

ListReferenceImagesRequest.Builder

Request message for the ListReferenceImages method.

Protobuf type google.cloud.vision.v1.ListReferenceImagesRequest

ListReferenceImagesResponse

Response message for the ListReferenceImages method.

Protobuf type google.cloud.vision.v1.ListReferenceImagesResponse

ListReferenceImagesResponse.Builder

Response message for the ListReferenceImages method.

Protobuf type google.cloud.vision.v1.ListReferenceImagesResponse

LocalizedObjectAnnotation

Set of detected objects with bounding boxes.

Protobuf type google.cloud.vision.v1.LocalizedObjectAnnotation

LocalizedObjectAnnotation.Builder

Set of detected objects with bounding boxes.

Protobuf type google.cloud.vision.v1.LocalizedObjectAnnotation

LocationInfo

Detected entity location information.

Protobuf type google.cloud.vision.v1.LocationInfo

LocationInfo.Builder

Detected entity location information.

Protobuf type google.cloud.vision.v1.LocationInfo

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

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.

Protobuf type google.cloud.vision.v1.NormalizedVertex

NormalizedVertex.Builder

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.

Protobuf type google.cloud.vision.v1.NormalizedVertex

OperationMetadata

Contains metadata for the BatchAnnotateImages operation.

Protobuf type google.cloud.vision.v1.OperationMetadata

OperationMetadata.Builder

Contains metadata for the BatchAnnotateImages operation.

Protobuf type google.cloud.vision.v1.OperationMetadata

OutputConfig

The desired output location and metadata.

Protobuf type google.cloud.vision.v1.OutputConfig

OutputConfig.Builder

The desired output location and metadata.

Protobuf type google.cloud.vision.v1.OutputConfig

Page

Detected page from OCR.

Protobuf type google.cloud.vision.v1.Page

Page.Builder

Detected page from OCR.

Protobuf type google.cloud.vision.v1.Page

Paragraph

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

Protobuf type google.cloud.vision.v1.Paragraph

Paragraph.Builder

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

Protobuf type google.cloud.vision.v1.Paragraph

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.

Protobuf type google.cloud.vision.v1.Position

Position.Builder

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.

Protobuf type google.cloud.vision.v1.Position

Product

A Product contains ReferenceImages.

Protobuf type google.cloud.vision.v1.Product

Product.Builder

A Product contains ReferenceImages.

Protobuf type google.cloud.vision.v1.Product

Product.KeyValue

A product label represented as a key-value pair.

Protobuf type google.cloud.vision.v1.Product.KeyValue

Product.KeyValue.Builder

A product label represented as a key-value pair.

Protobuf type google.cloud.vision.v1.Product.KeyValue

ProductName

ProductName.Builder

Builder for projects/{project}/locations/{location}/products/{product}.

ProductSearchClient

Service Description: 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/*

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ProductSet productSet = ProductSet.newBuilder().build();
   String productSetId = "productSetId1003042158";
   ProductSet response = productSearchClient.createProductSet(parent, productSet, productSetId);
 }

Note: close() needs to be called on the ProductSearchClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ProductSearchSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ProductSearchSettings productSearchSettings =
     ProductSearchSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ProductSearchClient productSearchClient = ProductSearchClient.create(productSearchSettings);

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ProductSearchSettings productSearchSettings =
     ProductSearchSettings.newBuilder().setEndpoint(myEndpoint).build();
 ProductSearchClient productSearchClient = ProductSearchClient.create(productSearchSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ProductSearchSettings productSearchSettings =
     ProductSearchSettings.newBuilder()
         .setTransportChannelProvider(
             ProductSearchSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 ProductSearchClient productSearchClient = ProductSearchClient.create(productSearchSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

ProductSearchClient.ListProductSetsFixedSizeCollection

ProductSearchClient.ListProductSetsPage

ProductSearchClient.ListProductSetsPagedResponse

ProductSearchClient.ListProductsFixedSizeCollection

ProductSearchClient.ListProductsInProductSetFixedSizeCollection

ProductSearchClient.ListProductsInProductSetPage

ProductSearchClient.ListProductsInProductSetPagedResponse

ProductSearchClient.ListProductsPage

ProductSearchClient.ListProductsPagedResponse

ProductSearchClient.ListReferenceImagesFixedSizeCollection

ProductSearchClient.ListReferenceImagesPage

ProductSearchClient.ListReferenceImagesPagedResponse

ProductSearchGrpc

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

ProductSearchGrpc.ProductSearchBlockingStub

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

ProductSearchGrpc.ProductSearchFutureStub

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

ProductSearchGrpc.ProductSearchImplBase

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

ProductSearchGrpc.ProductSearchStub

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

ProductSearchParams

Parameters for a product search request.

Protobuf type google.cloud.vision.v1.ProductSearchParams

ProductSearchParams.Builder

Parameters for a product search request.

Protobuf type google.cloud.vision.v1.ProductSearchParams

ProductSearchProto

ProductSearchResults

Results for a product search request.

Protobuf type google.cloud.vision.v1.ProductSearchResults

ProductSearchResults.Builder

Results for a product search request.

Protobuf type google.cloud.vision.v1.ProductSearchResults

ProductSearchResults.GroupedResult

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

Protobuf type google.cloud.vision.v1.ProductSearchResults.GroupedResult

ProductSearchResults.GroupedResult.Builder

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

Protobuf type google.cloud.vision.v1.ProductSearchResults.GroupedResult

ProductSearchResults.ObjectAnnotation

Prediction for what the object in the bounding box is.

Protobuf type google.cloud.vision.v1.ProductSearchResults.ObjectAnnotation

ProductSearchResults.ObjectAnnotation.Builder

Prediction for what the object in the bounding box is.

Protobuf type google.cloud.vision.v1.ProductSearchResults.ObjectAnnotation

ProductSearchResults.Result

Information about a product.

Protobuf type google.cloud.vision.v1.ProductSearchResults.Result

ProductSearchResults.Result.Builder

Information about a product.

Protobuf type google.cloud.vision.v1.ProductSearchResults.Result

ProductSearchServiceProto

ProductSearchSettings

Settings class to configure an instance of ProductSearchClient.

The default instance has everything set to sensible defaults:

  • The default service address (vision.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createProductSet to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ProductSearchSettings.Builder productSearchSettingsBuilder = ProductSearchSettings.newBuilder();
 productSearchSettingsBuilder
     .createProductSetSettings()
     .setRetrySettings(
         productSearchSettingsBuilder
             .createProductSetSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ProductSearchSettings productSearchSettings = productSearchSettingsBuilder.build();

ProductSearchSettings.Builder

Builder for ProductSearchSettings.

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.

Protobuf type google.cloud.vision.v1.ProductSet

ProductSet.Builder

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

Protobuf type google.cloud.vision.v1.ProductSet

ProductSetName

ProductSetName.Builder

Builder for projects/{project}/locations/{location}/productSets/{product_set}.

ProductSetPurgeConfig

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

Protobuf type google.cloud.vision.v1.ProductSetPurgeConfig

ProductSetPurgeConfig.Builder

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

Protobuf type google.cloud.vision.v1.ProductSetPurgeConfig

Property

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

Protobuf type google.cloud.vision.v1.Property

Property.Builder

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

Protobuf type google.cloud.vision.v1.Property

PurgeProductsRequest

Request message for the PurgeProducts method.

Protobuf type google.cloud.vision.v1.PurgeProductsRequest

PurgeProductsRequest.Builder

Request message for the PurgeProducts method.

Protobuf type google.cloud.vision.v1.PurgeProductsRequest

ReferenceImage

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

Protobuf type google.cloud.vision.v1.ReferenceImage

ReferenceImage.Builder

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

Protobuf type google.cloud.vision.v1.ReferenceImage

ReferenceImageName

ReferenceImageName.Builder

Builder for projects/{project}/locations/{location}/products/{product}/referenceImages/{reference_image}.

RemoveProductFromProductSetRequest

Request message for the RemoveProductFromProductSet method.

Protobuf type google.cloud.vision.v1.RemoveProductFromProductSetRequest

RemoveProductFromProductSetRequest.Builder

Request message for the RemoveProductFromProductSet method.

Protobuf type google.cloud.vision.v1.RemoveProductFromProductSetRequest

SafeSearchAnnotation

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

Protobuf type google.cloud.vision.v1.SafeSearchAnnotation

SafeSearchAnnotation.Builder

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

Protobuf type google.cloud.vision.v1.SafeSearchAnnotation

Symbol

A single symbol representation.

Protobuf type google.cloud.vision.v1.Symbol

Symbol.Builder

A single symbol representation.

Protobuf type google.cloud.vision.v1.Symbol

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.

Protobuf type google.cloud.vision.v1.TextAnnotation

TextAnnotation.Builder

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.

Protobuf type google.cloud.vision.v1.TextAnnotation

TextAnnotation.DetectedBreak

Detected start or end of a structural component.

Protobuf type google.cloud.vision.v1.TextAnnotation.DetectedBreak

TextAnnotation.DetectedBreak.Builder

Detected start or end of a structural component.

Protobuf type google.cloud.vision.v1.TextAnnotation.DetectedBreak

TextAnnotation.DetectedLanguage

Detected language for a structural component.

Protobuf type google.cloud.vision.v1.TextAnnotation.DetectedLanguage

TextAnnotation.DetectedLanguage.Builder

Detected language for a structural component.

Protobuf type google.cloud.vision.v1.TextAnnotation.DetectedLanguage

TextAnnotation.TextProperty

Additional information detected on the structural component.

Protobuf type google.cloud.vision.v1.TextAnnotation.TextProperty

TextAnnotation.TextProperty.Builder

Additional information detected on the structural component.

Protobuf type google.cloud.vision.v1.TextAnnotation.TextProperty

TextAnnotationProto

TextDetectionParams

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

Protobuf type google.cloud.vision.v1.TextDetectionParams

TextDetectionParams.Builder

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

Protobuf type google.cloud.vision.v1.TextDetectionParams

UpdateProductRequest

Request message for the UpdateProduct method.

Protobuf type google.cloud.vision.v1.UpdateProductRequest

UpdateProductRequest.Builder

Request message for the UpdateProduct method.

Protobuf type google.cloud.vision.v1.UpdateProductRequest

UpdateProductSetRequest

Request message for the UpdateProductSet method.

Protobuf type google.cloud.vision.v1.UpdateProductSetRequest

UpdateProductSetRequest.Builder

Request message for the UpdateProductSet method.

Protobuf type google.cloud.vision.v1.UpdateProductSetRequest

Vertex

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

Protobuf type google.cloud.vision.v1.Vertex

Vertex.Builder

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

Protobuf type google.cloud.vision.v1.Vertex

WebDetection

Relevant information for the image from the Internet.

Protobuf type google.cloud.vision.v1.WebDetection

WebDetection.Builder

Relevant information for the image from the Internet.

Protobuf type google.cloud.vision.v1.WebDetection

WebDetection.WebEntity

Entity deduced from similar images on the Internet.

Protobuf type google.cloud.vision.v1.WebDetection.WebEntity

WebDetection.WebEntity.Builder

Entity deduced from similar images on the Internet.

Protobuf type google.cloud.vision.v1.WebDetection.WebEntity

WebDetection.WebImage

Metadata for online images.

Protobuf type google.cloud.vision.v1.WebDetection.WebImage

WebDetection.WebImage.Builder

Metadata for online images.

Protobuf type google.cloud.vision.v1.WebDetection.WebImage

WebDetection.WebLabel

Label to provide extra metadata for the web detection.

Protobuf type google.cloud.vision.v1.WebDetection.WebLabel

WebDetection.WebLabel.Builder

Label to provide extra metadata for the web detection.

Protobuf type google.cloud.vision.v1.WebDetection.WebLabel

WebDetection.WebPage

Metadata for web pages.

Protobuf type google.cloud.vision.v1.WebDetection.WebPage

WebDetection.WebPage.Builder

Metadata for web pages.

Protobuf type google.cloud.vision.v1.WebDetection.WebPage

WebDetectionParams

Parameters for web detection request.

Protobuf type google.cloud.vision.v1.WebDetectionParams

WebDetectionParams.Builder

Parameters for web detection request.

Protobuf type google.cloud.vision.v1.WebDetectionParams

WebDetectionProto

Word

A word representation.

Protobuf type google.cloud.vision.v1.Word

Word.Builder

A word representation.

Protobuf type google.cloud.vision.v1.Word

Interfaces

AddProductToProductSetRequestOrBuilder

AnnotateFileRequestOrBuilder

AnnotateFileResponseOrBuilder

AnnotateImageRequestOrBuilder

AnnotateImageResponseOrBuilder

AsyncAnnotateFileRequestOrBuilder

AsyncAnnotateFileResponseOrBuilder

AsyncBatchAnnotateFilesRequestOrBuilder

AsyncBatchAnnotateFilesResponseOrBuilder

AsyncBatchAnnotateImagesRequestOrBuilder

AsyncBatchAnnotateImagesResponseOrBuilder

BatchAnnotateFilesRequestOrBuilder

BatchAnnotateFilesResponseOrBuilder

BatchAnnotateImagesRequestOrBuilder

BatchAnnotateImagesResponseOrBuilder

BatchOperationMetadataOrBuilder

BlockOrBuilder

BoundingPolyOrBuilder

ColorInfoOrBuilder

CreateProductRequestOrBuilder

CreateProductSetRequestOrBuilder

CreateReferenceImageRequestOrBuilder

CropHintOrBuilder

CropHintsAnnotationOrBuilder

CropHintsParamsOrBuilder

DeleteProductRequestOrBuilder

DeleteProductSetRequestOrBuilder

DeleteReferenceImageRequestOrBuilder

DominantColorsAnnotationOrBuilder

EntityAnnotationOrBuilder

FaceAnnotation.LandmarkOrBuilder

FaceAnnotationOrBuilder

FeatureOrBuilder

GcsDestinationOrBuilder

GcsSourceOrBuilder

GetProductRequestOrBuilder

GetProductSetRequestOrBuilder

GetReferenceImageRequestOrBuilder

ImageAnnotationContextOrBuilder

ImageContextOrBuilder

ImageOrBuilder

ImagePropertiesOrBuilder

ImageSourceOrBuilder

ImportProductSetsGcsSourceOrBuilder

ImportProductSetsInputConfigOrBuilder

ImportProductSetsRequestOrBuilder

ImportProductSetsResponseOrBuilder

InputConfigOrBuilder

LatLongRectOrBuilder

ListProductSetsRequestOrBuilder

ListProductSetsResponseOrBuilder

ListProductsInProductSetRequestOrBuilder

ListProductsInProductSetResponseOrBuilder

ListProductsRequestOrBuilder

ListProductsResponseOrBuilder

ListReferenceImagesRequestOrBuilder

ListReferenceImagesResponseOrBuilder

LocalizedObjectAnnotationOrBuilder

LocationInfoOrBuilder

NormalizedVertexOrBuilder

OperationMetadataOrBuilder

OutputConfigOrBuilder

PageOrBuilder

ParagraphOrBuilder

PositionOrBuilder

Product.KeyValueOrBuilder

ProductOrBuilder

ProductSearchParamsOrBuilder

ProductSearchResults.GroupedResultOrBuilder

ProductSearchResults.ObjectAnnotationOrBuilder

ProductSearchResults.ResultOrBuilder

ProductSearchResultsOrBuilder

ProductSetOrBuilder

ProductSetPurgeConfigOrBuilder

PropertyOrBuilder

PurgeProductsRequestOrBuilder

ReferenceImageOrBuilder

RemoveProductFromProductSetRequestOrBuilder

SafeSearchAnnotationOrBuilder

SymbolOrBuilder

TextAnnotation.DetectedBreakOrBuilder

TextAnnotation.DetectedLanguageOrBuilder

TextAnnotation.TextPropertyOrBuilder

TextAnnotationOrBuilder

TextDetectionParamsOrBuilder

UpdateProductRequestOrBuilder

UpdateProductSetRequestOrBuilder

VertexOrBuilder

WebDetection.WebEntityOrBuilder

WebDetection.WebImageOrBuilder

WebDetection.WebLabelOrBuilder

WebDetection.WebPageOrBuilder

WebDetectionOrBuilder

WebDetectionParamsOrBuilder

WordOrBuilder

Enums

BatchOperationMetadata.State

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

Protobuf enum google.cloud.vision.v1.BatchOperationMetadata.State

Block.BlockType

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

Protobuf enum google.cloud.vision.v1.Block.BlockType

FaceAnnotation.Landmark.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.

Protobuf enum google.cloud.vision.v1.FaceAnnotation.Landmark.Type

Feature.Type

Type of Google Cloud Vision API feature to be extracted.

Protobuf enum google.cloud.vision.v1.Feature.Type

ImportProductSetsInputConfig.SourceCase

Likelihood

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

Protobuf enum google.cloud.vision.v1.Likelihood

OperationMetadata.State

Batch operation states.

Protobuf enum google.cloud.vision.v1.OperationMetadata.State

PurgeProductsRequest.TargetCase

TextAnnotation.DetectedBreak.BreakType

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

Protobuf enum google.cloud.vision.v1.TextAnnotation.DetectedBreak.BreakType