google-cloud-discovery_engine-v1 2.6.2 → 2.7.0

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

@@ -210,7 +210,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, ranking_expression: nil, ranking_expression_backend: nil)
+              # @overload search(serving_config: nil, branch: nil, query: nil, page_categories: 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, ranking_expression: nil, ranking_expression_backend: nil, safe_search: nil, user_labels: nil, natural_language_query_understanding_spec: nil, search_as_you_type_spec: nil, display_spec: nil, crowding_specs: nil, session: nil, session_spec: nil, relevance_threshold: nil, relevance_score_spec: 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).
@@ -230,6 +230,24 @@ module Google
               #     documents under the default branch.
               #   @param query [::String]
               #     Raw search query.
+              #   @param page_categories [::Array<::String>]
+              #     Optional. The categories associated with a category page. Must be set for
+              #     category navigation queries to achieve good search quality. The format
+              #     should be the same as
+              #     {::Google::Cloud::DiscoveryEngine::V1::PageInfo#page_category PageInfo.page_category}.
+              #     This field is the equivalent of the query for browse (navigation) queries.
+              #     It's used by the browse model when the query is empty.
+              #
+              #     If the field is empty, it will not be used by the browse model.
+              #     If the field contains more than one element, only the first element will
+              #     be used.
+              #
+              #     To represent full path of a category, use '>' character to separate
+              #     different hierarchies. If '>' is part of the category name, replace it with
+              #     other character(s).
+              #     For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
+              #     4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
+              #     > Founders Edition`
               #   @param image_query [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ImageQuery, ::Hash]
               #     Raw image query.
               #   @param page_size [::Integer]
@@ -260,6 +278,8 @@ module Google
               #     unset.
               #
               #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+              #
+              #     A large offset may be capped to a reasonable threshold.
               #   @param one_box_page_size [::Integer]
               #     The maximum number of results to return for OneBox.
               #     This applies to each OneBox type individually.
@@ -357,10 +377,10 @@ module Google
               #     The spell correction specification that specifies the mode under
               #     which spell correction takes effect.
               #   @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`.
               #
@@ -373,72 +393,9 @@ module Google
               #     characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
               #   @param content_search_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec, ::Hash]
               #     A specification for configuring the behavior of content search.
-              #   @param safe_search [::Boolean]
-              #     Whether to turn on safe search. This is only supported for
-              #     website search.
-              #   @param user_labels [::Hash{::String => ::String}]
-              #     The user labels applied to a resource must meet the following requirements:
-              #
-              #     * Each resource can have multiple labels, up to a maximum of 64.
-              #     * Each label must be a key-value pair.
-              #     * Keys have a minimum length of 1 character and a maximum length of 63
-              #       characters and cannot be empty. Values can be empty and have a maximum
-              #       length of 63 characters.
-              #     * Keys and values can contain only lowercase letters, numeric characters,
-              #       underscores, and dashes. All characters must use UTF-8 encoding, and
-              #       international characters are allowed.
-              #     * The key portion of a label must be unique. However, you can use the same
-              #       key with multiple resources.
-              #     * Keys must start with a lowercase letter or international character.
-              #
-              #     See [Google Cloud
-              #     Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
-              #     for more details.
-              #   @param search_as_you_type_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAsYouTypeSpec, ::Hash]
-              #     Search as you type configuration. Only supported for the
-              #     {::Google::Cloud::DiscoveryEngine::V1::IndustryVertical::MEDIA IndustryVertical.MEDIA}
-              #     vertical.
-              #   @param display_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DisplaySpec, ::Hash]
-              #     Optional. Config for display feature, like match highlighting on search
-              #     results.
-              #   @param session [::String]
-              #     The session resource name. Optional.
-              #
-              #     Session allows users to do multi-turn /search API calls or coordination
-              #     between /search API calls and /answer API calls.
-              #
-              #     Example #1 (multi-turn /search API calls):
-              #       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):
-              #       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
-              #     GA. Or ask for allowlisting through Google Support team.
-              #   @param session_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SessionSpec, ::Hash]
-              #     Session specification.
-              #
-              #     Can be used only when `session` is set.
-              #   @param relevance_threshold [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceThreshold]
-              #     The relevance threshold of the search results.
-              #
-              #     Default to Google defined threshold, leveraging a balance of
-              #     precision and recall to deliver both highly accurate results and
-              #     comprehensive coverage of relevant information.
-              #
-              #     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
+              #     Optional. 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
@@ -528,7 +485,90 @@ module Google
               #       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.
