google-cloud-retail-v2 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d734af19fd64b2147921c37cd075cc519a0d3cd078572b48c16f5050ed0540f7
-  data.tar.gz: 223e56bf3584d620c7c1727678bf423e4e63c7e328828716d9b603e34b03d1b2
+  metadata.gz: c5c0b8b99ddda142b43391e92256b5e40721abbc0d0dca397b43dbbc9008915e
+  data.tar.gz: 31498ffda04297766aec21a982fa96c74c5bed1a25a23228d0883b26357e8ce9
 SHA512:
-  metadata.gz: 5cc895e75d1a8c5f005dd495d094fae51a059c056a3a62316f7c6a179f0cb66101d39fdf62b00aeeb9a77428cb1bc741a7de5c476c67a083502932ec0dda1406
-  data.tar.gz: 462e1ab0eaaaf1a9ad2316aa2738edb272434a7e8d170040b8c52c7437e550088b6fc37c4d9a10fd5bd5c18b7aeff05de498ece96712534da6fe7f36b96104ff
+  metadata.gz: 56ca7e4df5b5edc7f3f25c2a574509753f6880e191c7f5078832dfa10bed5e7456800619c146c6239f4219552912a0f50b462aa226c31746191dcdc3e3e763aa
+  data.tar.gz: f921bee36e85f1b1cbed8412ecd8866ef725ef27d0cf7aa8a0cad2a851e43e23b0af2da122be002bb9beadf28c27d9e1d7ddc0da866c4ec3c077699745753cbe

data/README.md

@@ -47,7 +47,7 @@ for general usage information.
 
 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/current/stdlibs/logger/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
+or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/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_service/client.rb

@@ -1307,9 +1307,9 @@ module Google
             #    *  (`String`) The path to a service account key file in JSON format
             #    *  (`Hash`) A service account key as a Hash
             #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-            #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+            #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
             #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-            #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+            #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials

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

@@ -1041,9 +1041,9 @@ module Google
               #    *  (`String`) The path to a service account key file in JSON format
               #    *  (`Hash`) A service account key as a Hash
               #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-              #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+              #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
               #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-              #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+              #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
               #    *  (`nil`) indicating no credentials
               #   @return [::Object]
               # @!attribute [rw] scope

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

@@ -137,6 +137,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :SOLUTION_TYPE_RECOMMENDATION, 1
       value :SOLUTION_TYPE_SEARCH, 2
     end
+    add_enum "google.cloud.retail.v2.RecommendationsFilteringOption" do
+      value :RECOMMENDATIONS_FILTERING_OPTION_UNSPECIFIED, 0
+      value :RECOMMENDATIONS_FILTERING_DISABLED, 1
+      value :RECOMMENDATIONS_FILTERING_ENABLED, 3
+    end
     add_enum "google.cloud.retail.v2.SearchSolutionUseCase" do
       value :SEARCH_SOLUTION_USE_CASE_UNSPECIFIED, 0
       value :SEARCH_SOLUTION_USE_CASE_SEARCH, 1
@@ -174,6 +179,7 @@ module Google
         LocalInventory = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.LocalInventory").msgclass
         AttributeConfigLevel = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.AttributeConfigLevel").enummodule
         SolutionType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SolutionType").enummodule
+        RecommendationsFilteringOption = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.RecommendationsFilteringOption").enummodule
         SearchSolutionUseCase = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchSolutionUseCase").enummodule
       end
     end

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

@@ -28,7 +28,7 @@ module Google
           ##
           # Client for the CompletionService service.
           #
-          # Auto-completion service for retail.
+          # Autocomplete service for retail.
           #
           # This feature is only available for users who have Retail Search enabled.
           # Enable Retail Search on Cloud Console before using this feature.
@@ -195,7 +195,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload complete_query(catalog: nil, query: nil, visitor_id: nil, language_codes: nil, device_type: nil, dataset: nil, max_suggestions: nil)
+            # @overload complete_query(catalog: nil, query: nil, visitor_id: nil, language_codes: nil, device_type: nil, dataset: nil, max_suggestions: nil, entity: nil)
             #   Pass arguments to `complete_query` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -265,6 +265,13 @@ module Google
             #
             #     The maximum allowed max suggestions is 20. If it is set higher, it will be
             #     capped by 20.
