google-cloud-retail-v2 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac1d9a4731b52436b27d039833a64947536a4d01829e67222514a50e3155319d
-  data.tar.gz: 6f48023be7da11258abc4354a2b9e413bcd095057be10ab0fe42cc2b7380bb60
+  metadata.gz: c1e74d74b9ec525b0fe2e515035a9201f0385dc8140b2fa6e26305d9e5aa37ab
+  data.tar.gz: 063b0f107d532fe89dbc5f547eec33d12254d5691f0230a955a7e7b2199c4887
 SHA512:
-  metadata.gz: 23f52514bc53344d461a35b5b3e726ef5099af6eb4afa04c9550c13e78db52a51964fb5fc4444db98c3e0bc54946e67e0763b7213f85c58cab6625b33ef19656
-  data.tar.gz: 72a0285df4a4304728b0b17c1bd457593631f7286dc193058db05dd448c58ef971fe5ce12fc00c5776f8313213ac82d265715e27d533fbd67878a88e14470305
+  metadata.gz: 52ce66cf0b37660e8757b147f460719f71c5e3d6164fdda364938995ffdc4c693c39fa0e25fcebc0a212004dbd0ce30efa13741faf14ed2d575b4a5bd75c5e47
+  data.tar.gz: 19dbd91993a130ee49808962546d87c98dd81f76c70f2e9024329c2fa41c284c796fa10eee0282883c4f23a37b5a07fae064f6dd86a1acef18dd907d17bb3d6a

data/AUTHENTICATION.md

@@ -114,7 +114,7 @@ credentials are discovered.
 To configure your system for this, simply:
 
 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
-2. Authenticate using OAuth 2.0 `$ gcloud auth login`
+2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
 3. Write code as if already authenticated.
 
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK

data/README.md

@@ -46,7 +46,7 @@ for general usage information.
 ## Enabling Logging
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
 or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
 that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
 and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.

data/lib/google/cloud/retail/v2/catalog_pb.rb

@@ -21,6 +21,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :indexable_option, :enum, 5, "google.cloud.retail.v2.CatalogAttribute.IndexableOption"
       optional :dynamic_facetable_option, :enum, 6, "google.cloud.retail.v2.CatalogAttribute.DynamicFacetableOption"
       optional :searchable_option, :enum, 7, "google.cloud.retail.v2.CatalogAttribute.SearchableOption"
+      optional :exact_searchable_option, :enum, 11, "google.cloud.retail.v2.CatalogAttribute.ExactSearchableOption"
+      optional :retrievable_option, :enum, 12, "google.cloud.retail.v2.CatalogAttribute.RetrievableOption"
     end
     add_enum "google.cloud.retail.v2.CatalogAttribute.AttributeType" do
       value :UNKNOWN, 0
@@ -42,6 +44,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :SEARCHABLE_ENABLED, 1
       value :SEARCHABLE_DISABLED, 2
     end
+    add_enum "google.cloud.retail.v2.CatalogAttribute.ExactSearchableOption" do
+      value :EXACT_SEARCHABLE_OPTION_UNSPECIFIED, 0
+      value :EXACT_SEARCHABLE_ENABLED, 1
+      value :EXACT_SEARCHABLE_DISABLED, 2
+    end
+    add_enum "google.cloud.retail.v2.CatalogAttribute.RetrievableOption" do
+      value :RETRIEVABLE_OPTION_UNSPECIFIED, 0
+      value :RETRIEVABLE_ENABLED, 1
+      value :RETRIEVABLE_DISABLED, 2
+    end
     add_message "google.cloud.retail.v2.AttributesConfig" do
       optional :name, :string, 1
       map :catalog_attributes, :string, :message, 2, "google.cloud.retail.v2.CatalogAttribute"
@@ -78,6 +90,8 @@ module Google
         CatalogAttribute::IndexableOption = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CatalogAttribute.IndexableOption").enummodule
         CatalogAttribute::DynamicFacetableOption = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CatalogAttribute.DynamicFacetableOption").enummodule
         CatalogAttribute::SearchableOption = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CatalogAttribute.SearchableOption").enummodule