+              #     Optional. The backend to use for the ranking expression evaluation.
+              #   @param safe_search [::Boolean]
+              #     Whether to turn on safe search. This is only supported for
+              #     website search.
+              #   @param user_labels [::Hash{::String => ::String}]
+              #     The user labels applied to a resource must meet the following requirements:
+              #
+              #     * Each resource can have multiple labels, up to a maximum of 64.
+              #     * Each label must be a key-value pair.
+              #     * Keys have a minimum length of 1 character and a maximum length of 63
+              #       characters and cannot be empty. Values can be empty and have a maximum
+              #       length of 63 characters.
+              #     * Keys and values can contain only lowercase letters, numeric characters,
+              #       underscores, and dashes. All characters must use UTF-8 encoding, and
+              #       international characters are allowed.
+              #     * The key portion of a label must be unique. However, you can use the same
+              #       key with multiple resources.
+              #     * Keys must start with a lowercase letter or international character.
+              #
+              #     See [Google Cloud
+              #     Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+              #     for more details.
+              #   @param natural_language_query_understanding_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::NaturalLanguageQueryUnderstandingSpec, ::Hash]
+              #     Optional. Config for natural language query understanding capabilities,
+              #     such as extracting structured field filters from the query. Refer to [this
+              #     documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
+              #     for more information.
+              #     If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
+              #     natural language query understanding will be done.
+              #   @param search_as_you_type_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAsYouTypeSpec, ::Hash]
+              #     Search as you type configuration. Only supported for the
+              #     {::Google::Cloud::DiscoveryEngine::V1::IndustryVertical::MEDIA IndustryVertical.MEDIA}
+              #     vertical.
+              #   @param display_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DisplaySpec, ::Hash]
+              #     Optional. Config for display feature, like match highlighting on search
+              #     results.
+              #   @param crowding_specs [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::CrowdingSpec, ::Hash>]
+              #     Optional. Crowding specifications for improving result diversity.
+              #     If multiple CrowdingSpecs are specified, crowding will be evaluated on
+              #     each unique combination of the `field` values, and max_count will be the
+              #     maximum value of `max_count` across all CrowdingSpecs.
+              #     For example, if the first CrowdingSpec has `field` = "color" and
+              #     `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
+              #     `max_count` = 2, then after 3 documents that share the same color AND size
+              #     have been returned, subsequent ones should be
+              #     removed or demoted.
+              #   @param session [::String]
+              #     The session resource name. Optional.
+              #
+              #     Session allows users to do multi-turn /search API calls or coordination
+              #     between /search API calls and /answer API calls.
+              #
+              #     Example #1 (multi-turn /search API calls):
+              #       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):
+              #       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
+              #     GA. Or ask for allowlisting through Google Support team.
+              #   @param session_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SessionSpec, ::Hash]
+              #     Session specification.
+              #
+              #     Can be used only when `session` is set.
+              #   @param relevance_threshold [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceThreshold]
+              #     The global relevance threshold of the search results.
+              #
+              #     Defaults to Google defined threshold, leveraging a balance of
+              #     precision and recall to deliver both highly accurate results and
+              #     comprehensive coverage of relevant information.
+              #
+              #     If more granular relevance filtering is required, use the
+              #     `relevance_filter_spec` instead.
+              #
+              #     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.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult>]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -618,7 +658,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, ranking_expression: nil, ranking_expression_backend: nil)
+              # @overload search_lite(serving_config: nil, branch: nil, query: nil, page_categories: 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, ranking_expression: nil, ranking_expression_backend: nil, safe_search: nil, user_labels: nil, natural_language_query_understanding_spec: nil, search_as_you_type_spec: nil, display_spec: nil, crowding_specs: nil, session: nil, session_spec: nil, relevance_threshold: nil, relevance_score_spec: 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).
@@ -638,6 +678,24 @@ module Google
               #     documents under the default branch.
               #   @param query [::String]
               #     Raw search query.