+            #   @param entity [::String]
+            #     The entity for customers that may run multiple different entities, domains,
+            #     sites or regions, for example, `Google US`, `Google Ads`, `Waymo`,
+            #     `google.com`, `youtube.com`, etc.
+            #     If this is set, it should be exactly matched with
+            #     {::Google::Cloud::Retail::V2::UserEvent#entity UserEvent.entity} to get
+            #     per-entity autocomplete results.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Retail::V2::CompleteQueryResponse]
@@ -479,9 +486,9 @@ module Google
             #    *  (`String`) The path to a service account key file in JSON format
             #    *  (`Hash`) A service account key as a Hash
             #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-            #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+            #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
             #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-            #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+            #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials

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

@@ -620,9 +620,9 @@ module Google
             #    *  (`String`) The path to a service account key file in JSON format
             #    *  (`Hash`) A service account key as a Hash
             #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-            #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+            #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
             #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-            #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+            #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials

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

@@ -30,7 +30,7 @@ module Google
             ##
             # REST client for the CompletionService service.
             #
-            # Auto-completion service for retail.
+            # Autocomplete service for retail.
             #
             # This feature is only available for users who have Retail Search enabled.
             # Enable Retail Search on Cloud Console before using this feature.
@@ -186,7 +186,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload complete_query(catalog: nil, query: nil, visitor_id: nil, language_codes: nil, device_type: nil, dataset: nil, max_suggestions: nil)
+              # @overload complete_query(catalog: nil, query: nil, visitor_id: nil, language_codes: nil, device_type: nil, dataset: nil, max_suggestions: nil, entity: nil)
               #   Pass arguments to `complete_query` via keyword arguments. Note that at
               #   least one keyword argument is required. To specify no parameters, or to keep all
               #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -256,6 +256,13 @@ module Google
               #
               #     The maximum allowed max suggestions is 20. If it is set higher, it will be
               #     capped by 20.
+              #   @param entity [::String]
+              #     The entity for customers that may run multiple different entities, domains,
+              #     sites or regions, for example, `Google US`, `Google Ads`, `Waymo`,
+              #     `google.com`, `youtube.com`, etc.
+              #     If this is set, it should be exactly matched with
+              #     {::Google::Cloud::Retail::V2::UserEvent#entity UserEvent.entity} to get
+              #     per-entity autocomplete results.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::Retail::V2::CompleteQueryResponse]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -417,9 +424,9 @@ module Google
               #    *  (`String`) The path to a service account key file in JSON format
               #    *  (`Hash`) A service account key as a Hash
               #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-              #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+              #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
               #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-              #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+              #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
               #    *  (`nil`) indicating no credentials
               #   @return [::Object]
               # @!attribute [rw] scope

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

@@ -411,9 +411,9 @@ module Google
               #    *  (`String`) The path to a service account key file in JSON format
               #    *  (`Hash`) A service account key as a Hash
               #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-              #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+              #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
               #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-              #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+              #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
               #    *  (`nil`) indicating no credentials
               #   @return [::Object]
               # @!attribute [rw] scope

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

@@ -32,7 +32,7 @@ module Google
     module Retail
       module V2
         ##
-        # Auto-completion service for retail.
+        # Autocomplete service for retail.
         #
         # This feature is only available for users who have Retail Search enabled.
         # Enable Retail Search on Cloud Console before using this feature.

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

@@ -33,7 +33,7 @@ module Google
     module Retail
       module V2
         ##
-        # Auto-completion service for retail.
+        # Autocomplete service for retail.
         #
         # This feature is only available for users who have Retail Search enabled.
         # Enable Retail Search on Cloud Console before using this feature.

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

@@ -21,6 +21,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :device_type, :string, 4
       optional :dataset, :string, 6
       optional :max_suggestions, :int32, 5
