fix!: Product search related messages and enums changed in an incompatible way

Google APIs · copybara-github · commit 4c8ac5c07197 · 2022-05-05T15:51:26.000-07:00
fix!: NormalizedBoundingPoly message removed

PiperOrigin-RevId: 446837836
diff --git a/google/cloud/vision/v1p3beta1/geometry.proto b/google/cloud/vision/v1p3beta1/geometry.proto
@@ -1,4 +1,4 @@
-// Copyright 2018 Google Inc.
+// Copyright 2022 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -16,13 +16,12 @@ syntax = "proto3";
 
 package google.cloud.vision.v1p3beta1;
 
-import "google/api/annotations.proto";
-
 option cc_enable_arenas = true;
 option go_package = "google.golang.org/genproto/googleapis/cloud/vision/v1p3beta1;vision";
 option java_multiple_files = true;
 option java_outer_classname = "GeometryProto";
 option java_package = "com.google.cloud.vision.v1p3beta1";
+option objc_class_prefix = "GCVN";
 
 // A vertex represents a 2D point in the image.
 // NOTE: the vertex coordinates are in the same scale as the original image.
@@ -54,12 +53,6 @@ message BoundingPoly {
   repeated NormalizedVertex normalized_vertices = 2;
 }
 
-// A normalized bounding polygon around a portion of an image.
-message NormalizedBoundingPoly {
-  // Normalized vertices of the bounding polygon.
-  repeated NormalizedVertex vertices = 1;
-}
-
 // 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.
diff --git a/google/cloud/vision/v1p3beta1/product_search.proto b/google/cloud/vision/v1p3beta1/product_search.proto
@@ -1,4 +1,4 @@
-// Copyright 2019 Google LLC.
+// Copyright 2022 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -11,13 +11,11 @@
 // 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.
-//
 
 syntax = "proto3";
 
 package google.cloud.vision.v1p3beta1;
 
-import "google/api/annotations.proto";
 import "google/api/resource.proto";
 import "google/cloud/vision/v1p3beta1/geometry.proto";
 import "google/cloud/vision/v1p3beta1/product_search_service.proto";
@@ -28,41 +26,15 @@ option go_package = "google.golang.org/genproto/googleapis/cloud/vision/v1p3beta
 option java_multiple_files = true;
 option java_outer_classname = "ProductSearchProto";
 option java_package = "com.google.cloud.vision.v1p3beta1";
+option objc_class_prefix = "GCVN";
 
 // Parameters for a product search request.
 message ProductSearchParams {
-  // The resource name of the catalog to search.
-  //
-  // Format is: `productSearch/catalogs/CATALOG_NAME`.
-  string catalog_name = 1;
-
-  // The category to search in.
-  // Optional. It is inferred by the system if it is not specified.
-  // [Deprecated] Use `product_category`.
-  ProductSearchCategory category = 2;
-
-  // The product category to search in.
-  // Optional. It is inferred by the system if it is not specified.
-  // Supported values are `bag`, `shoe`, `sunglasses`, `dress`, `outerwear`,
-  // `skirt`, `top`, `shorts`, and `pants`.
-  string product_category = 5;
-
-  // The bounding polygon around the area of interest in the image.
-  // Optional. If it is not specified, system discretion will be applied.
-  // [Deprecated] Use `bounding_poly`.
-  NormalizedBoundingPoly normalized_bounding_poly = 3;
-
   // The bounding polygon around the area of interest in the image.
-  // Optional. If it is not specified, system discretion will be applied.
+  // If it is not specified, system discretion will be applied.
   BoundingPoly bounding_poly = 9;
 
-  // Specifies the verbosity of the  product search results.
-  // Optional. Defaults to `BASIC`.
-  ProductSearchResultsView view = 4;
-
-  // The resource name of a
-  // [ProductSet][google.cloud.vision.v1p3beta1.ProductSet] to be searched for
-  // similar images.
+  // The resource name of a [ProductSet][google.cloud.vision.v1p3beta1.ProductSet] to be searched for similar images.
   //
   // Format is:
   // `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.
@@ -71,96 +43,82 @@ message ProductSearchParams {
                           }];
 
   // The list of product categories to search in. Currently, we only consider