+              #   @param page_categories [::Array<::String>]
+              #     Optional. The categories associated with a category page. Must be set for
+              #     category navigation queries to achieve good search quality. The format
+              #     should be the same as
+              #     {::Google::Cloud::DiscoveryEngine::V1::PageInfo#page_category PageInfo.page_category}.
+              #     This field is the equivalent of the query for browse (navigation) queries.
+              #     It's used by the browse model when the query is empty.
+              #
+              #     If the field is empty, it will not be used by the browse model.
+              #     If the field contains more than one element, only the first element will
+              #     be used.
+              #
+              #     To represent full path of a category, use '>' character to separate
+              #     different hierarchies. If '>' is part of the category name, replace it with
+              #     other character(s).
+              #     For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
+              #     4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
+              #     > Founders Edition`
               #   @param image_query [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ImageQuery, ::Hash]
               #     Raw image query.
               #   @param page_size [::Integer]
@@ -668,6 +726,8 @@ module Google
               #     unset.
               #
               #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+              #
+              #     A large offset may be capped to a reasonable threshold.
               #   @param one_box_page_size [::Integer]
               #     The maximum number of results to return for OneBox.
               #     This applies to each OneBox type individually.
@@ -765,10 +825,10 @@ module Google
               #     The spell correction specification that specifies the mode under
               #     which spell correction takes effect.
               #   @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`.
               #
@@ -781,72 +841,9 @@ module Google
               #     characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
               #   @param content_search_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec, ::Hash]
               #     A specification for configuring the behavior of content search.
-              #   @param safe_search [::Boolean]
-              #     Whether to turn on safe search. This is only supported for
-              #     website search.
-              #   @param user_labels [::Hash{::String => ::String}]
-              #     The user labels applied to a resource must meet the following requirements:
-              #
-              #     * Each resource can have multiple labels, up to a maximum of 64.
-              #     * Each label must be a key-value pair.
-              #     * Keys have a minimum length of 1 character and a maximum length of 63
-              #       characters and cannot be empty. Values can be empty and have a maximum
-              #       length of 63 characters.
-              #     * Keys and values can contain only lowercase letters, numeric characters,
-              #       underscores, and dashes. All characters must use UTF-8 encoding, and
-              #       international characters are allowed.
-              #     * The key portion of a label must be unique. However, you can use the same
-              #       key with multiple resources.
-              #     * Keys must start with a lowercase letter or international character.
-              #
-              #     See [Google Cloud
-              #     Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
-              #     for more details.
-              #   @param search_as_you_type_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAsYouTypeSpec, ::Hash]
-              #     Search as you type configuration. Only supported for the
-              #     {::Google::Cloud::DiscoveryEngine::V1::IndustryVertical::MEDIA IndustryVertical.MEDIA}
-              #     vertical.
-              #   @param display_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DisplaySpec, ::Hash]
-              #     Optional. Config for display feature, like match highlighting on search
-              #     results.
-              #   @param session [::String]
-              #     The session resource name. Optional.
-              #
-              #     Session allows users to do multi-turn /search API calls or coordination
-              #     between /search API calls and /answer API calls.
-              #
-              #     Example #1 (multi-turn /search API calls):
-              #       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):
-              #       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
-              #     GA. Or ask for allowlisting through Google Support team.
-              #   @param session_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SessionSpec, ::Hash]
-              #     Session specification.
-              #
-              #     Can be used only when `session` is set.
-              #   @param relevance_threshold [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceThreshold]
-              #     The relevance threshold of the search results.
-              #
-              #     Default to Google defined threshold, leveraging a balance of
-              #     precision and recall to deliver both highly accurate results and
-              #     comprehensive coverage of relevant information.
-              #
-              #     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
+              #     Optional. 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
@@ -936,7 +933,90 @@ module Google
               #       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.
