com.google.cloud.vision.v1.package-info Maven / Gradle / Ivy
/*
* Copyright 2018 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* A client to Cloud Vision API.
*
* The interfaces provided are listed below, along with usage samples.
*
*
=================== 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.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/*`
*
*
Sample for ProductSearchClient:
*
*
*
* try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
* String formattedParent = ProductSearchClient.formatLocationName("[PROJECT]", "[LOCATION]");
* Product product = Product.newBuilder().build();
* String productId = "";
* Product response = productSearchClient.createProduct(formattedParent, product, productId);
* }
*
*
*
* ==================== 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:
*
*
*
* try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
* List<AnnotateImageRequest> requests = new ArrayList<>();
* BatchAnnotateImagesResponse response = imageAnnotatorClient.batchAnnotateImages(requests);
* }
*
*
*/
package com.google.cloud.vision.v1;