google-cloud-discovery_engine-v1beta 0.27.0 → 0.28.0

data/lib/google/cloud/discovery_engine/v1beta/completion_service/credentials.rb

@@ -26,7 +26,11 @@ module Google
           # Credentials for the CompletionService API.
           class Credentials < ::Google::Auth::Credentials
             self.scope = [
-              "https://www.googleapis.com/auth/cloud-platform"
+              "https://www.googleapis.com/auth/cloud-platform",
+              "https://www.googleapis.com/auth/cloud_search.query",
+              "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
+              "https://www.googleapis.com/auth/discoveryengine.readwrite",
+              "https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
             ]
             self.env_vars = [
               "GOOGLE_CLOUD_CREDENTIALS",

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

@@ -255,10 +255,10 @@ module Google
               #     * `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.
+              #     Optional. 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`.
               #
@@ -345,7 +345,7 @@ module Google
               #   @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)
+              # @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, suggestion_type_specs: nil, experiment_ids: 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).
@@ -365,9 +365,9 @@ module Google
               #     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:
+              #     Specifies the autocomplete query model, which only applies to the QUERY
+              #     SuggestionType. 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
@@ -383,10 +383,10 @@ module Google
               #     * `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.
+              #     Optional. 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`.
               #
@@ -414,6 +414,10 @@ module Google
               #     Optional. Suggestion types to return. If empty or unspecified, query
               #     suggestions are returned. Only one suggestion type is supported at the
               #     moment.
+              #   @param suggestion_type_specs [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest::SuggestionTypeSpec, ::Hash>]
+              #     Optional. Specification of each suggestion type.
+              #   @param experiment_ids [::Array<::String>]
+              #     Optional. Experiment ids for this request.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -864,6 +868,122 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Removes the search history suggestion in an engine for a user. This will
+              # remove the suggestion from being returned in the
+              # {::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse#recent_search_suggestions AdvancedCompleteQueryResponse.recent_search_suggestions}
+              # for this user. If the user searches the same suggestion again, the new
+              # history will override and suggest this suggestion again.
+              #
+              # @overload remove_suggestion(request, options = nil)
+              #   Pass arguments to `remove_suggestion` via a request object, either of type
+              #   {::Google::Cloud::DiscoveryEngine::V1beta::RemoveSuggestionRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::DiscoveryEngine::V1beta::RemoveSuggestionRequest, ::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 remove_suggestion(search_history_suggestion: nil, remove_all_search_history_suggestions: nil, completion_config: nil, user_pseudo_id: nil, user_info: nil, remove_time: nil)
+              #   Pass arguments to `remove_suggestion` 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 search_history_suggestion [::String]
+              #     The search history suggestion to be removed.
+              #
+              #     Note: The following parameters are mutually exclusive: `search_history_suggestion`, `remove_all_search_history_suggestions`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
+              #   @param remove_all_search_history_suggestions [::Boolean]
+              #     Remove all search history suggestions for the user.
+              #
+              #     Note: The following parameters are mutually exclusive: `remove_all_search_history_suggestions`, `search_history_suggestion`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
+              #   @param completion_config [::String]
+              #     Required. The completion_config of the parent engine resource name for
+              #     which the search history suggestion is to be removed, such as
+              #     `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.
+              #   @param user_pseudo_id [::String]
+              #     Required. 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 remove_time [::Google::Protobuf::Timestamp, ::Hash]
+              #     Required. Time at which the suggestion was removed. If not set, the current
+              #     time will be used.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::RemoveSuggestionResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::DiscoveryEngine::V1beta::RemoveSuggestionResponse]
+              #
+              # @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::RemoveSuggestionRequest.new
+              #
+              #   # Call the remove_suggestion method.
+              #   result = client.remove_suggestion request
+              #
+              #   # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::RemoveSuggestionResponse.
+              #   p result
+              #
+              def remove_suggestion request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::RemoveSuggestionRequest
+
+                # 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.remove_suggestion.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.remove_suggestion.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.remove_suggestion.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @completion_service_stub.remove_suggestion request, options do |result, operation|
+                  yield result, operation if block_given?
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
               ##
               # Configuration class for the CompletionService REST API.
               #
@@ -1042,6 +1162,11 @@ module Google
                   # @return [::Gapic::Config::Method]
                   #
                   attr_reader :purge_completion_suggestions
+                  ##
+                  # RPC-specific configuration for `remove_suggestion`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :remove_suggestion
 
                   # @private
                   def initialize parent_rpcs = nil
@@ -1057,6 +1182,8 @@ module Google
                     @import_completion_suggestions = ::Gapic::Config::Method.new import_completion_suggestions_config
                     purge_completion_suggestions_config = parent_rpcs.purge_completion_suggestions if parent_rpcs.respond_to? :purge_completion_suggestions
                     @purge_completion_suggestions = ::Gapic::Config::Method.new purge_completion_suggestions_config
+                    remove_suggestion_config = parent_rpcs.remove_suggestion if parent_rpcs.respond_to? :remove_suggestion
+                    @remove_suggestion = ::Gapic::Config::Method.new remove_suggestion_config
 
                     yield self if block_given?
                   end

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

@@ -929,6 +929,13 @@ module Google
                                                             ["name", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/?$}, false]
                                                           ]
                                                         )
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1beta/{name}/operations",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/?$}, false]
+                                                          ]
+                                                        )
                                                         .with_bindings(
                                                           uri_method: :get,
                                                           uri_template: "/v1beta/{name}/operations",
@@ -1006,6 +1013,13 @@ module Google
                                                             ["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine/targetSites/operations/[^/]+/?$}, false]
                                                           ]
                                                         )
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1beta/{name}",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+/operations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
                                                         .with_bindings(
                                                           uri_method: :get,
                                                           uri_template: "/v1beta/{name}",
@@ -1048,6 +1062,13 @@ module Google
                                                             ["name", %r{^projects/[^/]+/locations/[^/]+/evaluations/[^/]+/operations/[^/]+/?$}, false]
                                                           ]
                                                         )
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1beta/{name}",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/operations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
                                                         .with_bindings(
                                                           uri_method: :get,
                                                           uri_template: "/v1beta/{name}",

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

@@ -313,6 +313,46 @@ module Google
                 end
               end
 
+              ##
+              # Baseline implementation for the remove_suggestion REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::RemoveSuggestionRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::RemoveSuggestionResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::DiscoveryEngine::V1beta::RemoveSuggestionResponse]
+              #   A result object deserialized from the server's reply
+              def remove_suggestion request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_remove_suggestion_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "remove_suggestion",
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::DiscoveryEngine::V1beta::RemoveSuggestionResponse.decode_json response.body, ignore_unknown_fields: true
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
+              end
+
               ##
               # @private
               #
@@ -498,6 +538,28 @@ module Google
                                                         )
                 transcoder.transcode request_pb
               end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the remove_suggestion REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::RemoveSuggestionRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_remove_suggestion_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1beta/{completion_config}:removeSuggestion",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["completion_config", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
             end
           end
         end

