google-cloud-discovery_engine-v1 2.3.1 → 2.5.0

data/lib/google/cloud/discovery_engine/v1/assistant_service/rest/service_stub.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "google/cloud/discoveryengine/v1/assistant_service_pb"
+
+module Google
+  module Cloud
+    module DiscoveryEngine
+      module V1
+        module AssistantService
+          module Rest
+            ##
+            # REST service stub for the AssistantService service.
+            # Service stub contains baseline method implementations
+            # including transcoding, making the REST call, and deserialing the response.
+            #
+            class ServiceStub
+              # @private
+              def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
+                # These require statements are intentionally placed here to initialize
+                # the REST modules only when it's required.
+                require "gapic/rest"
+
+                @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
+                                                             endpoint_template: endpoint_template,
+                                                             universe_domain: universe_domain,
+                                                             credentials: credentials,
+                                                             numeric_enums: true,
+                                                             service_name: self.class,
+                                                             raise_faraday_errors: false,
+                                                             logger: logger
+              end
+
+              ##
+              # The effective universe domain
+              #
+              # @return [String]
+              #
+              def universe_domain
+                @client_stub.universe_domain
+              end
+
+              ##
+              # The effective endpoint
+              #
+              # @return [String]
+              #
+              def endpoint
+                @client_stub.endpoint
+              end
+
+              ##
+              # The logger used for request/response debug logging.
+              #
+              # @return [Logger]
+              #
+              def logger stub: false
+                stub ? @client_stub.stub_logger : @client_stub.logger
+              end
+
+              ##
+              # Baseline implementation for the stream_assist REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest]
+              #   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.
+              #
+              # @yieldparam chunk [::String] The chunk of data received during server streaming.
+              #
+              # @return [::Gapic::Rest::TransportOperation]
+              def stream_assist(request_pb, options = nil, &)
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_stream_assist_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: "stream_assist",
+                  options: options,
+                  is_server_streaming: true,
+                  &
+                )
+                ::Gapic::Rest::TransportOperation.new response
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the stream_assist REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_stream_assist_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1/{name}:streamAssist",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/discovery_engine/v1/assistant_service/rest.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/rest"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/discovery_engine/v1/version"
+
+require "google/cloud/discovery_engine/v1/assistant_service/credentials"
+require "google/cloud/discovery_engine/v1/assistant_service/paths"
+require "google/cloud/discovery_engine/v1/assistant_service/rest/client"
+
+module Google
+  module Cloud
+    module DiscoveryEngine
+      module V1
+        ##
+        # Service for managing Assistant configuration and assisting users.
+        #
+        # To load this service and instantiate a REST client:
+        #
+        #     require "google/cloud/discovery_engine/v1/assistant_service/rest"
+        #     client = ::Google::Cloud::DiscoveryEngine::V1::AssistantService::Rest::Client.new
+        #
+        module AssistantService
+          # Client for the REST transport
+          module Rest
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "rest", "helpers.rb"
+require "google/cloud/discovery_engine/v1/assistant_service/rest/helpers" if ::File.file? helper_path

data/lib/google/cloud/discovery_engine/v1/assistant_service.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/discovery_engine/v1/version"
+
+require "google/cloud/discovery_engine/v1/assistant_service/credentials"
+require "google/cloud/discovery_engine/v1/assistant_service/paths"
+require "google/cloud/discovery_engine/v1/assistant_service/client"
+require "google/cloud/discovery_engine/v1/assistant_service/rest"
+
+module Google
+  module Cloud
+    module DiscoveryEngine
+      module V1
+        ##
+        # Service for managing Assistant configuration and assisting users.
+        #
+        # @example Load this service and instantiate a gRPC client
+        #
+        #     require "google/cloud/discovery_engine/v1/assistant_service"
+        #     client = ::Google::Cloud::DiscoveryEngine::V1::AssistantService::Client.new
+        #
+        # @example Load this service and instantiate a REST client
+        #
+        #     require "google/cloud/discovery_engine/v1/assistant_service/rest"
+        #     client = ::Google::Cloud::DiscoveryEngine::V1::AssistantService::Rest::Client.new
+        #
+        module AssistantService
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "assistant_service", "helpers.rb"
+require "google/cloud/discovery_engine/v1/assistant_service/helpers" if ::File.file? helper_path

