com.google.cloud.vision.v1.package-info Maven / Gradle / Ivy
Show all versions of google-cloud-vision Show documentation
/*
* Copyright 2024 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.
*
*
======================= 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:
*
*
{@code
* // 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 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.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:
*
*
{@code
* // 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);
* }
* }
*/
@Generated("by gapic-generator-java")
package com.google.cloud.vision.v1;
import javax.annotation.Generated;