data/lib/google/cloud/discovery_engine/v1beta/control_service/credentials.rb

@@ -26,7 +26,9 @@ module Google
           # Credentials for the ControlService API.
           class Credentials < ::Google::Auth::Credentials
             self.scope = [
-              "https://www.googleapis.com/auth/cloud-platform"
+              "https://www.googleapis.com/auth/cloud-platform",
+              "https://www.googleapis.com/auth/discoveryengine.readwrite",
+              "https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
             ]
             self.env_vars = [
               "GOOGLE_CLOUD_CREDENTIALS",

data/lib/google/cloud/discovery_engine/v1beta/control_service/paths.rb

@@ -137,6 +137,59 @@ module Google
               resource.call(**args)
             end
 
+            ##
+            # Create a fully-qualified Document resource string.
+            #
+            # @overload document_path(project:, location:, data_store:, branch:, document:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}`
+            #
+            #   @param project [String]
+            #   @param location [String]
+            #   @param data_store [String]
+            #   @param branch [String]
+            #   @param document [String]
+            #
+            # @overload document_path(project:, location:, collection:, data_store:, branch:, document:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`
+            #
+            #   @param project [String]
+            #   @param location [String]
+            #   @param collection [String]
+            #   @param data_store [String]
+            #   @param branch [String]
+            #   @param document [String]
+            #
+            # @return [::String]
+            def document_path **args
+              resources = {
+                "branch:data_store:document:location:project" => (proc do |project:, location:, data_store:, branch:, document:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                  raise ::ArgumentError, "data_store cannot contain /" if data_store.to_s.include? "/"
+                  raise ::ArgumentError, "branch cannot contain /" if branch.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/dataStores/#{data_store}/branches/#{branch}/documents/#{document}"
+                end),
+                "branch:collection:data_store:document:location:project" => (proc do |project:, location:, collection:, data_store:, branch:, document:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                  raise ::ArgumentError, "collection cannot contain /" if collection.to_s.include? "/"
+                  raise ::ArgumentError, "data_store cannot contain /" if data_store.to_s.include? "/"
+                  raise ::ArgumentError, "branch cannot contain /" if branch.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/collections/#{collection}/dataStores/#{data_store}/branches/#{branch}/documents/#{document}"
+                end)
+              }
+
+              resource = resources[args.keys.sort.join(":")]
+              raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
+              resource.call(**args)
+            end
+
             ##
             # Create a fully-qualified Engine resource string.
             #