data/lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb

@@ -1625,11 +1625,23 @@ module Google
             #     A page token, received from a previous `ListSessions` call.
             #     Provide this to retrieve the subsequent page.
             #   @param filter [::String]
-            #     A filter to apply on the list results. The supported features are:
-            #     user_pseudo_id, state.
-            #
-            #     Example:
+            #     A comma-separated list of fields to filter by, in EBNF grammar.
+            #     The supported fields are:
+            #     * `user_pseudo_id`
+            #     * `state`
+            #     * `display_name`
+            #     * `starred`
+            #     * `is_pinned`
+            #     * `labels`
+            #     * `create_time`
+            #     * `update_time`
+            #
+            #     Examples:
             #     "user_pseudo_id = some_id"
+            #     "display_name = \"some_name\""
+            #     "starred = true"
+            #     "is_pinned=true AND (NOT labels:hidden)"
+            #     "create_time > \"1970-01-01T12:00:00Z\""
             #   @param order_by [::String]
             #     A comma-separated list of fields to order by, sorted in ascending order.
             #     Use "desc" after a field name for descending.

data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/client.rb

@@ -1529,11 +1529,23 @@ module Google
               #     A page token, received from a previous `ListSessions` call.
               #     Provide this to retrieve the subsequent page.
               #   @param filter [::String]
-              #     A filter to apply on the list results. The supported features are:
-              #     user_pseudo_id, state.
-              #
-              #     Example:
+              #     A comma-separated list of fields to filter by, in EBNF grammar.
+              #     The supported fields are:
+              #     * `user_pseudo_id`
+              #     * `state`
+              #     * `display_name`
+              #     * `starred`
+              #     * `is_pinned`
+              #     * `labels`
+              #     * `create_time`
+              #     * `update_time`
+              #
+              #     Examples:
               #     "user_pseudo_id = some_id"
+              #     "display_name = \"some_name\""
+              #     "starred = true"
+              #     "is_pinned=true AND (NOT labels:hidden)"
+              #     "create_time > \"1970-01-01T12:00:00Z\""
               #   @param order_by [::String]
               #     A comma-separated list of fields to order by, sorted in ascending order.
               #     Use "desc" after a field name for descending.

data/lib/google/cloud/discovery_engine/v1/rest.rb

@@ -16,10 +16,11 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
+require "google/cloud/discovery_engine/v1/search_service/rest"
+require "google/cloud/discovery_engine/v1/assistant_service/rest"
 require "google/cloud/discovery_engine/v1/cmek_config_service/rest"
 require "google/cloud/discovery_engine/v1/completion_service/rest"
 require "google/cloud/discovery_engine/v1/control_service/rest"
-require "google/cloud/discovery_engine/v1/search_service/rest"
 require "google/cloud/discovery_engine/v1/conversational_search_service/rest"
 require "google/cloud/discovery_engine/v1/data_store_service/rest"
 require "google/cloud/discovery_engine/v1/document_service/rest"
@@ -32,6 +33,7 @@ require "google/cloud/discovery_engine/v1/recommendation_service/rest"
 require "google/cloud/discovery_engine/v1/schema_service/rest"
 require "google/cloud/discovery_engine/v1/search_tuning_service/rest"
 require "google/cloud/discovery_engine/v1/serving_config_service/rest"
+require "google/cloud/discovery_engine/v1/session_service/rest"
 require "google/cloud/discovery_engine/v1/site_search_engine_service/rest"
 require "google/cloud/discovery_engine/v1/user_event_service/rest"
 require "google/cloud/discovery_engine/v1/user_license_service/rest"
@@ -46,7 +48,7 @@ module Google
       # @example
       #
       #     require "google/cloud/discovery_engine/v1/rest"
-      #     client = ::Google::Cloud::DiscoveryEngine::V1::CmekConfigService::Rest::Client.new
+      #     client = ::Google::Cloud::DiscoveryEngine::V1::SearchService::Rest::Client.new
       #
       module V1
       end

data/lib/google/cloud/discovery_engine/v1/search_service/client.rb