+              #     Optional. The backend to use for the ranking expression evaluation.
+              #   @param safe_search [::Boolean]
+              #     Whether to turn on safe search. This is only supported for
+              #     website search.
+              #   @param user_labels [::Hash{::String => ::String}]
+              #     The user labels applied to a resource must meet the following requirements:
+              #
+              #     * Each resource can have multiple labels, up to a maximum of 64.
+              #     * Each label must be a key-value pair.
+              #     * Keys have a minimum length of 1 character and a maximum length of 63
+              #       characters and cannot be empty. Values can be empty and have a maximum
+              #       length of 63 characters.
+              #     * Keys and values can contain only lowercase letters, numeric characters,
+              #       underscores, and dashes. All characters must use UTF-8 encoding, and
+              #       international characters are allowed.
+              #     * The key portion of a label must be unique. However, you can use the same
+              #       key with multiple resources.
+              #     * Keys must start with a lowercase letter or international character.
+              #
+              #     See [Google Cloud
+              #     Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+              #     for more details.
+              #   @param natural_language_query_understanding_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::NaturalLanguageQueryUnderstandingSpec, ::Hash]
+              #     Optional. Config for natural language query understanding capabilities,
+              #     such as extracting structured field filters from the query. Refer to [this
+              #     documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
+              #     for more information.
+              #     If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
+              #     natural language query understanding will be done.
+              #   @param search_as_you_type_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SearchAsYouTypeSpec, ::Hash]
+              #     Search as you type configuration. Only supported for the
+              #     {::Google::Cloud::DiscoveryEngine::V1::IndustryVertical::MEDIA IndustryVertical.MEDIA}
+              #     vertical.
+              #   @param display_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DisplaySpec, ::Hash]
+              #     Optional. Config for display feature, like match highlighting on search
+              #     results.
+              #   @param crowding_specs [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::CrowdingSpec, ::Hash>]
+              #     Optional. Crowding specifications for improving result diversity.
+              #     If multiple CrowdingSpecs are specified, crowding will be evaluated on
+              #     each unique combination of the `field` values, and max_count will be the
+              #     maximum value of `max_count` across all CrowdingSpecs.
+              #     For example, if the first CrowdingSpec has `field` = "color" and
+              #     `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
+              #     `max_count` = 2, then after 3 documents that share the same color AND size
+              #     have been returned, subsequent ones should be
+              #     removed or demoted.
+              #   @param session [::String]
+              #     The session resource name. Optional.
+              #
+              #     Session allows users to do multi-turn /search API calls or coordination
+              #     between /search API calls and /answer API calls.
+              #
+              #     Example #1 (multi-turn /search API calls):
+              #       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):
+              #       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
+              #     GA. Or ask for allowlisting through Google Support team.
+              #   @param session_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SessionSpec, ::Hash]
+              #     Session specification.
+              #
+              #     Can be used only when `session` is set.
+              #   @param relevance_threshold [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::RelevanceThreshold]
+              #     The global relevance threshold of the search results.
+              #
+              #     Defaults to Google defined threshold, leveraging a balance of
+              #     precision and recall to deliver both highly accurate results and
+              #     comprehensive coverage of relevant information.
+              #
+              #     If more granular relevance filtering is required, use the
+              #     `relevance_filter_spec` instead.
+              #
+              #     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.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult>]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module DiscoveryEngine
       module V1
-        VERSION = "2.6.2"
+        VERSION = "2.7.0"
       end
     end
   end

data/lib/google/cloud/discoveryengine/v1/data_store_pb.rb

@@ -13,7 +13,7 @@ require 'google/cloud/discoveryengine/v1/schema_pb'
 require 'google/protobuf/timestamp_pb'
 
 
