google-cloud-vision-v1p4beta1 0.1.0

data/proto_docs/google/cloud/vision/v1p4beta1/product_search.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Vision
+      module V1p4beta1
+        # Parameters for a product search request.
+        # @!attribute [rw] bounding_poly
+        #   @return [::Google::Cloud::Vision::V1p4beta1::BoundingPoly]
+        #     The bounding polygon around the area of interest in the image.
+        #     If it is not specified, system discretion will be applied.
+        # @!attribute [rw] product_set
+        #   @return [::String]
+        #     The resource name of a
+        #     {::Google::Cloud::Vision::V1p4beta1::ProductSet ProductSet} to be searched for
+        #     similar images.
+        #
+        #     Format is:
+        #     `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.
+        # @!attribute [rw] product_categories
+        #   @return [::Array<::String>]
+        #     The list of product categories to search in. Currently, we only consider
+        #     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.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     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. An
+        #     '=' should be used to connect the key and value.
+        #
+        #     For example, "(color = red OR color = blue) AND brand = Google" is
+        #     acceptable, but "(color = red OR brand = Google)" is not acceptable.
+        #     "color: red" is not acceptable because it uses a ':' instead of an '='.
+        class ProductSearchParams
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Results for a product search request.
+        # @!attribute [rw] index_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     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.
+        # @!attribute [rw] results
+        #   @return [::Array<::Google::Cloud::Vision::V1p4beta1::ProductSearchResults::Result>]
+        #     List of results, one for each product match.
+        # @!attribute [rw] product_grouped_results
+        #   @return [::Array<::Google::Cloud::Vision::V1p4beta1::ProductSearchResults::GroupedResult>]
+        #     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.
+        class ProductSearchResults
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Information about a product.
+          # @!attribute [rw] product
+          #   @return [::Google::Cloud::Vision::V1p4beta1::Product]
+          #     The Product.
+          # @!attribute [rw] score
+          #   @return [::Float]
+          #     A confidence level on the match, ranging from 0 (no confidence) to
+          #     1 (full confidence).
+          # @!attribute [rw] image
+          #   @return [::String]
+          #     The resource name of the image from the product that is the closest match
+          #     to the query.
+          class Result
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Prediction for what the object in the bounding box is.
+          # @!attribute [rw] mid
+          #   @return [::String]
+          #     Object ID that should align with EntityAnnotation mid.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     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.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Object name, expressed in its `language_code` language.
+          # @!attribute [rw] score
+          #   @return [::Float]
+          #     Score of the result. Range [0, 1].
+          class ObjectAnnotation
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Information about the products similar to a single product in a query
+          # image.
+          # @!attribute [rw] bounding_poly
+          #   @return [::Google::Cloud::Vision::V1p4beta1::BoundingPoly]
+          #     The bounding polygon around the product detected in the query image.
+          # @!attribute [rw] results
+          #   @return [::Array<::Google::Cloud::Vision::V1p4beta1::ProductSearchResults::Result>]
+          #     List of results, one for each product match.
+          # @!attribute [rw] object_annotations
+          #   @return [::Array<::Google::Cloud::Vision::V1p4beta1::ProductSearchResults::ObjectAnnotation>]
+          #     List of generic predictions for the object in the bounding box.
+          class GroupedResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end