@@ -217,7 +217,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, safe_search: nil, user_labels: nil, search_as_you_type_spec: nil, display_spec: nil, session: nil, session_spec: nil, relevance_threshold: nil, relevance_score_spec: nil)
+            # @overload search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, safe_search: nil, user_labels: nil, search_as_you_type_spec: nil, display_spec: nil, session: nil, session_spec: nil, relevance_threshold: nil, relevance_score_spec: nil, ranking_expression: nil, ranking_expression_backend: nil)
             #   Pass arguments to `search` 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).
@@ -415,22 +415,16 @@ module Google
             #     between /search API calls and /answer API calls.
             #
             #     Example #1 (multi-turn /search API calls):
-            #       1. Call /search API with the auto-session mode (see below).
-            #       2. Call /search API with the session ID generated in the first call.
-            #          Here, the previous search query gets considered in query
-            #          standing. I.e., if the first query is "How did Alphabet do in 2022?"
-            #          and the current query is "How about 2023?", the current query will
-            #          be interpreted as "How did Alphabet do in 2023?".
+            #       Call /search API with the session ID generated in the first call.
+            #       Here, the previous search query gets considered in query
+            #       standing. I.e., if the first query is "How did Alphabet do in 2022?"
+            #       and the current query is "How about 2023?", the current query will
+            #       be interpreted as "How did Alphabet do in 2023?".
             #
             #     Example #2 (coordination between /search API calls and /answer API calls):
-            #       1. Call /search API with the auto-session mode (see below).
-            #       2. Call /answer API with the session ID generated in the first call.
-            #          Here, the answer generation happens in the context of the search
-            #          results from the first search call.
-            #
-            #     Auto-session mode: when `projects/.../sessions/-` is used, a new session
-            #     gets automatically created. Otherwise, users can use the create-session API
-            #     to create a session manually.
+            #       Call /answer API with the session ID generated in the first call.
+            #       Here, the answer generation happens in the context of the search
+            #       results from the first search call.
             #
             #     Multi-turn Search feature is currently at private GA stage. Please use
             #     v1alpha or v1beta version instead before we launch this feature to public
@@ -449,6 +443,99 @@ module Google
             #     This feature is not supported for healthcare search.
             #   @param relevance_score_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceScoreSpec, ::Hash]
             #     Optional. The specification for returning the relevance score.