+        CatalogAttribute::ExactSearchableOption = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CatalogAttribute.ExactSearchableOption").enummodule
+        CatalogAttribute::RetrievableOption = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CatalogAttribute.RetrievableOption").enummodule
         AttributesConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.AttributesConfig").msgclass
         CompletionConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CompletionConfig").msgclass
         Catalog = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Catalog").msgclass

data/lib/google/cloud/retail/v2/catalog_service/client.rb

@@ -18,6 +18,7 @@
 
 require "google/cloud/errors"
 require "google/cloud/retail/v2/catalog_service_pb"
+require "google/cloud/location"
 
 module Google
   module Cloud
@@ -138,6 +139,12 @@ module Google
               @quota_project_id = @config.quota_project
               @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
+              @location_client = Google::Cloud::Location::Locations::Client.new do |config|
+                config.credentials = credentials
+                config.quota_project = @quota_project_id
+                config.endpoint = @config.endpoint
+              end
+
               @catalog_service_stub = ::Gapic::ServiceStub.new(
                 ::Google::Cloud::Retail::V2::CatalogService::Stub,
                 credentials:  credentials,
@@ -147,6 +154,13 @@ module Google
               )
             end
 
+            ##
+            # Get the associated client for mix-in of the Locations.
+            #
+            # @return [Google::Cloud::Location::Locations::Client]
+            #
+            attr_reader :location_client
+
             # Service calls
 
             ##
@@ -213,13 +227,11 @@ module Google
             #   # Call the list_catalogs method.
             #   result = client.list_catalogs request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Cloud::Retail::V2::Catalog.
-            #     p response
+            #     p item
             #   end
             #
             def list_catalogs request, options = nil
@@ -608,7 +620,7 @@ module Google
             #
             #   @param name [::String]
             #     Required. Full CompletionConfig resource name. Format:
-            #     projects/\\{project_number}/locations/\\{location_id}/catalogs/\\{catalog_id}/completionConfig
+            #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig`
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Retail::V2::CompletionConfig]

data/lib/google/cloud/retail/v2/catalog_service.rb

@@ -33,7 +33,7 @@ module Google
         ##
         # Service for managing catalog configuration.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/retail/v2/catalog_service"
         #     client = ::Google::Cloud::Retail::V2::CatalogService::Client.new

data/lib/google/cloud/retail/v2/completion_service/client.rb

@@ -18,6 +18,7 @@
 
 require "google/cloud/errors"
 require "google/cloud/retail/v2/completion_service_pb"
+require "google/cloud/location"
 
 module Google
   module Cloud
@@ -30,7 +31,7 @@ module Google
           # Auto-completion service for retail.
           #
           # This feature is only available for users who have Retail Search enabled.
-          # Please enable Retail Search on Cloud Console before using this feature.
+          # Enable Retail Search on Cloud Console before using this feature.
           #
           class Client
             include Paths
@@ -147,6 +148,12 @@ module Google
                 config.endpoint = @config.endpoint
               end
 
