google-cloud-discovery_engine-v1beta 0.15.0 → 0.17.0

data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb

@@ -163,14 +163,26 @@ module Google
                   endpoint: @config.endpoint,
                   endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
                   universe_domain: @config.universe_domain,
-                  credentials: credentials
+                  credentials: credentials,
+                  logger: @config.logger
                 )
 
+                @completion_service_stub.logger(stub: true)&.info do |entry|
+                  entry.set_system_name
+                  entry.set_service
+                  entry.message = "Created client for #{entry.service}"
+                  entry.set_credentials_fields credentials
+                  entry.set "customEndpoint", @config.endpoint if @config.endpoint
+                  entry.set "defaultTimeout", @config.timeout if @config.timeout
+                  entry.set "quotaProject", @quota_project_id if @quota_project_id
+                end
+
                 @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
                   config.credentials = credentials
                   config.quota_project = @quota_project_id
                   config.endpoint = @completion_service_stub.endpoint
                   config.universe_domain = @completion_service_stub.universe_domain
+                  config.logger = @completion_service_stub.logger if config.respond_to? :logger=
                 end
               end
 
@@ -188,6 +200,15 @@ module Google
               #
               attr_reader :location_client
 
+              ##
+              # The logger used for request/response debug logging.
+              #
+              # @return [Logger]
+              #
+              def logger
+                @completion_service_stub.logger
+              end
+
               # Service calls
 
               ##
@@ -306,7 +327,146 @@ module Google
 
                 @completion_service_stub.complete_query request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Completes the user input with advanced keyword suggestions.
+              #
+              # @overload advanced_complete_query(request, options = nil)
+              #   Pass arguments to `advanced_complete_query` via a request object, either of type
+              #   {::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @overload advanced_complete_query(completion_config: nil, query: nil, query_model: nil, user_pseudo_id: nil, user_info: nil, include_tail_suggestions: nil, boost_spec: nil, suggestion_types: nil)
+              #   Pass arguments to `advanced_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).
+              #
+              #   @param completion_config [::String]
+              #     Required. The completion_config of the parent dataStore or engine resource
+              #     name for which the completion is performed, such as
+              #     `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig`
+              #     `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.
+              #   @param query [::String]
+              #     Required. The typeahead input used to fetch suggestions. Maximum length is
+              #     128 characters.
+              #
+              #     The query can not be empty for most of the suggestion types. If it is
+              #     empty, an `INVALID_ARGUMENT` error is returned. The exception is when the
+              #     suggestion_types contains only the type `RECENT_SEARCH`, the query can
+              #     be an empty string. The is called "zero prefix" feature, which returns
+              #     user's recently searched queries given the empty query.
+              #   @param query_model [::String]
+              #     Specifies the autocomplete data model. This overrides any model specified
+              #     in the Configuration > Autocomplete section of the Cloud console. Currently
+              #     supported values:
+              #
+              #     * `document` - Using suggestions generated from user-imported documents.
+              #     * `search-history` - Using suggestions generated from the past history of
+              #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchService::Rest::Client#search SearchService.Search}
+              #     API calls. Do not use it when there is no traffic for Search API.
+              #     * `user-event` - Using suggestions generated from user-imported search
+              #     events.
+              #     * `document-completable` - Using suggestions taken directly from
+              #     user-imported document fields marked as completable.
+              #
+              #     Default values:
+              #
+              #     * `document` is the default model for regular dataStores.
+              #     * `search-history` is the default model for site search dataStores.
+              #   @param user_pseudo_id [::String]
+              #     A unique identifier for tracking visitors. For example, this could be
+              #     implemented with an HTTP cookie, which should be able to uniquely identify
+              #     a visitor on a single device. This unique identifier should not change if
+              #     the visitor logs in or out of the website.
+              #
+              #     This field should NOT have a fixed value such as `unknown_visitor`.
+              #
+              #     This should be the same identifier as
+              #     {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#user_pseudo_id UserEvent.user_pseudo_id}
+              #     and
+              #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#user_pseudo_id SearchRequest.user_pseudo_id}.
+              #
+              #     The field must be a UTF-8 encoded string with a length limit of 128
+              #   @param user_info [::Google::Cloud::DiscoveryEngine::V1beta::UserInfo, ::Hash]
+              #     Optional. Information about the end user.
+              #
+              #     This should be the same identifier information as
+              #     {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#user_info UserEvent.user_info}
+              #     and
+              #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#user_info SearchRequest.user_info}.
+              #   @param include_tail_suggestions [::Boolean]
+              #     Indicates if tail suggestions should be returned if there are no
+              #     suggestions that match the full query. Even if set to true, if there are
+              #     suggestions that match the full query, those are returned and no
+              #     tail suggestions are returned.
+              #   @param boost_spec [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest::BoostSpec, ::Hash]
+              #     Optional. Specification to boost suggestions matching the condition.
+              #   @param suggestion_types [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest::SuggestionType>]
+              #     Optional. Suggestion types to return. If empty or unspecified, query
+              #     suggestions are returned. Only one suggestion type is supported at the
+              #     moment.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/discovery_engine/v1beta"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest.new
+              #
+              #   # Call the advanced_complete_query method.
+              #   result = client.advanced_complete_query request
+              #
+              #   # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse.
+              #   p result
+              #
+              def advanced_complete_query request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                call_metadata = @config.rpcs.advanced_complete_query.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.advanced_complete_query.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.advanced_complete_query.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @completion_service_stub.advanced_complete_query request, options do |result, operation|
+                  yield result, operation if block_given?
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -407,7 +567,7 @@ module Google
                 @completion_service_stub.import_suggestion_deny_list_entries request, options do |result, operation|
                   result = ::Gapic::Operation.new result, @operations_client, options: options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -497,7 +657,7 @@ module Google
                 @completion_service_stub.purge_suggestion_deny_list_entries request, options do |result, operation|
                   result = ::Gapic::Operation.new result, @operations_client, options: options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -597,7 +757,7 @@ module Google
                 @completion_service_stub.import_completion_suggestions request, options do |result, operation|
                   result = ::Gapic::Operation.new result, @operations_client, options: options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -688,7 +848,7 @@ module Google
                 @completion_service_stub.purge_completion_suggestions request, options do |result, operation|
                   result = ::Gapic::Operation.new result, @operations_client, options: options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -768,6 +928,11 @@ module Google
               #   default endpoint URL. The default value of nil uses the environment
               #   universe (usually the default "googleapis.com" universe).
               #   @return [::String,nil]