+            #   @param ranking_expression [::String]
+            #     The ranking expression controls the customized ranking on retrieval
+            #     documents. This overrides
+            #     {::Google::Cloud::DiscoveryEngine::V1::ServingConfig#ranking_expression ServingConfig.ranking_expression}.
+            #     The syntax and supported features depend on the
+            #     `ranking_expression_backend` value. If `ranking_expression_backend` is not
+            #     provided, it defaults to `RANK_BY_EMBEDDING`.
+            #
+            #     If
+            #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#ranking_expression_backend ranking_expression_backend}
+            #     is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
+            #     function or multiple functions that are joined by "+".
+            #
+            #       * ranking_expression = function, { " + ", function };
+            #
+            #     Supported functions:
+            #
+            #       * double * relevance_score
+            #       * double * dotProduct(embedding_field_path)
+            #
+            #     Function variables:
+            #
+            #       * `relevance_score`: pre-defined keywords, used for measure relevance
+            #       between query and document.
+            #       * `embedding_field_path`: the document embedding field
+            #       used with query embedding vector.
+            #       * `dotProduct`: embedding function between `embedding_field_path` and
+            #       query embedding vector.
+            #
+            #      Example ranking expression:
+            #
+            #        If document has an embedding field doc_embedding, the ranking expression
+            #        could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+            #
+            #     If
+            #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#ranking_expression_backend ranking_expression_backend}
+            #     is set to `RANK_BY_FORMULA`, the following expression types (and
+            #     combinations of those chained using + or
+            #     * operators) are supported:
+            #
+            #       * `double`
+            #       * `signal`
+            #       * `log(signal)`
+            #       * `exp(signal)`
+            #       * `rr(signal, double > 0)`  -- reciprocal rank transformation with second
+            #       argument being a denominator constant.
+            #       * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
+            #       * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
+            #       signal2 | double, else returns signal1.
+            #
+            #       Here are a few examples of ranking formulas that use the supported
+            #       ranking expression types:
+            #
+            #       - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
+            #       -- mostly rank by the logarithm of `keyword_similarity_score` with slight
+            #       `semantic_smilarity_score` adjustment.
+            #       - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
+            #       is_nan(keyword_similarity_score)` -- rank by the exponent of
+            #       `semantic_similarity_score` filling the value with 0 if it's NaN, also
+            #       add constant 0.3 adjustment to the final score if
+            #       `semantic_similarity_score` is NaN.
+            #       - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
+            #       rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
+            #       of `keyword_similarity_score` with slight adjustment of reciprocal rank
+            #       of `semantic_smilarity_score`.
+            #
+            #     The following signals are supported:
+            #
+            #       * `semantic_similarity_score`: semantic similarity adjustment that is
+            #       calculated using the embeddings generated by a proprietary Google model.
+            #       This score determines how semantically similar a search query is to a
+            #       document.
+            #       * `keyword_similarity_score`: keyword match adjustment uses the Best
+            #       Match 25 (BM25) ranking function. This score is calculated using a
+            #       probabilistic model to estimate the probability that a document is
+            #       relevant to a given query.
+            #       * `relevance_score`: semantic relevance adjustment that uses a
+            #       proprietary Google model to determine the meaning and intent behind a
+            #       user's query in context with the content in the documents.
+            #       * `pctr_rank`: predicted conversion rate adjustment as a rank use
+            #       predicted Click-through rate (pCTR) to gauge the relevance and
+            #       attractiveness of a search result from a user's perspective. A higher
+            #       pCTR suggests that the result is more likely to satisfy the user's query
+            #       and intent, making it a valuable signal for ranking.
+            #       * `freshness_rank`: freshness adjustment as a rank
+            #       * `document_age`: The time in hours elapsed since the document was last
+            #       updated, a floating-point number (e.g., 0.25 means 15 minutes).
+            #       * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
+            #       Google model to determine the keyword-based overlap between the query and
+            #       the document.
+            #       * `base_rank`: the default rank of the result
+            #   @param ranking_expression_backend [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RankingExpressionBackend]
+            #     The backend to use for the ranking expression evaluation.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult>]
@@ -545,7 +632,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload search_lite(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, safe_search: nil, user_labels: nil, search_as_you_type_spec: nil, display_spec: nil, session: nil, session_spec: nil, relevance_threshold: nil, relevance_score_spec: nil)
+            # @overload search_lite(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, safe_search: nil, user_labels: nil, search_as_you_type_spec: nil, display_spec: nil, session: nil, session_spec: nil, relevance_threshold: nil, relevance_score_spec: nil, ranking_expression: nil, ranking_expression_backend: nil)
             #   Pass arguments to `search_lite` 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).
@@ -743,22 +830,16 @@ module Google
             #     between /search API calls and /answer API calls.
             #
             #     Example #1 (multi-turn /search API calls):
-            #       1. Call /search API with the auto-session mode (see below).
-            #       2. Call /search API with the session ID generated in the first call.
-            #          Here, the previous search query gets considered in query
-            #          standing. I.e., if the first query is "How did Alphabet do in 2022?"
-            #          and the current query is "How about 2023?", the current query will
-            #          be interpreted as "How did Alphabet do in 2023?".
+            #       Call /search API with the session ID generated in the first call.
+            #       Here, the previous search query gets considered in query
+            #       standing. I.e., if the first query is "How did Alphabet do in 2022?"
+            #       and the current query is "How about 2023?", the current query will
+            #       be interpreted as "How did Alphabet do in 2023?".
             #
             #     Example #2 (coordination between /search API calls and /answer API calls):
-            #       1. Call /search API with the auto-session mode (see below).
-            #       2. Call /answer API with the session ID generated in the first call.
-            #          Here, the answer generation happens in the context of the search
-            #          results from the first search call.
-            #
-            #     Auto-session mode: when `projects/.../sessions/-` is used, a new session
-            #     gets automatically created. Otherwise, users can use the create-session API
-            #     to create a session manually.
+            #       Call /answer API with the session ID generated in the first call.
+            #       Here, the answer generation happens in the context of the search
+            #       results from the first search call.
             #
             #     Multi-turn Search feature is currently at private GA stage. Please use
             #     v1alpha or v1beta version instead before we launch this feature to public