+              @location_client = Google::Cloud::Location::Locations::Client.new do |config|
+                config.credentials = credentials
+                config.quota_project = @quota_project_id
+                config.endpoint = @config.endpoint
+              end
+
               @completion_service_stub = ::Gapic::ServiceStub.new(
                 ::Google::Cloud::Retail::V2::CompletionService::Stub,
                 credentials:  credentials,
@@ -163,13 +170,20 @@ module Google
             #
             attr_reader :operations_client
 
+            ##
+            # Get the associated client for mix-in of the Locations.
+            #
+            # @return [Google::Cloud::Location::Locations::Client]
+            #
+            attr_reader :location_client
+
             # Service calls
 
             ##
             # Completes the specified prefix with keyword suggestions.
             #
             # This feature is only available for users who have Retail Search enabled.
-            # Please enable Retail Search on Cloud Console before using this feature.
+            # Enable Retail Search on Cloud Console before using this feature.
             #
             # @overload complete_query(request, options = nil)
             #   Pass arguments to `complete_query` via a request object, either of type
@@ -214,8 +228,10 @@ module Google
             #     Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum
             #     number of language codes is 3.
             #   @param device_type [::String]
-            #     The device type context for completion suggestions.
-            #     It is useful to apply different suggestions on different device types, e.g.
+            #     The device type context for completion suggestions. We recommend that you
+            #     leave this field empty.
+            #
+            #     It can apply different suggestions on different device types, e.g.
             #     `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
             #     types.
             #
@@ -323,7 +339,7 @@ module Google
             # are indexed successfully and ready for serving. The process takes hours.
             #
             # This feature is only available for users who have Retail Search enabled.
-            # Please enable Retail Search on Cloud Console before using this feature.
+            # Enable Retail Search on Cloud Console before using this feature.
             #
             # @overload import_completion_data(request, options = nil)
             #   Pass arguments to `import_completion_data` via a request object, either of type
@@ -373,14 +389,14 @@ module Google
             #   # Call the import_completion_data method.
             #   result = client.import_completion_data request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def import_completion_data request, options = nil

data/lib/google/cloud/retail/v2/completion_service/operations.rb

@@ -158,13 +158,11 @@ module Google
             #   # Call the list_operations method.
             #   result = client.list_operations request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Longrunning::Operation.
-            #     p response
+            #     p item
             #   end
             #
             def list_operations request, options = nil
@@ -253,14 +251,14 @@ module Google
             #   # Call the get_operation method.
             #   result = client.get_operation request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def get_operation request, options = nil
@@ -540,14 +538,14 @@ module Google
             #   # Call the wait_operation method.
             #   result = client.wait_operation request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def wait_operation request, options = nil

data/lib/google/cloud/retail/v2/completion_service.rb

@@ -35,9 +35,9 @@ module Google
         # Auto-completion service for retail.
         #
         # This feature is only available for users who have Retail Search enabled.
-        # Please enable Retail Search on Cloud Console before using this feature.
+        # Enable Retail Search on Cloud Console before using this feature.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/retail/v2/completion_service"
         #     client = ::Google::Cloud::Retail::V2::CompletionService::Client.new

data/lib/google/cloud/retail/v2/completion_service_services_pb.rb

@@ -27,7 +27,7 @@ module Google
           # Auto-completion service for retail.
           #
           # This feature is only available for users who have Retail Search enabled.
-          # Please enable Retail Search on Cloud Console before using this feature.
+          # Enable Retail Search on Cloud Console before using this feature.
           class Service
 
             include ::GRPC::GenericService
@@ -39,7 +39,7 @@ module Google
             # Completes the specified prefix with keyword suggestions.
             #
             # This feature is only available for users who have Retail Search enabled.
-            # Please enable Retail Search on Cloud Console before using this feature.
+            # Enable Retail Search on Cloud Console before using this feature.
             rpc :CompleteQuery, ::Google::Cloud::Retail::V2::CompleteQueryRequest, ::Google::Cloud::Retail::V2::CompleteQueryResponse
             # Bulk import of processed completion dataset.
             #
@@ -49,7 +49,7 @@ module Google
             # are indexed successfully and ready for serving. The process takes hours.
             #
             # This feature is only available for users who have Retail Search enabled.
-            # Please enable Retail Search on Cloud Console before using this feature.
+            # Enable Retail Search on Cloud Console before using this feature.
             rpc :ImportCompletionData, ::Google::Cloud::Retail::V2::ImportCompletionDataRequest, ::Google::Longrunning::Operation
           end
 

data/lib/google/cloud/retail/v2/control_service/client.rb

@@ -18,6 +18,7 @@
 
 require "google/cloud/errors"
 require "google/cloud/retail/v2/control_service_pb"
+require "google/cloud/location"
 
 module Google
   module Cloud
@@ -133,6 +134,12 @@ module Google
               @quota_project_id = @config.quota_project
               @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
+              @location_client = Google::Cloud::Location::Locations::Client.new do |config|
+                config.credentials = credentials
+                config.quota_project = @quota_project_id
+                config.endpoint = @config.endpoint
+              end
+
               @control_service_stub = ::Gapic::ServiceStub.new(
                 ::Google::Cloud::Retail::V2::ControlService::Stub,
                 credentials:  credentials,
@@ -142,6 +149,13 @@ module Google
               )
             end
 
+            ##
+            # Get the associated client for mix-in of the Locations.
+            #
+            # @return [Google::Cloud::Location::Locations::Client]
+            #
+            attr_reader :location_client
+
             # Service calls
 
             ##
@@ -570,13 +584,11 @@ module Google
             #   # Call the list_controls method.
             #   result = client.list_controls request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Cloud::Retail::V2::Control.
-            #     p response
+            #     p item
             #   end
             #
             def list_controls request, options = nil

data/lib/google/cloud/retail/v2/control_service.rb

@@ -33,7 +33,7 @@ module Google
         ##
         # Service for modifying Control.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/retail/v2/control_service"
         #     client = ::Google::Cloud::Retail::V2::ControlService::Client.new

data/lib/google/cloud/retail/v2/prediction_service/client.rb

@@ -18,6 +18,7 @@
 
 require "google/cloud/errors"
 require "google/cloud/retail/v2/prediction_service_pb"
+require "google/cloud/location"
 
 module Google
   module Cloud
@@ -138,6 +139,12 @@ module Google
               @quota_project_id = @config.quota_project
               @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
+              @location_client = Google::Cloud::Location::Locations::Client.new do |config|
+                config.credentials = credentials
+                config.quota_project = @quota_project_id
+                config.endpoint = @config.endpoint
+              end
+
               @prediction_service_stub = ::Gapic::ServiceStub.new(
                 ::Google::Cloud::Retail::V2::PredictionService::Stub,
                 credentials:  credentials,
@@ -147,6 +154,13 @@ module Google
               )
             end
 
+            ##
+            # Get the associated client for mix-in of the Locations.
+            #
+            # @return [Google::Cloud::Location::Locations::Client]
+            #
+            attr_reader :location_client
+
             # Service calls
 
             ##
@@ -177,7 +191,7 @@ module Google
             #     The ID of the Recommendations AI serving config or placement.
             #     Before you can request predictions from your model, you must create at
             #     least one serving config or placement for it. For more information, see
-            #     [Managing serving configurations]
+            #     [Manage serving configs]
             #     (https://cloud.google.com/retail/docs/manage-configs).
             #
             #     The full list of available serving configs can be seen at
@@ -228,12 +242,11 @@ module Google
             #      * filterOutOfStockItems  tag=(-"promotional")
             #      * filterOutOfStockItems
             #
-            #     If your filter blocks all prediction results, the API will return generic
-            #     (unfiltered) popular products. If you only want results strictly matching
-            #     the filters, set `strictFiltering` to True in `PredictRequest.params` to
-            #     receive empty results instead.
-            #     Note that the API will never return items with storageStatus of "EXPIRED"
-            #     or "DELETED" regardless of filter choices.
+            #     If your filter blocks all prediction results, the API will return *no*
+            #     results. If instead you want empty result sets to return generic
+            #     (unfiltered) popular products, set `strictFiltering` to False in
+            #     `PredictRequest.params`. Note that the API will never return items with
+            #     storageStatus of "EXPIRED" or "DELETED" regardless of filter choices.
             #
             #     If `filterSyntaxV2` is set to true under the `params` field, then
             #     attribute-based expressions are expected instead of the above described
@@ -258,7 +271,7 @@ module Google
             #     * `returnScore`: Boolean. If set to true, the prediction 'score'
             #        corresponding to each returned product will be set in the
             #        `results.metadata` field in the prediction response. The given
-            #        'score' indicates the probability of an product being clicked/purchased
+            #        'score' indicates the probability of a product being clicked/purchased
             #        given the user's context and history.
             #     * `strictFiltering`: Boolean. True by default. If set to false, the service
             #        will return generic (unfiltered) popular products instead of empty if

data/lib/google/cloud/retail/v2/prediction_service.rb

@@ -33,7 +33,7 @@ module Google
         ##
         # Service for making recommendation prediction.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/retail/v2/prediction_service"
         #     client = ::Google::Cloud::Retail::V2::PredictionService::Client.new

data/lib/google/cloud/retail/v2/prediction_service_pb.rb

@@ -6,6 +6,7 @@ require 'google/protobuf'
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
 require 'google/cloud/retail/v2/user_event_pb'
 require 'google/protobuf/struct_pb'