-  // the first category, and either "homegoods" or "apparel" should be
-  // specified.
+  // the first category, and either "homegoods-v2", "apparel-v2", "toys-v2",
+  // "packagedgoods-v1", or "general-v1" should be specified. The legacy
+  // categories "homegoods", "apparel", and "toys" are still supported but will
+  // be deprecated. For new products, please use "homegoods-v2", "apparel-v2",
+  // or "toys-v2" for better product search accuracy. It is recommended to
+  // migrate existing products to these categories as well.
   repeated string product_categories = 7;
 
   // The filtering expression. This can be used to restrict search results based
   // on Product labels. We currently support an AND of OR of key-value
-  // expressions, where each expression within an OR must have the same key.
+  // expressions, where each expression within an OR must have the same key. An
+  // '=' should be used to connect the key and value.
   //
   // For example, "(color = red OR color = blue) AND brand = Google" is
-  // acceptable, but not "(color = red OR brand = Google)" or "color: red".
+  // acceptable, but "(color = red OR brand = Google)" is not acceptable.
+  // "color: red" is not acceptable because it uses a ':' instead of an '='.
   string filter = 8;
 }
 
 // Results for a product search request.
 message ProductSearchResults {
-  // Information about a product.
-  message ProductInfo {
-    // Product ID.
-    string product_id = 1;
-
-    // The URI of the image which matched the query image.
-    //
-    // This field is returned only if `view` is set to `FULL` in
-    // the request.
-    string image_uri = 2;
-
-    // A confidence level on the match, ranging from 0 (no confidence) to
-    // 1 (full confidence).
-    //
-    // This field is returned only if `view` is set to `FULL` in
-    // the request.
-    float score = 3;
-  }
-
   // Information about a product.
   message Result {
     // The Product.
     Product product = 1;
 
     // A confidence level on the match, ranging from 0 (no confidence) to
     // 1 (full confidence).
-    //
-    // This field is returned only if `view` is set to `FULL` in
-    // the request.
     float score = 2;
 
     // The resource name of the image from the product that is the closest match
     // to the query.
     string image = 3;
   }
 
-  // Product category.
-  // [Deprecated] Use `product_category`.
-  ProductSearchCategory category = 1;
+  // Prediction for what the object in the bounding box is.
+  message ObjectAnnotation {
+    // Object ID that should align with EntityAnnotation mid.
+    string mid = 1;
 
-  // Product category.
-  // Supported values are `bag` and `shoe`.
-  // [Deprecated] `product_category` is provided in each Product.
-  string product_category = 4;
+    // The BCP-47 language code, such as "en-US" or "sr-Latn". For more
+    // information, see
+    // http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+    string language_code = 2;
 
-  // Timestamp of the index which provided these results. Changes made after
-  // this time are not reflected in the current results.
-  google.protobuf.Timestamp index_time = 2;
+    // Object name, expressed in its `language_code` language.
+    string name = 3;
 
-  // List of detected products.
-  repeated ProductInfo products = 3;
+    // Score of the result. Range [0, 1].
+    float score = 4;
+  }
 
-  // List of results, one for each product match.
-  repeated Result results = 5;
-}
+  // Information about the products similar to a single product in a query
+  // image.
+  message GroupedResult {
+    // The bounding polygon around the product detected in the query image.
+    BoundingPoly bounding_poly = 1;
 
-// Supported product search categories.
-enum ProductSearchCategory {
-  // Default value used when a category is not specified.
-  PRODUCT_SEARCH_CATEGORY_UNSPECIFIED = 0;
+    // List of results, one for each product match.
+    repeated Result results = 2;
 
-  // Shoes category.
-  SHOES = 1;
+    // List of generic predictions for the object in the bounding box.
+    repeated ObjectAnnotation object_annotations = 3;
+  }
 
-  // Bags category.
-  BAGS = 2;
-}
+  // Timestamp of the index which provided these results. Products added to the
+  // product set and products removed from the product set after this time are
+  // not reflected in the current results.
+  google.protobuf.Timestamp index_time = 2;
 
-// Specifies the fields to include in product search results.
-enum ProductSearchResultsView {
-  // Product search results contain only `product_category` and `product_id`.
-  // Default value.
-  BASIC = 0;
+  // List of results, one for each product match.
+  repeated Result results = 5;
 
-  // Product search results contain `product_category`, `product_id`,
-  // `image_uri`, and `score`.
-  FULL = 1;
+  // List of results grouped by products detected in the query image. Each entry
+  // corresponds to one bounding polygon in the query image, and contains the
+  // matching products specific to that region. There may be duplicate product
+  // matches in the union of all the per-product results.
+  repeated GroupedResult product_grouped_results = 6;
 }