+      optional :entity, :string, 10
     end
     add_message "google.cloud.retail.v2.CompleteQueryResponse" do
       repeated :completion_results, :message, 1, "google.cloud.retail.v2.CompleteQueryResponse.CompletionResult"

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

@@ -24,7 +24,7 @@ module Google
     module Retail
       module V2
         module CompletionService
-          # Auto-completion service for retail.
+          # Autocomplete service for retail.
           #
           # This feature is only available for users who have Retail Search enabled.
           # Enable Retail Search on Cloud Console before using this feature.

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

@@ -671,9 +671,9 @@ module Google
             #    *  (`String`) The path to a service account key file in JSON format
             #    *  (`Hash`) A service account key as a Hash
             #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-            #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+            #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
             #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-            #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+            #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials

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

@@ -543,9 +543,9 @@ module Google
               #    *  (`String`) The path to a service account key file in JSON format
               #    *  (`Hash`) A service account key as a Hash
               #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-              #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+              #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
               #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-              #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+              #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
               #    *  (`nil`) indicating no credentials
               #   @return [::Object]
               # @!attribute [rw] scope

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

@@ -0,0 +1,70 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/retail/v2/model.proto
+
+require 'google/protobuf'
+
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/cloud/retail/v2/common_pb'
+require 'google/protobuf/timestamp_pb'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/retail/v2/model.proto", :syntax => :proto3) do
+    add_message "google.cloud.retail.v2.Model" do
+      optional :name, :string, 1
+      optional :display_name, :string, 2
+      optional :training_state, :enum, 3, "google.cloud.retail.v2.Model.TrainingState"
+      optional :serving_state, :enum, 4, "google.cloud.retail.v2.Model.ServingState"
+      optional :create_time, :message, 5, "google.protobuf.Timestamp"
+      optional :update_time, :message, 6, "google.protobuf.Timestamp"
+      optional :type, :string, 7
+      optional :optimization_objective, :string, 8
+      optional :periodic_tuning_state, :enum, 11, "google.cloud.retail.v2.Model.PeriodicTuningState"
+      optional :last_tune_time, :message, 12, "google.protobuf.Timestamp"
+      optional :tuning_operation, :string, 15
+      optional :data_state, :enum, 16, "google.cloud.retail.v2.Model.DataState"
+      optional :filtering_option, :enum, 18, "google.cloud.retail.v2.RecommendationsFilteringOption"
+      repeated :serving_config_lists, :message, 19, "google.cloud.retail.v2.Model.ServingConfigList"
+    end
+    add_message "google.cloud.retail.v2.Model.ServingConfigList" do
+      repeated :serving_config_ids, :string, 1
+    end
+    add_enum "google.cloud.retail.v2.Model.ServingState" do
+      value :SERVING_STATE_UNSPECIFIED, 0
+      value :INACTIVE, 1
+      value :ACTIVE, 2
+      value :TUNED, 3
+    end
+    add_enum "google.cloud.retail.v2.Model.TrainingState" do
+      value :TRAINING_STATE_UNSPECIFIED, 0
+      value :PAUSED, 1
+      value :TRAINING, 2
+    end
+    add_enum "google.cloud.retail.v2.Model.PeriodicTuningState" do
+      value :PERIODIC_TUNING_STATE_UNSPECIFIED, 0
+      value :PERIODIC_TUNING_DISABLED, 1
+      value :ALL_TUNING_DISABLED, 3
+      value :PERIODIC_TUNING_ENABLED, 2
+    end
+    add_enum "google.cloud.retail.v2.Model.DataState" do
+      value :DATA_STATE_UNSPECIFIED, 0
+      value :DATA_OK, 1
+      value :DATA_ERROR, 2
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        Model = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Model").msgclass
+        Model::ServingConfigList = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Model.ServingConfigList").msgclass
+        Model::ServingState = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Model.ServingState").enummodule
+        Model::TrainingState = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Model.TrainingState").enummodule
+        Model::PeriodicTuningState = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Model.PeriodicTuningState").enummodule
+        Model::DataState = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Model.DataState").enummodule
+      end
+    end
+  end
+end