+              # @!attribute [rw] logger
+              #   A custom logger to use for request/response debug logging, or the value
+              #   `:default` (the default) to construct a default logger, or `nil` to
+              #   explicitly disable logging.
+              #   @return [::Logger,:default,nil]
               #
               class Configuration
                 extend ::Gapic::Config
@@ -789,6 +954,7 @@ module Google
                 config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
                 config_attr :quota_project, nil, ::String, nil
                 config_attr :universe_domain, nil, ::String, nil
+                config_attr :logger, :default, ::Logger, nil, :default
 
                 # @private
                 def initialize parent_config = nil
@@ -833,6 +999,11 @@ module Google
                   #
                   attr_reader :complete_query
                   ##
+                  # RPC-specific configuration for `advanced_complete_query`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :advanced_complete_query
+                  ##
                   # RPC-specific configuration for `import_suggestion_deny_list_entries`
                   # @return [::Gapic::Config::Method]
                   #
@@ -857,6 +1028,8 @@ module Google
                   def initialize parent_rpcs = nil
                     complete_query_config = parent_rpcs.complete_query if parent_rpcs.respond_to? :complete_query
                     @complete_query = ::Gapic::Config::Method.new complete_query_config
+                    advanced_complete_query_config = parent_rpcs.advanced_complete_query if parent_rpcs.respond_to? :advanced_complete_query
+                    @advanced_complete_query = ::Gapic::Config::Method.new advanced_complete_query_config
                     import_suggestion_deny_list_entries_config = parent_rpcs.import_suggestion_deny_list_entries if parent_rpcs.respond_to? :import_suggestion_deny_list_entries
                     @import_suggestion_deny_list_entries = ::Gapic::Config::Method.new import_suggestion_deny_list_entries_config
                     purge_suggestion_deny_list_entries_config = parent_rpcs.purge_suggestion_deny_list_entries if parent_rpcs.respond_to? :purge_suggestion_deny_list_entries

data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/operations.rb

@@ -115,14 +115,6 @@ module Google
               # Lists operations that match the specified filter in the request. If the
               # server doesn't support this method, it returns `UNIMPLEMENTED`.
               #
-              # NOTE: the `name` binding allows API services to override the binding
-              # to use different resource name schemes, such as `users/*/operations`. To
-              # override the binding, API services can add a binding such as
-              # `"/v1/{name=users/*}/operations"` to their service configuration.
-              # For backwards compatibility, the default name includes the operations
-              # collection id, however overriding users must ensure the name binding
-              # is the parent resource, without the operations collection id.
-              #
               # @overload list_operations(request, options = nil)
               #   Pass arguments to `list_operations` via a request object, either of type
               #   {::Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
@@ -204,7 +196,7 @@ module Google
                 @operations_stub.list_operations request, options do |result, operation|
                   result = ::Gapic::Rest::PagedEnumerable.new @operations_stub, :list_operations, "operations", request, result, options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -293,7 +285,7 @@ module Google
                 @operations_stub.get_operation request, options do |result, operation|
                   result = ::Gapic::Operation.new result, @operations_client, options: options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -375,7 +367,6 @@ module Google
 
                 @operations_stub.delete_operation request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -390,8 +381,9 @@ module Google
               # other methods to check whether the cancellation succeeded or whether the
               # operation completed despite cancellation. On successful cancellation,
               # the operation is not deleted; instead, it becomes an operation with
-              # an {::Google::Longrunning::Operation#error Operation.error} value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
-              # corresponding to `Code.CANCELLED`.
+              # an {::Google::Longrunning::Operation#error Operation.error} value with a
+              # {::Google::Rpc::Status#code google.rpc.Status.code} of `1`, corresponding to
+              # `Code.CANCELLED`.
               #
               # @overload cancel_operation(request, options = nil)
               #   Pass arguments to `cancel_operation` via a request object, either of type
@@ -463,7 +455,6 @@ module Google
 
                 @operations_stub.cancel_operation request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -543,6 +534,11 @@ module Google
               #   default endpoint URL. The default value of nil uses the environment
               #   universe (usually the default "googleapis.com" universe).
               #   @return [::String,nil]
+              # @!attribute [rw] logger
+              #   A custom logger to use for request/response debug logging, or the value
+              #   `:default` (the default) to construct a default logger, or `nil` to
+              #   explicitly disable logging.
+              #   @return [::Logger,:default,nil]
               #
               class Configuration
                 extend ::Gapic::Config
@@ -564,6 +560,7 @@ module Google
                 config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
                 config_attr :quota_project, nil, ::String, nil
                 config_attr :universe_domain, nil, ::String, nil
+                config_attr :logger, :default, ::Logger, nil, :default
 
                 # @private
                 def initialize parent_config = nil
@@ -683,16 +680,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "list_operations",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Longrunning::ListOperationsResponse.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -721,16 +720,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "get_operation",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -759,16 +760,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "delete_operation",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -797,16 +800,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "cancel_operation",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##