-descriptor_data = "\n0google/cloud/discoveryengine/v1/data_store.proto\x12\x1fgoogle.cloud.discoveryengine.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x39google/cloud/discoveryengine/v1/cmek_config_service.proto\x1a,google/cloud/discoveryengine/v1/common.proto\x1a@google/cloud/discoveryengine/v1/document_processing_config.proto\x1a,google/cloud/discoveryengine/v1/schema.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xe7\r\n\tDataStore\x12\x14\n\x04name\x18\x01 \x01(\tB\x06\xe0\x41\x05\xe0\x41\x08\x12\x19\n\x0c\x64isplay_name\x18\x02 \x01(\tB\x03\xe0\x41\x02\x12Q\n\x11industry_vertical\x18\x03 \x01(\x0e\x32\x31.google.cloud.discoveryengine.v1.IndustryVerticalB\x03\xe0\x41\x05\x12\x45\n\x0esolution_types\x18\x05 \x03(\x0e\x32-.google.cloud.discoveryengine.v1.SolutionType\x12\x1e\n\x11\x64\x65\x66\x61ult_schema_id\x18\x07 \x01(\tB\x03\xe0\x41\x03\x12U\n\x0e\x63ontent_config\x18\x06 \x01(\x0e\x32\x38.google.cloud.discoveryengine.v1.DataStore.ContentConfigB\x03\xe0\x41\x05\x12\x34\n\x0b\x63reate_time\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x63\n\x1b\x61\x64vanced_site_search_config\x18\x0c \x01(\x0b\x32\x39.google.cloud.discoveryengine.v1.AdvancedSiteSearchConfigB\x03\xe0\x41\x01\x12\x19\n\x0ckms_key_name\x18  \x01(\tB\x03\xe0\x41\x04\x12\x45\n\x0b\x63mek_config\x18\x12 \x01(\x0b\x32+.google.cloud.discoveryengine.v1.CmekConfigB\x03\xe0\x41\x03\x12]\n\x12\x62illing_estimation\x18\x17 \x01(\x0b\x32<.google.cloud.discoveryengine.v1.DataStore.BillingEstimationB\x03\xe0\x41\x03\x12\x18\n\x0b\x61\x63l_enabled\x18\x18 \x01(\x08\x42\x03\xe0\x41\x05\x12J\n\x10workspace_config\x18\x19 \x01(\x0b\x32\x30.google.cloud.discoveryengine.v1.WorkspaceConfig\x12]\n\x1a\x64ocument_processing_config\x18\x1b \x01(\x0b\x32\x39.google.cloud.discoveryengine.v1.DocumentProcessingConfig\x12@\n\x0fstarting_schema\x18\x1c \x01(\x0b\x32\'.google.cloud.discoveryengine.v1.Schema\x12Z\n\x16healthcare_fhir_config\x18\x1d \x01(\x0b\x32\x35.google.cloud.discoveryengine.v1.HealthcareFhirConfigB\x03\xe0\x41\x01\x12[\n\x16identity_mapping_store\x18\x1f \x01(\tB;\xe0\x41\x05\xfa\x41\x35\n3discoveryengine.googleapis.com/IdentityMappingStore\x1a\xae\x02\n\x11\x42illingEstimation\x12\x1c\n\x14structured_data_size\x18\x01 \x01(\x03\x12\x1e\n\x16unstructured_data_size\x18\x02 \x01(\x03\x12\x19\n\x11website_data_size\x18\x03 \x01(\x03\x12?\n\x1bstructured_data_update_time\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x41\n\x1dunstructured_data_update_time\x18\x05 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12<\n\x18website_data_update_time\x18\x06 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\"\x7f\n\rContentConfig\x12\x1e\n\x1a\x43ONTENT_CONFIG_UNSPECIFIED\x10\x00\x12\x0e\n\nNO_CONTENT\x10\x01\x12\x14\n\x10\x43ONTENT_REQUIRED\x10\x02\x12\x12\n\x0ePUBLIC_WEBSITE\x10\x03\x12\x14\n\x10GOOGLE_WORKSPACE\x10\x04:\xc9\x01\xea\x41\xc5\x01\n(discoveryengine.googleapis.com/DataStore\x12?projects/{project}/locations/{location}/dataStores/{data_store}\x12Xprojects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}\"\x9e\x01\n\x18\x41\x64vancedSiteSearchConfig\x12\"\n\x15\x64isable_initial_index\x18\x03 \x01(\x08H\x00\x88\x01\x01\x12&\n\x19\x64isable_automatic_refresh\x18\x04 \x01(\x08H\x01\x88\x01\x01\x42\x18\n\x16_disable_initial_indexB\x1c\n\x1a_disable_automatic_refresh\"\xf5\x02\n\x0fWorkspaceConfig\x12\x43\n\x04type\x18\x01 \x01(\x0e\x32\x35.google.cloud.discoveryengine.v1.WorkspaceConfig.Type\x12\x1a\n\x12\x64\x61sher_customer_id\x18\x02 \x01(\t\x12(\n\x1bsuper_admin_service_account\x18\x04 \x01(\tB\x03\xe0\x41\x01\x12&\n\x19super_admin_email_address\x18\x05 \x01(\tB\x03\xe0\x41\x01\"\xae\x01\n\x04Type\x12\x14\n\x10TYPE_UNSPECIFIED\x10\x00\x12\x10\n\x0cGOOGLE_DRIVE\x10\x01\x12\x0f\n\x0bGOOGLE_MAIL\x10\x02\x12\x10\n\x0cGOOGLE_SITES\x10\x03\x12\x13\n\x0fGOOGLE_CALENDAR\x10\x04\x12\x0f\n\x0bGOOGLE_CHAT\x10\x05\x12\x11\n\rGOOGLE_GROUPS\x10\x06\x12\x0f\n\x0bGOOGLE_KEEP\x10\x07\x12\x11\n\rGOOGLE_PEOPLE\x10\x08\x42\x81\x02\n#com.google.cloud.discoveryengine.v1B\x0e\x44\x61taStoreProtoP\x01ZMcloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb\xa2\x02\x0f\x44ISCOVERYENGINE\xaa\x02\x1fGoogle.Cloud.DiscoveryEngine.V1\xca\x02\x1fGoogle\\Cloud\\DiscoveryEngine\\V1\xea\x02\"Google::Cloud::DiscoveryEngine::V1b\x06proto3"
+descriptor_data = "\n0google/cloud/discoveryengine/v1/data_store.proto\x12\x1fgoogle.cloud.discoveryengine.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x39google/cloud/discoveryengine/v1/cmek_config_service.proto\x1a,google/cloud/discoveryengine/v1/common.proto\x1a@google/cloud/discoveryengine/v1/document_processing_config.proto\x1a,google/cloud/discoveryengine/v1/schema.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xec\x0e\n\tDataStore\x12\x14\n\x04name\x18\x01 \x01(\tB\x06\xe0\x41\x05\xe0\x41\x08\x12\x19\n\x0c\x64isplay_name\x18\x02 \x01(\tB\x03\xe0\x41\x02\x12Q\n\x11industry_vertical\x18\x03 \x01(\x0e\x32\x31.google.cloud.discoveryengine.v1.IndustryVerticalB\x03\xe0\x41\x05\x12\x45\n\x0esolution_types\x18\x05 \x03(\x0e\x32-.google.cloud.discoveryengine.v1.SolutionType\x12\x1e\n\x11\x64\x65\x66\x61ult_schema_id\x18\x07 \x01(\tB\x03\xe0\x41\x03\x12U\n\x0e\x63ontent_config\x18\x06 \x01(\x0e\x32\x38.google.cloud.discoveryengine.v1.DataStore.ContentConfigB\x03\xe0\x41\x05\x12\x34\n\x0b\x63reate_time\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x63\n\x1b\x61\x64vanced_site_search_config\x18\x0c \x01(\x0b\x32\x39.google.cloud.discoveryengine.v1.AdvancedSiteSearchConfigB\x03\xe0\x41\x01\x12\x82\x01\n+natural_language_query_understanding_config\x18\" \x01(\x0b\x32H.google.cloud.discoveryengine.v1.NaturalLanguageQueryUnderstandingConfigB\x03\xe0\x41\x01\x12\x19\n\x0ckms_key_name\x18  \x01(\tB\x03\xe0\x41\x04\x12\x45\n\x0b\x63mek_config\x18\x12 \x01(\x0b\x32+.google.cloud.discoveryengine.v1.CmekConfigB\x03\xe0\x41\x03\x12]\n\x12\x62illing_estimation\x18\x17 \x01(\x0b\x32<.google.cloud.discoveryengine.v1.DataStore.BillingEstimationB\x03\xe0\x41\x03\x12\x18\n\x0b\x61\x63l_enabled\x18\x18 \x01(\x08\x42\x03\xe0\x41\x05\x12J\n\x10workspace_config\x18\x19 \x01(\x0b\x32\x30.google.cloud.discoveryengine.v1.WorkspaceConfig\x12]\n\x1a\x64ocument_processing_config\x18\x1b \x01(\x0b\x32\x39.google.cloud.discoveryengine.v1.DocumentProcessingConfig\x12@\n\x0fstarting_schema\x18\x1c \x01(\x0b\x32\'.google.cloud.discoveryengine.v1.Schema\x12Z\n\x16healthcare_fhir_config\x18\x1d \x01(\x0b\x32\x35.google.cloud.discoveryengine.v1.HealthcareFhirConfigB\x03\xe0\x41\x01\x12[\n\x16identity_mapping_store\x18\x1f \x01(\tB;\xe0\x41\x05\xfa\x41\x35\n3discoveryengine.googleapis.com/IdentityMappingStore\x1a\xae\x02\n\x11\x42illingEstimation\x12\x1c\n\x14structured_data_size\x18\x01 \x01(\x03\x12\x1e\n\x16unstructured_data_size\x18\x02 \x01(\x03\x12\x19\n\x11website_data_size\x18\x03 \x01(\x03\x12?\n\x1bstructured_data_update_time\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x41\n\x1dunstructured_data_update_time\x18\x05 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12<\n\x18website_data_update_time\x18\x06 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\"\x7f\n\rContentConfig\x12\x1e\n\x1a\x43ONTENT_CONFIG_UNSPECIFIED\x10\x00\x12\x0e\n\nNO_CONTENT\x10\x01\x12\x14\n\x10\x43ONTENT_REQUIRED\x10\x02\x12\x12\n\x0ePUBLIC_WEBSITE\x10\x03\x12\x14\n\x10GOOGLE_WORKSPACE\x10\x04:\xc9\x01\xea\x41\xc5\x01\n(discoveryengine.googleapis.com/DataStore\x12?projects/{project}/locations/{location}/dataStores/{data_store}\x12Xprojects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}\"\x9e\x01\n\x18\x41\x64vancedSiteSearchConfig\x12\"\n\x15\x64isable_initial_index\x18\x03 \x01(\x08H\x00\x88\x01\x01\x12&\n\x19\x64isable_automatic_refresh\x18\x04 \x01(\x08H\x01\x88\x01\x01\x42\x18\n\x16_disable_initial_indexB\x1c\n\x1a_disable_automatic_refresh\"\xbf\x01\n\'NaturalLanguageQueryUnderstandingConfig\x12[\n\x04mode\x18\x01 \x01(\x0e\x32M.google.cloud.discoveryengine.v1.NaturalLanguageQueryUnderstandingConfig.Mode\"7\n\x04Mode\x12\x14\n\x10MODE_UNSPECIFIED\x10\x00\x12\x0c\n\x08\x44ISABLED\x10\x01\x12\x0b\n\x07\x45NABLED\x10\x02\"\xf5\x02\n\x0fWorkspaceConfig\x12\x43\n\x04type\x18\x01 \x01(\x0e\x32\x35.google.cloud.discoveryengine.v1.WorkspaceConfig.Type\x12\x1a\n\x12\x64\x61sher_customer_id\x18\x02 \x01(\t\x12(\n\x1bsuper_admin_service_account\x18\x04 \x01(\tB\x03\xe0\x41\x01\x12&\n\x19super_admin_email_address\x18\x05 \x01(\tB\x03\xe0\x41\x01\"\xae\x01\n\x04Type\x12\x14\n\x10TYPE_UNSPECIFIED\x10\x00\x12\x10\n\x0cGOOGLE_DRIVE\x10\x01\x12\x0f\n\x0bGOOGLE_MAIL\x10\x02\x12\x10\n\x0cGOOGLE_SITES\x10\x03\x12\x13\n\x0fGOOGLE_CALENDAR\x10\x04\x12\x0f\n\x0bGOOGLE_CHAT\x10\x05\x12\x11\n\rGOOGLE_GROUPS\x10\x06\x12\x0f\n\x0bGOOGLE_KEEP\x10\x07\x12\x11\n\rGOOGLE_PEOPLE\x10\x08\x42\x81\x02\n#com.google.cloud.discoveryengine.v1B\x0e\x44\x61taStoreProtoP\x01ZMcloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb\xa2\x02\x0f\x44ISCOVERYENGINE\xaa\x02\x1fGoogle.Cloud.DiscoveryEngine.V1\xca\x02\x1fGoogle\\Cloud\\DiscoveryEngine\\V1\xea\x02\"Google::Cloud::DiscoveryEngine::V1b\x06proto3"
 
 pool = Google::Protobuf::DescriptorPool.generated_pool
 
@@ -52,6 +52,8 @@ module Google
         DataStore::BillingEstimation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.DataStore.BillingEstimation").msgclass
         DataStore::ContentConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.DataStore.ContentConfig").enummodule
         AdvancedSiteSearchConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.AdvancedSiteSearchConfig").msgclass
+        NaturalLanguageQueryUnderstandingConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.NaturalLanguageQueryUnderstandingConfig").msgclass
+        NaturalLanguageQueryUnderstandingConfig::Mode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.NaturalLanguageQueryUnderstandingConfig.Mode").enummodule
         WorkspaceConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.WorkspaceConfig").msgclass
         WorkspaceConfig::Type = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.discoveryengine.v1.WorkspaceConfig.Type").enummodule
       end