@Generated("by gapic-generator-java")
Package com.google.cloud.vision.v1p3beta1
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 and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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][google.cloud.vision.v1p3beta1.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.v1p3beta1.Product] resources, named `projects/*/locations/*/products/*`
- Each [Product][google.cloud.vision.v1p3beta1.Product] has a collection of [ReferenceImage][google.cloud.vision.v1p3beta1.ReferenceImage] resources, named `projects/*/locations/*/products/*/referenceImages/*`
Sample for ProductSearchClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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);
}
-
Class Summary Class Description AddProductToProductSetRequest Request message for the `AddProductToProductSet` method.AddProductToProductSetRequest.Builder Request message for the `AddProductToProductSet` method.AnnotateFileResponse Response to a single file annotation request.AnnotateFileResponse.Builder Response to a single file annotation request.AnnotateImageRequest Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features.AnnotateImageRequest.Builder Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features.AnnotateImageResponse Response to an image annotation request.AnnotateImageResponse.Builder Response to an image annotation request.AsyncAnnotateFileRequest An offline file annotation request.AsyncAnnotateFileRequest.Builder An offline file annotation request.AsyncAnnotateFileResponse The response for a single offline file annotation request.AsyncAnnotateFileResponse.Builder The response for a single offline file annotation request.AsyncBatchAnnotateFilesRequest Multiple async file annotation requests are batched into a single service call.AsyncBatchAnnotateFilesRequest.Builder Multiple async file annotation requests are batched into a single service call.AsyncBatchAnnotateFilesResponse Response to an async batch file annotation request.AsyncBatchAnnotateFilesResponse.Builder Response to an async batch file annotation request.BatchAnnotateImagesRequest Multiple image annotation requests are batched into a single service call.BatchAnnotateImagesRequest.Builder Multiple image annotation requests are batched into a single service call.BatchAnnotateImagesResponse Response to a batch image annotation request.BatchAnnotateImagesResponse.Builder Response to a batch image annotation request.BatchOperationMetadata Metadata for the batch operations such as the current state.BatchOperationMetadata.Builder Metadata for the batch operations such as the current state.Block Logical element on the page.Block.Builder Logical element on the page.BoundingPoly A bounding polygon for the detected image annotation.BoundingPoly.Builder 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.ColorInfo.Builder 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.CreateProductRequest.Builder Request message for the `CreateProduct` method.CreateProductSetRequest Request message for the `CreateProductSet` method.CreateProductSetRequest.Builder Request message for the `CreateProductSet` method.CreateReferenceImageRequest Request message for the `CreateReferenceImage` method.CreateReferenceImageRequest.Builder Request message for the `CreateReferenceImage` method.CropHint Single crop hint that is used to generate a new crop when serving an image.CropHint.Builder 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.CropHintsAnnotation.Builder Set of crop hints that are used to generate new crops when serving images.CropHintsParams Parameters for crop hints annotation request.CropHintsParams.Builder Parameters for crop hints annotation request.DeleteProductRequest Request message for the `DeleteProduct` method.DeleteProductRequest.Builder Request message for the `DeleteProduct` method.DeleteProductSetRequest Request message for the `DeleteProductSet` method.DeleteProductSetRequest.Builder Request message for the `DeleteProductSet` method.DeleteReferenceImageRequest Request message for the `DeleteReferenceImage` method.DeleteReferenceImageRequest.Builder Request message for the `DeleteReferenceImage` method.DominantColorsAnnotation Set of dominant colors and their corresponding scores.DominantColorsAnnotation.Builder Set of dominant colors and their corresponding scores.EntityAnnotation Set of detected entity features.EntityAnnotation.Builder Set of detected entity features.FaceAnnotation A face annotation object contains the results of face detection.FaceAnnotation.Builder A face annotation object contains the results of face detection.FaceAnnotation.Landmark A face-specific landmark (for example, a face feature).FaceAnnotation.Landmark.Builder A face-specific landmark (for example, a face feature).Feature The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type.Feature.Builder The type of Google Cloud Vision API detection to perform, and the maximum number of results to return for that type.GcsDestination The Google Cloud Storage location where the output will be written to.GcsDestination.Builder 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.GcsSource.Builder The Google Cloud Storage location where the input will be read from.GeometryProto GetProductRequest Request message for the `GetProduct` method.GetProductRequest.Builder Request message for the `GetProduct` method.GetProductSetRequest Request message for the `GetProductSet` method.GetProductSetRequest.Builder Request message for the `GetProductSet` method.GetReferenceImageRequest Request message for the `GetReferenceImage` method.GetReferenceImageRequest.Builder Request message for the `GetReferenceImage` method.Image Client image to perform Google Cloud Vision API tasks over.Image.Builder Client image to perform Google Cloud Vision API tasks over.ImageAnnotationContext If an image was produced from a file (e.g.ImageAnnotationContext.Builder If an image was produced from a file (e.g.ImageAnnotatorClient Service Description: Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection.ImageAnnotatorGrpc Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection.ImageAnnotatorGrpc.ImageAnnotatorBlockingStub A stub to allow clients to do synchronous rpc calls to service ImageAnnotator.ImageAnnotatorGrpc.ImageAnnotatorFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service ImageAnnotator.ImageAnnotatorGrpc.ImageAnnotatorImplBase Base class for the server implementation of the service ImageAnnotator.ImageAnnotatorGrpc.ImageAnnotatorStub A stub to allow clients to do asynchronous rpc calls to service ImageAnnotator.ImageAnnotatorProto ImageAnnotatorSettings Settings class to configure an instance ofImageAnnotatorClient
.ImageAnnotatorSettings.Builder Builder for ImageAnnotatorSettings.ImageContext Image context and/or feature-specific parameters.ImageContext.Builder Image context and/or feature-specific parameters.ImageProperties Stores image properties, such as dominant colors.ImageProperties.Builder Stores image properties, such as dominant colors.ImageSource External image source (Google Cloud Storage or web URL image location).ImageSource.Builder 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.ImportProductSetsGcsSource.Builder 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.ImportProductSetsInputConfig.Builder The input content for the `ImportProductSets` method.ImportProductSetsRequest Request message for the `ImportProductSets` method.ImportProductSetsRequest.Builder Request message for the `ImportProductSets` method.ImportProductSetsResponse Response message for the `ImportProductSets` method.ImportProductSetsResponse.Builder Response message for the `ImportProductSets` method.InputConfig The desired input location and metadata.InputConfig.Builder The desired input location and metadata.LatLongRect Rectangle determined by min and max `LatLng` pairs.LatLongRect.Builder Rectangle determined by min and max `LatLng` pairs.ListProductSetsRequest Request message for the `ListProductSets` method.ListProductSetsRequest.Builder Request message for the `ListProductSets` method.ListProductSetsResponse Response message for the `ListProductSets` method.ListProductSetsResponse.Builder Response message for the `ListProductSets` method.ListProductsInProductSetRequest Request message for the `ListProductsInProductSet` method.ListProductsInProductSetRequest.Builder Request message for the `ListProductsInProductSet` method.ListProductsInProductSetResponse Response message for the `ListProductsInProductSet` method.ListProductsInProductSetResponse.Builder Response message for the `ListProductsInProductSet` method.ListProductsRequest Request message for the `ListProducts` method.ListProductsRequest.Builder Request message for the `ListProducts` method.ListProductsResponse Response message for the `ListProducts` method.ListProductsResponse.Builder Response message for the `ListProducts` method.ListReferenceImagesRequest Request message for the `ListReferenceImages` method.ListReferenceImagesRequest.Builder Request message for the `ListReferenceImages` method.ListReferenceImagesResponse Response message for the `ListReferenceImages` method.ListReferenceImagesResponse.Builder Response message for the `ListReferenceImages` method.LocalizedObjectAnnotation Set of detected objects with bounding boxes.LocalizedObjectAnnotation.Builder Set of detected objects with bounding boxes.LocationInfo Detected entity location information.LocationInfo.Builder Detected entity location information.LocationName LocationName.Builder Builder for projects/{project}/locations/{location}.NormalizedVertex A vertex represents a 2D point in the image.NormalizedVertex.Builder A vertex represents a 2D point in the image.OperationMetadata Contains metadata for the BatchAnnotateImages operation.OperationMetadata.Builder Contains metadata for the BatchAnnotateImages operation.OutputConfig The desired output location and metadata.OutputConfig.Builder The desired output location and metadata.Page Detected page from OCR.Page.Builder Detected page from OCR.Paragraph Structural unit of text representing a number of words in certain order.Paragraph.Builder 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.Position.Builder A 3D position in the image, used primarily for Face detection landmarks.Product A Product contains ReferenceImages.Product.Builder A Product contains ReferenceImages.Product.KeyValue A product label represented as a key-value pair.Product.KeyValue.Builder A product label represented as a key-value pair.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.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.ProductSearchGrpc.ProductSearchBlockingStub A stub to allow clients to do synchronous rpc calls to service ProductSearch.ProductSearchGrpc.ProductSearchFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service ProductSearch.ProductSearchGrpc.ProductSearchImplBase Base class for the server implementation of the service ProductSearch.ProductSearchGrpc.ProductSearchStub A stub to allow clients to do asynchronous rpc calls to service ProductSearch.ProductSearchParams Parameters for a product search request.ProductSearchParams.Builder Parameters for a product search request.ProductSearchProto ProductSearchResults Results for a product search request.ProductSearchResults.Builder Results for a product search request.ProductSearchResults.GroupedResult Information about the products similar to a single product in a query image.ProductSearchResults.GroupedResult.Builder Information about the products similar to a single product in a query image.ProductSearchResults.ObjectAnnotation Prediction for what the object in the bounding box is.ProductSearchResults.ObjectAnnotation.Builder Prediction for what the object in the bounding box is.ProductSearchResults.Result Information about a product.ProductSearchResults.Result.Builder Information about a product.ProductSearchServiceProto ProductSearchSettings Settings class to configure an instance ofProductSearchClient
.ProductSearchSettings.Builder Builder for ProductSearchSettings.ProductSet A ProductSet contains Products.ProductSet.Builder A ProductSet contains Products.ProductSetName ProductSetName.Builder Builder for projects/{project}/locations/{location}/productSets/{product_set}.Property A `Property` consists of a user-supplied name/value pair.Property.Builder A `Property` consists of a user-supplied name/value pair.ReferenceImage A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes.ReferenceImage.Builder A `ReferenceImage` represents a product image and its associated metadata, such as bounding boxes.ReferenceImageName ReferenceImageName.Builder Builder for projects/{project}/locations/{location}/products/{product}/referenceImages/{reference_image}.RemoveProductFromProductSetRequest Request message for the `RemoveProductFromProductSet` method.RemoveProductFromProductSetRequest.Builder 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).SafeSearchAnnotation.Builder 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.Symbol.Builder A single symbol representation.TextAnnotation TextAnnotation contains a structured representation of OCR extracted text.TextAnnotation.Builder TextAnnotation contains a structured representation of OCR extracted text.TextAnnotation.DetectedBreak Detected start or end of a structural component.TextAnnotation.DetectedBreak.Builder Detected start or end of a structural component.TextAnnotation.DetectedLanguage Detected language for a structural component.TextAnnotation.DetectedLanguage.Builder Detected language for a structural component.TextAnnotation.TextProperty Additional information detected on the structural component.TextAnnotation.TextProperty.Builder Additional information detected on the structural component.TextAnnotationProto TextDetectionParams Parameters for text detections.TextDetectionParams.Builder Parameters for text detections.UpdateProductRequest Request message for the `UpdateProduct` method.UpdateProductRequest.Builder Request message for the `UpdateProduct` method.UpdateProductSetRequest Request message for the `UpdateProductSet` method.UpdateProductSetRequest.Builder Request message for the `UpdateProductSet` method.Vertex A vertex represents a 2D point in the image.Vertex.Builder A vertex represents a 2D point in the image.WebDetection Relevant information for the image from the Internet.WebDetection.Builder Relevant information for the image from the Internet.WebDetection.WebEntity Entity deduced from similar images on the Internet.WebDetection.WebEntity.Builder Entity deduced from similar images on the Internet.WebDetection.WebImage Metadata for online images.WebDetection.WebImage.Builder Metadata for online images.WebDetection.WebLabel Label to provide extra metadata for the web detection.WebDetection.WebLabel.Builder Label to provide extra metadata for the web detection.WebDetection.WebPage Metadata for web pages.WebDetection.WebPage.Builder Metadata for web pages.WebDetectionParams Parameters for web detection request.WebDetectionParams.Builder Parameters for web detection request.WebDetectionProto Word A word representation.Word.Builder A word representation. -
Enum Summary Enum Description BatchOperationMetadata.State Enumerates the possible states that the batch request can be in.Block.BlockType Type of a block (text, image etc) as identified by OCR.FaceAnnotation.Landmark.Type Face landmark (feature) type.Feature.Type Type of Google Cloud Vision API feature to be extracted.ImportProductSetsInputConfig.SourceCase Likelihood A bucketized representation of likelihood, which is intended to give clients highly stable results across model upgrades.OperationMetadata.State Batch operation states.TextAnnotation.DetectedBreak.BreakType Enum to denote the type of break found.