@@ -777,6 +858,99 @@ module Google
             #     This feature is not supported for healthcare search.
             #   @param relevance_score_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceScoreSpec, ::Hash]
             #     Optional. The specification for returning the relevance score.
+            #   @param ranking_expression [::String]
+            #     The ranking expression controls the customized ranking on retrieval
+            #     documents. This overrides
+            #     {::Google::Cloud::DiscoveryEngine::V1::ServingConfig#ranking_expression ServingConfig.ranking_expression}.
+            #     The syntax and supported features depend on the
+            #     `ranking_expression_backend` value. If `ranking_expression_backend` is not
+            #     provided, it defaults to `RANK_BY_EMBEDDING`.
+            #
+            #     If
+            #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#ranking_expression_backend ranking_expression_backend}
+            #     is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
+            #     function or multiple functions that are joined by "+".
+            #
+            #       * ranking_expression = function, { " + ", function };
+            #
+            #     Supported functions:
+            #
+            #       * double * relevance_score
+            #       * double * dotProduct(embedding_field_path)
+            #
+            #     Function variables:
+            #
+            #       * `relevance_score`: pre-defined keywords, used for measure relevance
+            #       between query and document.
+            #       * `embedding_field_path`: the document embedding field
+            #       used with query embedding vector.
+            #       * `dotProduct`: embedding function between `embedding_field_path` and
+            #       query embedding vector.
+            #
+            #      Example ranking expression:
+            #
+            #        If document has an embedding field doc_embedding, the ranking expression
+            #        could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+            #
+            #     If
+            #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#ranking_expression_backend ranking_expression_backend}
+            #     is set to `RANK_BY_FORMULA`, the following expression types (and
+            #     combinations of those chained using + or
+            #     * operators) are supported:
+            #
+            #       * `double`
+            #       * `signal`
+            #       * `log(signal)`
+            #       * `exp(signal)`
+            #       * `rr(signal, double > 0)`  -- reciprocal rank transformation with second
+            #       argument being a denominator constant.
+            #       * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
+            #       * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
+            #       signal2 | double, else returns signal1.
+            #
+            #       Here are a few examples of ranking formulas that use the supported
+            #       ranking expression types:
+            #
+            #       - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
+            #       -- mostly rank by the logarithm of `keyword_similarity_score` with slight
+            #       `semantic_smilarity_score` adjustment.
+            #       - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
+            #       is_nan(keyword_similarity_score)` -- rank by the exponent of
+            #       `semantic_similarity_score` filling the value with 0 if it's NaN, also
+            #       add constant 0.3 adjustment to the final score if
+            #       `semantic_similarity_score` is NaN.
+            #       - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
+            #       rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
+            #       of `keyword_similarity_score` with slight adjustment of reciprocal rank
+            #       of `semantic_smilarity_score`.
+            #
+            #     The following signals are supported:
+            #
+            #       * `semantic_similarity_score`: semantic similarity adjustment that is
+            #       calculated using the embeddings generated by a proprietary Google model.
+            #       This score determines how semantically similar a search query is to a
+            #       document.
+            #       * `keyword_similarity_score`: keyword match adjustment uses the Best
+            #       Match 25 (BM25) ranking function. This score is calculated using a
+            #       probabilistic model to estimate the probability that a document is
+            #       relevant to a given query.
+            #       * `relevance_score`: semantic relevance adjustment that uses a
+            #       proprietary Google model to determine the meaning and intent behind a
+            #       user's query in context with the content in the documents.
+            #       * `pctr_rank`: predicted conversion rate adjustment as a rank use
+            #       predicted Click-through rate (pCTR) to gauge the relevance and
+            #       attractiveness of a search result from a user's perspective. A higher
+            #       pCTR suggests that the result is more likely to satisfy the user's query
+            #       and intent, making it a valuable signal for ranking.
+            #       * `freshness_rank`: freshness adjustment as a rank
+            #       * `document_age`: The time in hours elapsed since the document was last
+            #       updated, a floating-point number (e.g., 0.25 means 15 minutes).
+            #       * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
+            #       Google model to determine the keyword-based overlap between the query and
+            #       the document.
+            #       * `base_rank`: the default rank of the result
+            #   @param ranking_expression_backend [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RankingExpressionBackend]
+            #     The backend to use for the ranking expression evaluation.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult>]