Class: Google::Cloud::DiscoveryEngine::V1beta::SearchRequest

Inherits:

Object

• Object
• Google::Cloud::DiscoveryEngine::V1beta::SearchRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb

Overview

Request message for SearchService.Search method.

Defined Under Namespace

Classes: BoostSpec, ContentSearchSpec, FacetSpec, ParamsEntry, QueryExpansionSpec, SpellCorrectionSpec, UserLabelsEntry

Instance Attribute Summary

• #boost_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec

  Boost specification to boost certain documents.

• #branch ⇒ ::String

  The branch resource name, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0.

• #content_search_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec

  The content search spec that configs the desired behavior of content search.

• #facet_specs ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec>

  Facet specifications for faceted search.

• #filter ⇒ ::String

  The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.

• #offset ⇒ ::Integer

  A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results.

• #order_by ⇒ ::String

  The order in which documents are returned.

• #page_size ⇒ ::Integer

  Maximum number of Documents to return.

• #page_token ⇒ ::String

  A page token received from a previous SearchService.Search call.

• #params ⇒ ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}

  Additional search parameters.

• #query ⇒ ::String

  Raw search query.

• #query_expansion_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec

  The query expansion specification that specifies the conditions under which query expansion will occur.

• #safe_search ⇒ ::Boolean

  Whether to turn on safe search.

• #serving_config ⇒ ::String

  Required.

• #spell_correction_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec

  The spell correction specification that specifies the mode under which spell correction will take effect.

• #user_info ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::UserInfo

  Information about the end user.

• #user_labels ⇒ ::Google::Protobuf::Map{::String => ::String}

  The user labels applied to a resource must meet the following requirements:.

• #user_pseudo_id ⇒ ::String

  A unique identifier for tracking visitors.

Instance Attribute Details

#boost_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec

Returns Boost specification to boost certain documents.

Returns:

• (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec) —

  Boost specification to boost certain documents.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 161

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A facet specification to perform faceted search.
  # @!attribute [rw] facet_key
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey]
  #     Required. The facet key specification.
  # @!attribute [rw] limit
  #   @return [::Integer]
  #     Maximum of facet values that should be returned for this facet. If
  #     unspecified, defaults to 20. The maximum allowed value is 300. Values
  #     above 300 will be coerced to 300.
  #
  #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
  # @!attribute [rw] excluded_filter_keys
  #   @return [::Array<::String>]
  #     List of keys to exclude when faceting.
  #
  #
  #     By default,
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     is not excluded from the filter unless it is listed in this field.
  #
  #     Listing a facet key in this field allows its values to appear as facet
  #     results, even when they are filtered out of search results. Using this
  #     field does not affect what search results are returned.
  #
  #     For example, suppose there are 100 documents with the color facet "Red"
  #     and 200 documents with the color facet "Blue". A query containing the
  #     filter "color:ANY("Red")" and having "color" as
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     would by default return only "Red" documents in the search results, and
  #     also return "Red" with count 100 as the only color facet. Although there
  #     are also blue documents available, "Blue" would not be shown as an
  #     available facet value.
  #
  #     If "color" is listed in "excludedFilterKeys", then the query returns the
  #     facet values "Red" with count 100 and "Blue" with count 200, because the
  #     "color" key is now excluded from the filter. Because this field doesn't
  #     affect search results, the search results are still correctly filtered to
  #     return only "Red" documents.
  #
  #     A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
  #     error is returned.
  # @!attribute [rw] enable_dynamic_position
  #   @return [::Boolean]
  #     Enables dynamic position for this facet. If set to true, the position of
  #     this facet among all facets in the response is determined automatically.
  #     It will be ordered together with dynamic facets if dynamic
  #     facets is enabled. If set to false, the position of this facet in the
  #     response will be the same as in the request, and it will be ranked before
  #     the facets with dynamic position enable and all dynamic facets.
  #
  #     For example, you may always want to have rating facet returned in
  #     the response, but it's not necessarily to always display the rating facet
  #     at the top. In that case, you can set enable_dynamic_position to true so
  #     that the position of rating facet in response will be determined
  #     automatically.
  #
  #     Another example, assuming you have the following facets in the request:
  #
  #     * "rating", enable_dynamic_position = true
  #
  #     * "price", enable_dynamic_position = false
  #
  #     * "brands", enable_dynamic_position = false
  #
  #     And also you have a dynamic facets enable, which will generate a facet
  #     'gender'. Then the final order of the facets in the response can be
  #     ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
  #     "rating") depends on how API orders "gender" and "rating" facets.
  #     However, notice that "price" and "brands" will always be
  #     ranked at 1st and 2nd position since their enable_dynamic_position are
  #     false.
  class FacetSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how a facet is computed.
    # @!attribute [rw] key
    #   @return [::String]
    #     Required. Supported textual and numerical facet keys in
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} object, over
    #     which the facet values are computed. Facet key is case-sensitive.
    # @!attribute [rw] intervals
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Interval>]
    #     Set only if values should be bucketized into intervals. Must be set
    #     for facets with numerical values. Must not be set for facet with text
    #     values. Maximum number of intervals is 30.
    # @!attribute [rw] restricted_values
    #   @return [::Array<::String>]
    #     Only get facet for the given restricted values. Only supported on
    #     textual fields. For example, suppose "category" has three values
    #     "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
    #     "restricted_values" to "Action > 2022", the "category" facet will only
    #     contain "Action > 2022". Only supported on textual fields. Maximum
    #     is 10.
    # @!attribute [rw] prefixes
    #   @return [::Array<::String>]
    #     Only get facet values that start with the given string prefix. For
    #     example, suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
    #     "category" facet will only contain "Action > 2022" and "Action > 2021".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] contains
    #   @return [::Array<::String>]
    #     Only get facet values that contains the given strings. For example,
    #     suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
    #     "category" facet will only contain "Action > 2022" and "Sci-Fi > 2022".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] case_insensitive
    #   @return [::Boolean]
    #     True to make facet keys case insensitive when getting faceting
    #     values with prefixes or contains; false otherwise.
    # @!attribute [rw] order_by
    #   @return [::String]
    #     The order in which documents are returned.
    #
    #     Allowed values are:
    #
    #     * "count desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
    #     descending.
    #
    #     * "value desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
    #     descending.
    #       Only applies to textual facets.
    #
    #     If not set, textual values are sorted in [natural
    #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
    #     intervals are sorted in the order given by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
    class FacetKey
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Boost specification to boost certain documents.
  # @!attribute [rw] condition_boost_specs
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec>]
  #     Condition boost specifications. If a document matches multiple conditions
  #     in the specifictions, boost scores from these specifications are all
  #     applied and combined in a non-linear way. Maximum number of
  #     specifications is 20.
  class BoostSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost applies to documents which match a condition.
    # @!attribute [rw] condition
    #   @return [::String]
    #     An expression which specifies a boost condition. The syntax and
    #     supported fields are the same as a filter expression. See
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#filter SearchRequest.filter}
    #     for detail syntax and limitations.
    #
    #     Examples:
    #
    #     * To boost documents with document ID "doc_1" or "doc_2", and
    #     color
    #       "Red" or "Blue":
    #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
    # @!attribute [rw] boost
    #   @return [::Float]
    #     Strength of the condition boost, which should be in [-1, 1]. Negative
    #     boost means demotion. Default is 0.0.
    #
    #     Setting to 1.0 gives the document a big promotion. However, it does not
    #     necessarily mean that the boosted document will be the top result at
    #     all times, nor that other documents will be excluded. Results could
    #     still be shown even when none of them matches the condition. And
    #     results that are significantly more relevant to the search query can
    #     still trump your heavily favored but irrelevant documents.
    #
    #     Setting to -1.0 gives the document a big demotion. However, results
    #     that are deeply relevant might still be shown. The document will have
    #     an upstream battle to get a fairly high ranking, but it is not blocked
    #     out completely.
    #
    #     Setting to 0.0 means no boost applied. The boosting condition is
    #     ignored.
    class ConditionBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specification to determine under which conditions query expansion should
  # occur.
  # @!attribute [rw] condition
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition]
  #     The condition under which query expansion should occur. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
  class QueryExpansionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which condition query expansion should occur.
    module Condition
      # Unspecified query expansion condition. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
      CONDITION_UNSPECIFIED = 0

      # Disabled query expansion. Only the exact search query is used, even if
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#total_size SearchResponse.total_size}
      # is zero.
      DISABLED = 1

      # Automatic query expansion built by the Search API.
      AUTO = 2
    end
  end

  # The specification for query spell correction.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode]
  #     The mode under which spell correction should take effect to
  #     replace the original search query. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
  class SpellCorrectionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which mode spell correction should occur.
    module Mode
      # Unspecified spell correction mode. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
      MODE_UNSPECIFIED = 0

      # Search API will try to find a spell suggestion if there
      # is any and put in the
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#corrected_query SearchResponse.corrected_query}.
      # The spell suggestion will not be used as the search query.
      SUGGESTION_ONLY = 1

      # Automatic spell correction built by the Search API. Search will
      # be based on the corrected query if found.
      AUTO = 2
    end
  end

  # The specification that configs the desired behavior of the UCS content
  # search.
  # @!attribute [rw] snippet_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec]
  #     If there is no snippet spec provided, there will be no snippet in the
  #     search result.
  # @!attribute [rw] summary_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec]
  #     If there is no summary spec provided, there will be no summary in the
  #     search response.
  class ContentSearchSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The specification that configs the snippet in the search results.
    # @!attribute [rw] max_snippet_count
    #   @return [::Integer]
    #     Max number of snippets returned in each search result.
    #     If the matching snippets is less than the max_snippet_count, return all
    #     of the snippets; otherwise, return the max_snippet_count.
    #
    #     At most 5 snippets will be returned for each SearchResult.
    # @!attribute [rw] reference_only
    #   @return [::Boolean]
    #     if true, only snippet reference is returned.
    class SnippetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The specification that configs the summary in the search response.
    # @!attribute [rw] summary_result_count
    #   @return [::Integer]
    #     The number of top results the summary should be generated from.
    #     If the number of returned results is less than summary_result_count,
    #     then the summary would be derived from all the results; otherwise, the
    #     summary would be derived from the top results.
    #
    #     At most 5 results can be used for generating summary.
    class SummarySpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Protobuf::Value]
  class ParamsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#branch ⇒ ::String

Returns The branch resource name, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0.

Use default_branch as the branch ID or leave this field empty, to search documents under the default branch.

Returns:

• (::String) —

  The branch resource name, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0.

  Use default_branch as the branch ID or leave this field empty, to search documents under the default branch.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 161

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A facet specification to perform faceted search.
  # @!attribute [rw] facet_key
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey]
  #     Required. The facet key specification.
  # @!attribute [rw] limit
  #   @return [::Integer]
  #     Maximum of facet values that should be returned for this facet. If
  #     unspecified, defaults to 20. The maximum allowed value is 300. Values
  #     above 300 will be coerced to 300.
  #
  #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
  # @!attribute [rw] excluded_filter_keys
  #   @return [::Array<::String>]
  #     List of keys to exclude when faceting.
  #
  #
  #     By default,
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     is not excluded from the filter unless it is listed in this field.
  #
  #     Listing a facet key in this field allows its values to appear as facet
  #     results, even when they are filtered out of search results. Using this
  #     field does not affect what search results are returned.
  #
  #     For example, suppose there are 100 documents with the color facet "Red"
  #     and 200 documents with the color facet "Blue". A query containing the
  #     filter "color:ANY("Red")" and having "color" as
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     would by default return only "Red" documents in the search results, and
  #     also return "Red" with count 100 as the only color facet. Although there
  #     are also blue documents available, "Blue" would not be shown as an
  #     available facet value.
  #
  #     If "color" is listed in "excludedFilterKeys", then the query returns the
  #     facet values "Red" with count 100 and "Blue" with count 200, because the
  #     "color" key is now excluded from the filter. Because this field doesn't
  #     affect search results, the search results are still correctly filtered to
  #     return only "Red" documents.
  #
  #     A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
  #     error is returned.
  # @!attribute [rw] enable_dynamic_position
  #   @return [::Boolean]
  #     Enables dynamic position for this facet. If set to true, the position of
  #     this facet among all facets in the response is determined automatically.
  #     It will be ordered together with dynamic facets if dynamic
  #     facets is enabled. If set to false, the position of this facet in the
  #     response will be the same as in the request, and it will be ranked before
  #     the facets with dynamic position enable and all dynamic facets.
  #
  #     For example, you may always want to have rating facet returned in
  #     the response, but it's not necessarily to always display the rating facet
  #     at the top. In that case, you can set enable_dynamic_position to true so
  #     that the position of rating facet in response will be determined
  #     automatically.
  #
  #     Another example, assuming you have the following facets in the request:
  #
  #     * "rating", enable_dynamic_position = true
  #
  #     * "price", enable_dynamic_position = false
  #
  #     * "brands", enable_dynamic_position = false
  #
  #     And also you have a dynamic facets enable, which will generate a facet
  #     'gender'. Then the final order of the facets in the response can be
  #     ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
  #     "rating") depends on how API orders "gender" and "rating" facets.
  #     However, notice that "price" and "brands" will always be
  #     ranked at 1st and 2nd position since their enable_dynamic_position are
  #     false.
  class FacetSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how a facet is computed.
    # @!attribute [rw] key
    #   @return [::String]
    #     Required. Supported textual and numerical facet keys in
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} object, over
    #     which the facet values are computed. Facet key is case-sensitive.
    # @!attribute [rw] intervals
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Interval>]
    #     Set only if values should be bucketized into intervals. Must be set
    #     for facets with numerical values. Must not be set for facet with text
    #     values. Maximum number of intervals is 30.
    # @!attribute [rw] restricted_values
    #   @return [::Array<::String>]
    #     Only get facet for the given restricted values. Only supported on
    #     textual fields. For example, suppose "category" has three values
    #     "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
    #     "restricted_values" to "Action > 2022", the "category" facet will only
    #     contain "Action > 2022". Only supported on textual fields. Maximum
    #     is 10.
    # @!attribute [rw] prefixes
    #   @return [::Array<::String>]
    #     Only get facet values that start with the given string prefix. For
    #     example, suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
    #     "category" facet will only contain "Action > 2022" and "Action > 2021".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] contains
    #   @return [::Array<::String>]
    #     Only get facet values that contains the given strings. For example,
    #     suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
    #     "category" facet will only contain "Action > 2022" and "Sci-Fi > 2022".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] case_insensitive
    #   @return [::Boolean]
    #     True to make facet keys case insensitive when getting faceting
    #     values with prefixes or contains; false otherwise.
    # @!attribute [rw] order_by
    #   @return [::String]
    #     The order in which documents are returned.
    #
    #     Allowed values are:
    #
    #     * "count desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
    #     descending.
    #
    #     * "value desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
    #     descending.
    #       Only applies to textual facets.
    #
    #     If not set, textual values are sorted in [natural
    #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
    #     intervals are sorted in the order given by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
    class FacetKey
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Boost specification to boost certain documents.
  # @!attribute [rw] condition_boost_specs
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec>]
  #     Condition boost specifications. If a document matches multiple conditions
  #     in the specifictions, boost scores from these specifications are all
  #     applied and combined in a non-linear way. Maximum number of
  #     specifications is 20.
  class BoostSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost applies to documents which match a condition.
    # @!attribute [rw] condition
    #   @return [::String]
    #     An expression which specifies a boost condition. The syntax and
    #     supported fields are the same as a filter expression. See
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#filter SearchRequest.filter}
    #     for detail syntax and limitations.
    #
    #     Examples:
    #
    #     * To boost documents with document ID "doc_1" or "doc_2", and
    #     color
    #       "Red" or "Blue":
    #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
    # @!attribute [rw] boost
    #   @return [::Float]
    #     Strength of the condition boost, which should be in [-1, 1]. Negative
    #     boost means demotion. Default is 0.0.
    #
    #     Setting to 1.0 gives the document a big promotion. However, it does not
    #     necessarily mean that the boosted document will be the top result at
    #     all times, nor that other documents will be excluded. Results could
    #     still be shown even when none of them matches the condition. And
    #     results that are significantly more relevant to the search query can
    #     still trump your heavily favored but irrelevant documents.
    #
    #     Setting to -1.0 gives the document a big demotion. However, results
    #     that are deeply relevant might still be shown. The document will have
    #     an upstream battle to get a fairly high ranking, but it is not blocked
    #     out completely.
    #
    #     Setting to 0.0 means no boost applied. The boosting condition is
    #     ignored.
    class ConditionBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specification to determine under which conditions query expansion should
  # occur.
  # @!attribute [rw] condition
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition]
  #     The condition under which query expansion should occur. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
  class QueryExpansionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which condition query expansion should occur.
    module Condition
      # Unspecified query expansion condition. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
      CONDITION_UNSPECIFIED = 0

      # Disabled query expansion. Only the exact search query is used, even if
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#total_size SearchResponse.total_size}
      # is zero.
      DISABLED = 1

      # Automatic query expansion built by the Search API.
      AUTO = 2
    end
  end

  # The specification for query spell correction.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode]
  #     The mode under which spell correction should take effect to
  #     replace the original search query. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
  class SpellCorrectionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which mode spell correction should occur.
    module Mode
      # Unspecified spell correction mode. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
      MODE_UNSPECIFIED = 0

      # Search API will try to find a spell suggestion if there
      # is any and put in the
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#corrected_query SearchResponse.corrected_query}.
      # The spell suggestion will not be used as the search query.
      SUGGESTION_ONLY = 1

      # Automatic spell correction built by the Search API. Search will
      # be based on the corrected query if found.
      AUTO = 2
    end
  end

  # The specification that configs the desired behavior of the UCS content
  # search.
  # @!attribute [rw] snippet_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec]
  #     If there is no snippet spec provided, there will be no snippet in the
  #     search result.
  # @!attribute [rw] summary_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec]
  #     If there is no summary spec provided, there will be no summary in the
  #     search response.
  class ContentSearchSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The specification that configs the snippet in the search results.
    # @!attribute [rw] max_snippet_count
    #   @return [::Integer]
    #     Max number of snippets returned in each search result.
    #     If the matching snippets is less than the max_snippet_count, return all
    #     of the snippets; otherwise, return the max_snippet_count.
    #
    #     At most 5 snippets will be returned for each SearchResult.
    # @!attribute [rw] reference_only
    #   @return [::Boolean]
    #     if true, only snippet reference is returned.
    class SnippetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The specification that configs the summary in the search response.
    # @!attribute [rw] summary_result_count
    #   @return [::Integer]
    #     The number of top results the summary should be generated from.
    #     If the number of returned results is less than summary_result_count,
    #     then the summary would be derived from all the results; otherwise, the
    #     summary would be derived from the top results.
    #
    #     At most 5 results can be used for generating summary.
    class SummarySpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Protobuf::Value]
  class ParamsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#content_search_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec

Returns The content search spec that configs the desired behavior of content search.

Returns:

• (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec) —

  The content search spec that configs the desired behavior of content search.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 161

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A facet specification to perform faceted search.
  # @!attribute [rw] facet_key
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey]
  #     Required. The facet key specification.
  # @!attribute [rw] limit
  #   @return [::Integer]
  #     Maximum of facet values that should be returned for this facet. If
  #     unspecified, defaults to 20. The maximum allowed value is 300. Values
  #     above 300 will be coerced to 300.
  #
  #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
  # @!attribute [rw] excluded_filter_keys
  #   @return [::Array<::String>]
  #     List of keys to exclude when faceting.
  #
  #
  #     By default,
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     is not excluded from the filter unless it is listed in this field.
  #
  #     Listing a facet key in this field allows its values to appear as facet
  #     results, even when they are filtered out of search results. Using this
  #     field does not affect what search results are returned.
  #
  #     For example, suppose there are 100 documents with the color facet "Red"
  #     and 200 documents with the color facet "Blue". A query containing the
  #     filter "color:ANY("Red")" and having "color" as
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     would by default return only "Red" documents in the search results, and
  #     also return "Red" with count 100 as the only color facet. Although there
  #     are also blue documents available, "Blue" would not be shown as an
  #     available facet value.
  #
  #     If "color" is listed in "excludedFilterKeys", then the query returns the
  #     facet values "Red" with count 100 and "Blue" with count 200, because the
  #     "color" key is now excluded from the filter. Because this field doesn't
  #     affect search results, the search results are still correctly filtered to
  #     return only "Red" documents.
  #
  #     A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
  #     error is returned.
  # @!attribute [rw] enable_dynamic_position
  #   @return [::Boolean]
  #     Enables dynamic position for this facet. If set to true, the position of
  #     this facet among all facets in the response is determined automatically.
  #     It will be ordered together with dynamic facets if dynamic
  #     facets is enabled. If set to false, the position of this facet in the
  #     response will be the same as in the request, and it will be ranked before
  #     the facets with dynamic position enable and all dynamic facets.
  #
  #     For example, you may always want to have rating facet returned in
  #     the response, but it's not necessarily to always display the rating facet
  #     at the top. In that case, you can set enable_dynamic_position to true so
  #     that the position of rating facet in response will be determined
  #     automatically.
  #
  #     Another example, assuming you have the following facets in the request:
  #
  #     * "rating", enable_dynamic_position = true
  #
  #     * "price", enable_dynamic_position = false
  #
  #     * "brands", enable_dynamic_position = false
  #
  #     And also you have a dynamic facets enable, which will generate a facet
  #     'gender'. Then the final order of the facets in the response can be
  #     ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
  #     "rating") depends on how API orders "gender" and "rating" facets.
  #     However, notice that "price" and "brands" will always be
  #     ranked at 1st and 2nd position since their enable_dynamic_position are
  #     false.
  class FacetSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how a facet is computed.
    # @!attribute [rw] key
    #   @return [::String]
    #     Required. Supported textual and numerical facet keys in
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} object, over
    #     which the facet values are computed. Facet key is case-sensitive.
    # @!attribute [rw] intervals
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Interval>]
    #     Set only if values should be bucketized into intervals. Must be set
    #     for facets with numerical values. Must not be set for facet with text
    #     values. Maximum number of intervals is 30.
    # @!attribute [rw] restricted_values
    #   @return [::Array<::String>]
    #     Only get facet for the given restricted values. Only supported on
    #     textual fields. For example, suppose "category" has three values
    #     "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
    #     "restricted_values" to "Action > 2022", the "category" facet will only
    #     contain "Action > 2022". Only supported on textual fields. Maximum
    #     is 10.
    # @!attribute [rw] prefixes
    #   @return [::Array<::String>]
    #     Only get facet values that start with the given string prefix. For
    #     example, suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
    #     "category" facet will only contain "Action > 2022" and "Action > 2021".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] contains
    #   @return [::Array<::String>]
    #     Only get facet values that contains the given strings. For example,
    #     suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
    #     "category" facet will only contain "Action > 2022" and "Sci-Fi > 2022".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] case_insensitive
    #   @return [::Boolean]
    #     True to make facet keys case insensitive when getting faceting
    #     values with prefixes or contains; false otherwise.
    # @!attribute [rw] order_by
    #   @return [::String]
    #     The order in which documents are returned.
    #
    #     Allowed values are:
    #
    #     * "count desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
    #     descending.
    #
    #     * "value desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
    #     descending.
    #       Only applies to textual facets.
    #
    #     If not set, textual values are sorted in [natural
    #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
    #     intervals are sorted in the order given by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
    class FacetKey
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Boost specification to boost certain documents.
  # @!attribute [rw] condition_boost_specs
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec>]
  #     Condition boost specifications. If a document matches multiple conditions
  #     in the specifictions, boost scores from these specifications are all
  #     applied and combined in a non-linear way. Maximum number of
  #     specifications is 20.
  class BoostSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost applies to documents which match a condition.
    # @!attribute [rw] condition
    #   @return [::String]
    #     An expression which specifies a boost condition. The syntax and
    #     supported fields are the same as a filter expression. See
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#filter SearchRequest.filter}
    #     for detail syntax and limitations.
    #
    #     Examples:
    #
    #     * To boost documents with document ID "doc_1" or "doc_2", and
    #     color
    #       "Red" or "Blue":
    #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
    # @!attribute [rw] boost
    #   @return [::Float]
    #     Strength of the condition boost, which should be in [-1, 1]. Negative
    #     boost means demotion. Default is 0.0.
    #
    #     Setting to 1.0 gives the document a big promotion. However, it does not
    #     necessarily mean that the boosted document will be the top result at
    #     all times, nor that other documents will be excluded. Results could
    #     still be shown even when none of them matches the condition. And
    #     results that are significantly more relevant to the search query can
    #     still trump your heavily favored but irrelevant documents.
    #
    #     Setting to -1.0 gives the document a big demotion. However, results
    #     that are deeply relevant might still be shown. The document will have
    #     an upstream battle to get a fairly high ranking, but it is not blocked
    #     out completely.
    #
    #     Setting to 0.0 means no boost applied. The boosting condition is
    #     ignored.
    class ConditionBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specification to determine under which conditions query expansion should
  # occur.
  # @!attribute [rw] condition
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition]
  #     The condition under which query expansion should occur. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
  class QueryExpansionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which condition query expansion should occur.
    module Condition
      # Unspecified query expansion condition. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
      CONDITION_UNSPECIFIED = 0

      # Disabled query expansion. Only the exact search query is used, even if
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#total_size SearchResponse.total_size}
      # is zero.
      DISABLED = 1

      # Automatic query expansion built by the Search API.
      AUTO = 2
    end
  end

  # The specification for query spell correction.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode]
  #     The mode under which spell correction should take effect to
  #     replace the original search query. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
  class SpellCorrectionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which mode spell correction should occur.
    module Mode
      # Unspecified spell correction mode. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
      MODE_UNSPECIFIED = 0

      # Search API will try to find a spell suggestion if there
      # is any and put in the
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#corrected_query SearchResponse.corrected_query}.
      # The spell suggestion will not be used as the search query.
      SUGGESTION_ONLY = 1

      # Automatic spell correction built by the Search API. Search will
      # be based on the corrected query if found.
      AUTO = 2
    end
  end

  # The specification that configs the desired behavior of the UCS content
  # search.
  # @!attribute [rw] snippet_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec]
  #     If there is no snippet spec provided, there will be no snippet in the
  #     search result.
  # @!attribute [rw] summary_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec]
  #     If there is no summary spec provided, there will be no summary in the
  #     search response.
  class ContentSearchSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The specification that configs the snippet in the search results.
    # @!attribute [rw] max_snippet_count
    #   @return [::Integer]
    #     Max number of snippets returned in each search result.
    #     If the matching snippets is less than the max_snippet_count, return all
    #     of the snippets; otherwise, return the max_snippet_count.
    #
    #     At most 5 snippets will be returned for each SearchResult.
    # @!attribute [rw] reference_only
    #   @return [::Boolean]
    #     if true, only snippet reference is returned.
    class SnippetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The specification that configs the summary in the search response.
    # @!attribute [rw] summary_result_count
    #   @return [::Integer]
    #     The number of top results the summary should be generated from.
    #     If the number of returned results is less than summary_result_count,
    #     then the summary would be derived from all the results; otherwise, the
    #     summary would be derived from the top results.
    #
    #     At most 5 results can be used for generating summary.
    class SummarySpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Protobuf::Value]
  class ParamsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#facet_specs ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec>

Returns Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

Returns:

• (::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec>) —

  Facet specifications for faceted search. If empty, no facets are returned.

  A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 161

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A facet specification to perform faceted search.
  # @!attribute [rw] facet_key
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey]
  #     Required. The facet key specification.
  # @!attribute [rw] limit
  #   @return [::Integer]
  #     Maximum of facet values that should be returned for this facet. If
  #     unspecified, defaults to 20. The maximum allowed value is 300. Values
  #     above 300 will be coerced to 300.
  #
  #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
  # @!attribute [rw] excluded_filter_keys
  #   @return [::Array<::String>]
  #     List of keys to exclude when faceting.
  #
  #
  #     By default,
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     is not excluded from the filter unless it is listed in this field.
  #
  #     Listing a facet key in this field allows its values to appear as facet
  #     results, even when they are filtered out of search results. Using this
  #     field does not affect what search results are returned.
  #
  #     For example, suppose there are 100 documents with the color facet "Red"
  #     and 200 documents with the color facet "Blue". A query containing the
  #     filter "color:ANY("Red")" and having "color" as
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     would by default return only "Red" documents in the search results, and
  #     also return "Red" with count 100 as the only color facet. Although there
  #     are also blue documents available, "Blue" would not be shown as an
  #     available facet value.
  #
  #     If "color" is listed in "excludedFilterKeys", then the query returns the
  #     facet values "Red" with count 100 and "Blue" with count 200, because the
  #     "color" key is now excluded from the filter. Because this field doesn't
  #     affect search results, the search results are still correctly filtered to
  #     return only "Red" documents.
  #
  #     A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
  #     error is returned.
  # @!attribute [rw] enable_dynamic_position
  #   @return [::Boolean]
  #     Enables dynamic position for this facet. If set to true, the position of
  #     this facet among all facets in the response is determined automatically.
  #     It will be ordered together with dynamic facets if dynamic
  #     facets is enabled. If set to false, the position of this facet in the
  #     response will be the same as in the request, and it will be ranked before
  #     the facets with dynamic position enable and all dynamic facets.
  #
  #     For example, you may always want to have rating facet returned in
  #     the response, but it's not necessarily to always display the rating facet
  #     at the top. In that case, you can set enable_dynamic_position to true so
  #     that the position of rating facet in response will be determined
  #     automatically.
  #
  #     Another example, assuming you have the following facets in the request:
  #
  #     * "rating", enable_dynamic_position = true
  #
  #     * "price", enable_dynamic_position = false
  #
  #     * "brands", enable_dynamic_position = false
  #
  #     And also you have a dynamic facets enable, which will generate a facet
  #     'gender'. Then the final order of the facets in the response can be
  #     ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
  #     "rating") depends on how API orders "gender" and "rating" facets.
  #     However, notice that "price" and "brands" will always be
  #     ranked at 1st and 2nd position since their enable_dynamic_position are
  #     false.
  class FacetSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how a facet is computed.
    # @!attribute [rw] key
    #   @return [::String]
    #     Required. Supported textual and numerical facet keys in
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} object, over
    #     which the facet values are computed. Facet key is case-sensitive.
    # @!attribute [rw] intervals
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Interval>]
    #     Set only if values should be bucketized into intervals. Must be set
    #     for facets with numerical values. Must not be set for facet with text
    #     values. Maximum number of intervals is 30.
    # @!attribute [rw] restricted_values
    #   @return [::Array<::String>]
    #     Only get facet for the given restricted values. Only supported on
    #     textual fields. For example, suppose "category" has three values
    #     "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
    #     "restricted_values" to "Action > 2022", the "category" facet will only
    #     contain "Action > 2022". Only supported on textual fields. Maximum
    #     is 10.
    # @!attribute [rw] prefixes
    #   @return [::Array<::String>]
    #     Only get facet values that start with the given string prefix. For
    #     example, suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
    #     "category" facet will only contain "Action > 2022" and "Action > 2021".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] contains
    #   @return [::Array<::String>]
    #     Only get facet values that contains the given strings. For example,
    #     suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
    #     "category" facet will only contain "Action > 2022" and "Sci-Fi > 2022".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] case_insensitive
    #   @return [::Boolean]
    #     True to make facet keys case insensitive when getting faceting
    #     values with prefixes or contains; false otherwise.
    # @!attribute [rw] order_by
    #   @return [::String]
    #     The order in which documents are returned.
    #
    #     Allowed values are:
    #
    #     * "count desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
    #     descending.
    #
    #     * "value desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
    #     descending.
    #       Only applies to textual facets.
    #
    #     If not set, textual values are sorted in [natural
    #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
    #     intervals are sorted in the order given by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
    class FacetKey
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Boost specification to boost certain documents.
  # @!attribute [rw] condition_boost_specs
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec>]
  #     Condition boost specifications. If a document matches multiple conditions
  #     in the specifictions, boost scores from these specifications are all
  #     applied and combined in a non-linear way. Maximum number of
  #     specifications is 20.
  class BoostSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost applies to documents which match a condition.
    # @!attribute [rw] condition
    #   @return [::String]
    #     An expression which specifies a boost condition. The syntax and
    #     supported fields are the same as a filter expression. See
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#filter SearchRequest.filter}
    #     for detail syntax and limitations.
    #
    #     Examples:
    #
    #     * To boost documents with document ID "doc_1" or "doc_2", and
    #     color
    #       "Red" or "Blue":
    #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
    # @!attribute [rw] boost
    #   @return [::Float]
    #     Strength of the condition boost, which should be in [-1, 1]. Negative
    #     boost means demotion. Default is 0.0.
    #
    #     Setting to 1.0 gives the document a big promotion. However, it does not
    #     necessarily mean that the boosted document will be the top result at
    #     all times, nor that other documents will be excluded. Results could
    #     still be shown even when none of them matches the condition. And
    #     results that are significantly more relevant to the search query can
    #     still trump your heavily favored but irrelevant documents.
    #
    #     Setting to -1.0 gives the document a big demotion. However, results
    #     that are deeply relevant might still be shown. The document will have
    #     an upstream battle to get a fairly high ranking, but it is not blocked
    #     out completely.
    #
    #     Setting to 0.0 means no boost applied. The boosting condition is
    #     ignored.
    class ConditionBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specification to determine under which conditions query expansion should
  # occur.
  # @!attribute [rw] condition
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition]
  #     The condition under which query expansion should occur. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
  class QueryExpansionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which condition query expansion should occur.
    module Condition
      # Unspecified query expansion condition. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
      CONDITION_UNSPECIFIED = 0

      # Disabled query expansion. Only the exact search query is used, even if
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#total_size SearchResponse.total_size}
      # is zero.
      DISABLED = 1

      # Automatic query expansion built by the Search API.
      AUTO = 2
    end
  end

  # The specification for query spell correction.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode]
  #     The mode under which spell correction should take effect to
  #     replace the original search query. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
  class SpellCorrectionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which mode spell correction should occur.
    module Mode
      # Unspecified spell correction mode. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
      MODE_UNSPECIFIED = 0

      # Search API will try to find a spell suggestion if there
      # is any and put in the
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#corrected_query SearchResponse.corrected_query}.
      # The spell suggestion will not be used as the search query.
      SUGGESTION_ONLY = 1

      # Automatic spell correction built by the Search API. Search will
      # be based on the corrected query if found.
      AUTO = 2
    end
  end

  # The specification that configs the desired behavior of the UCS content
  # search.
  # @!attribute [rw] snippet_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec]
  #     If there is no snippet spec provided, there will be no snippet in the
  #     search result.
  # @!attribute [rw] summary_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec]
  #     If there is no summary spec provided, there will be no summary in the
  #     search response.
  class ContentSearchSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The specification that configs the snippet in the search results.
    # @!attribute [rw] max_snippet_count
    #   @return [::Integer]
    #     Max number of snippets returned in each search result.
    #     If the matching snippets is less than the max_snippet_count, return all
    #     of the snippets; otherwise, return the max_snippet_count.
    #
    #     At most 5 snippets will be returned for each SearchResult.
    # @!attribute [rw] reference_only
    #   @return [::Boolean]
    #     if true, only snippet reference is returned.
    class SnippetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The specification that configs the summary in the search response.
    # @!attribute [rw] summary_result_count
    #   @return [::Integer]
    #     The number of top results the summary should be generated from.
    #     If the number of returned results is less than summary_result_count,
    #     then the summary would be derived from all the results; otherwise, the
    #     summary would be derived from the top results.
    #
    #     At most 5 results can be used for generating summary.
    class SummarySpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Protobuf::Value]
  class ParamsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#filter ⇒ ::String

Returns The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

Returns:

• (::String) —

  The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive.

  If this field is unrecognizable, an INVALID_ARGUMENT is returned.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 161

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A facet specification to perform faceted search.
  # @!attribute [rw] facet_key
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey]
  #     Required. The facet key specification.
  # @!attribute [rw] limit
  #   @return [::Integer]
  #     Maximum of facet values that should be returned for this facet. If
  #     unspecified, defaults to 20. The maximum allowed value is 300. Values
  #     above 300 will be coerced to 300.
  #
  #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
  # @!attribute [rw] excluded_filter_keys
  #   @return [::Array<::String>]
  #     List of keys to exclude when faceting.
  #
  #
  #     By default,
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     is not excluded from the filter unless it is listed in this field.
  #
  #     Listing a facet key in this field allows its values to appear as facet
  #     results, even when they are filtered out of search results. Using this
  #     field does not affect what search results are returned.
  #
  #     For example, suppose there are 100 documents with the color facet "Red"
  #     and 200 documents with the color facet "Blue". A query containing the
  #     filter "color:ANY("Red")" and having "color" as
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     would by default return only "Red" documents in the search results, and
  #     also return "Red" with count 100 as the only color facet. Although there
  #     are also blue documents available, "Blue" would not be shown as an
  #     available facet value.
  #
  #     If "color" is listed in "excludedFilterKeys", then the query returns the
  #     facet values "Red" with count 100 and "Blue" with count 200, because the
  #     "color" key is now excluded from the filter. Because this field doesn't
  #     affect search results, the search results are still correctly filtered to
  #     return only "Red" documents.
  #
  #     A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
  #     error is returned.
  # @!attribute [rw] enable_dynamic_position
  #   @return [::Boolean]
  #     Enables dynamic position for this facet. If set to true, the position of
  #     this facet among all facets in the response is determined automatically.
  #     It will be ordered together with dynamic facets if dynamic
  #     facets is enabled. If set to false, the position of this facet in the
  #     response will be the same as in the request, and it will be ranked before
  #     the facets with dynamic position enable and all dynamic facets.
  #
  #     For example, you may always want to have rating facet returned in
  #     the response, but it's not necessarily to always display the rating facet
  #     at the top. In that case, you can set enable_dynamic_position to true so
  #     that the position of rating facet in response will be determined
  #     automatically.
  #
  #     Another example, assuming you have the following facets in the request:
  #
  #     * "rating", enable_dynamic_position = true
  #
  #     * "price", enable_dynamic_position = false
  #
  #     * "brands", enable_dynamic_position = false
  #
  #     And also you have a dynamic facets enable, which will generate a facet
  #     'gender'. Then the final order of the facets in the response can be
  #     ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
  #     "rating") depends on how API orders "gender" and "rating" facets.
  #     However, notice that "price" and "brands" will always be
  #     ranked at 1st and 2nd position since their enable_dynamic_position are
  #     false.
  class FacetSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how a facet is computed.
    # @!attribute [rw] key
    #   @return [::String]
    #     Required. Supported textual and numerical facet keys in
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} object, over
    #     which the facet values are computed. Facet key is case-sensitive.
    # @!attribute [rw] intervals
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Interval>]
    #     Set only if values should be bucketized into intervals. Must be set
    #     for facets with numerical values. Must not be set for facet with text
    #     values. Maximum number of intervals is 30.
    # @!attribute [rw] restricted_values
    #   @return [::Array<::String>]
    #     Only get facet for the given restricted values. Only supported on
    #     textual fields. For example, suppose "category" has three values
    #     "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
    #     "restricted_values" to "Action > 2022", the "category" facet will only
    #     contain "Action > 2022". Only supported on textual fields. Maximum
    #     is 10.
    # @!attribute [rw] prefixes
    #   @return [::Array<::String>]
    #     Only get facet values that start with the given string prefix. For
    #     example, suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
    #     "category" facet will only contain "Action > 2022" and "Action > 2021".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] contains
    #   @return [::Array<::String>]
    #     Only get facet values that contains the given strings. For example,
    #     suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
    #     "category" facet will only contain "Action > 2022" and "Sci-Fi > 2022".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] case_insensitive
    #   @return [::Boolean]
    #     True to make facet keys case insensitive when getting faceting
    #     values with prefixes or contains; false otherwise.
    # @!attribute [rw] order_by
    #   @return [::String]
    #     The order in which documents are returned.
    #
    #     Allowed values are:
    #
    #     * "count desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
    #     descending.
    #
    #     * "value desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
    #     descending.
    #       Only applies to textual facets.
    #
    #     If not set, textual values are sorted in [natural
    #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
    #     intervals are sorted in the order given by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
    class FacetKey
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Boost specification to boost certain documents.
  # @!attribute [rw] condition_boost_specs
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec>]
  #     Condition boost specifications. If a document matches multiple conditions
  #     in the specifictions, boost scores from these specifications are all
  #     applied and combined in a non-linear way. Maximum number of
  #     specifications is 20.
  class BoostSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost applies to documents which match a condition.
    # @!attribute [rw] condition
    #   @return [::String]
    #     An expression which specifies a boost condition. The syntax and
    #     supported fields are the same as a filter expression. See
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#filter SearchRequest.filter}
    #     for detail syntax and limitations.
    #
    #     Examples:
    #
    #     * To boost documents with document ID "doc_1" or "doc_2", and
    #     color
    #       "Red" or "Blue":
    #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
    # @!attribute [rw] boost
    #   @return [::Float]
    #     Strength of the condition boost, which should be in [-1, 1]. Negative
    #     boost means demotion. Default is 0.0.
    #
    #     Setting to 1.0 gives the document a big promotion. However, it does not
    #     necessarily mean that the boosted document will be the top result at
    #     all times, nor that other documents will be excluded. Results could
    #     still be shown even when none of them matches the condition. And
    #     results that are significantly more relevant to the search query can
    #     still trump your heavily favored but irrelevant documents.
    #
    #     Setting to -1.0 gives the document a big demotion. However, results
    #     that are deeply relevant might still be shown. The document will have
    #     an upstream battle to get a fairly high ranking, but it is not blocked
    #     out completely.
    #
    #     Setting to 0.0 means no boost applied. The boosting condition is
    #     ignored.
    class ConditionBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specification to determine under which conditions query expansion should
  # occur.
  # @!attribute [rw] condition
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition]
  #     The condition under which query expansion should occur. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
  class QueryExpansionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which condition query expansion should occur.
    module Condition
      # Unspecified query expansion condition. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
      CONDITION_UNSPECIFIED = 0

      # Disabled query expansion. Only the exact search query is used, even if
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#total_size SearchResponse.total_size}
      # is zero.
      DISABLED = 1

      # Automatic query expansion built by the Search API.
      AUTO = 2
    end
  end

  # The specification for query spell correction.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode]
  #     The mode under which spell correction should take effect to
  #     replace the original search query. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
  class SpellCorrectionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which mode spell correction should occur.
    module Mode
      # Unspecified spell correction mode. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
      MODE_UNSPECIFIED = 0

      # Search API will try to find a spell suggestion if there
      # is any and put in the
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#corrected_query SearchResponse.corrected_query}.
      # The spell suggestion will not be used as the search query.
      SUGGESTION_ONLY = 1

      # Automatic spell correction built by the Search API. Search will
      # be based on the corrected query if found.
      AUTO = 2
    end
  end

  # The specification that configs the desired behavior of the UCS content
  # search.
  # @!attribute [rw] snippet_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec]
  #     If there is no snippet spec provided, there will be no snippet in the
  #     search result.
  # @!attribute [rw] summary_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec]
  #     If there is no summary spec provided, there will be no summary in the
  #     search response.
  class ContentSearchSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The specification that configs the snippet in the search results.
    # @!attribute [rw] max_snippet_count
    #   @return [::Integer]
    #     Max number of snippets returned in each search result.
    #     If the matching snippets is less than the max_snippet_count, return all
    #     of the snippets; otherwise, return the max_snippet_count.
    #
    #     At most 5 snippets will be returned for each SearchResult.
    # @!attribute [rw] reference_only
    #   @return [::Boolean]
    #     if true, only snippet reference is returned.
    class SnippetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The specification that configs the summary in the search response.
    # @!attribute [rw] summary_result_count
    #   @return [::Integer]
    #     The number of top results the summary should be generated from.
    #     If the number of returned results is less than summary_result_count,
    #     then the summary would be derived from all the results; otherwise, the
    #     summary would be derived from the top results.
    #
    #     At most 5 results can be used for generating summary.
    class SummarySpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Protobuf::Value]
  class ParamsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#offset ⇒ ::Integer

Returns A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset.

If this field is negative, an INVALID_ARGUMENT is returned.

Returns:

• (::Integer) —

  A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset.

  If this field is negative, an INVALID_ARGUMENT is returned.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 161

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A facet specification to perform faceted search.
  # @!attribute [rw] facet_key
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey]
  #     Required. The facet key specification.
  # @!attribute [rw] limit
  #   @return [::Integer]
  #     Maximum of facet values that should be returned for this facet. If
  #     unspecified, defaults to 20. The maximum allowed value is 300. Values
  #     above 300 will be coerced to 300.
  #
  #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
  # @!attribute [rw] excluded_filter_keys
  #   @return [::Array<::String>]
  #     List of keys to exclude when faceting.
  #
  #
  #     By default,
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     is not excluded from the filter unless it is listed in this field.
  #
  #     Listing a facet key in this field allows its values to appear as facet
  #     results, even when they are filtered out of search results. Using this
  #     field does not affect what search results are returned.
  #
  #     For example, suppose there are 100 documents with the color facet "Red"
  #     and 200 documents with the color facet "Blue". A query containing the
  #     filter "color:ANY("Red")" and having "color" as
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     would by default return only "Red" documents in the search results, and
  #     also return "Red" with count 100 as the only color facet. Although there
  #     are also blue documents available, "Blue" would not be shown as an
  #     available facet value.
  #
  #     If "color" is listed in "excludedFilterKeys", then the query returns the
  #     facet values "Red" with count 100 and "Blue" with count 200, because the
  #     "color" key is now excluded from the filter. Because this field doesn't
  #     affect search results, the search results are still correctly filtered to
  #     return only "Red" documents.
  #
  #     A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
  #     error is returned.
  # @!attribute [rw] enable_dynamic_position
  #   @return [::Boolean]
  #     Enables dynamic position for this facet. If set to true, the position of
  #     this facet among all facets in the response is determined automatically.
  #     It will be ordered together with dynamic facets if dynamic
  #     facets is enabled. If set to false, the position of this facet in the
  #     response will be the same as in the request, and it will be ranked before
  #     the facets with dynamic position enable and all dynamic facets.
  #
  #     For example, you may always want to have rating facet returned in
  #     the response, but it's not necessarily to always display the rating facet
  #     at the top. In that case, you can set enable_dynamic_position to true so
  #     that the position of rating facet in response will be determined
  #     automatically.
  #
  #     Another example, assuming you have the following facets in the request:
  #
  #     * "rating", enable_dynamic_position = true
  #
  #     * "price", enable_dynamic_position = false
  #
  #     * "brands", enable_dynamic_position = false
  #
  #     And also you have a dynamic facets enable, which will generate a facet
  #     'gender'. Then the final order of the facets in the response can be
  #     ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
  #     "rating") depends on how API orders "gender" and "rating" facets.
  #     However, notice that "price" and "brands" will always be
  #     ranked at 1st and 2nd position since their enable_dynamic_position are
  #     false.
  class FacetSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how a facet is computed.
    # @!attribute [rw] key
    #   @return [::String]
    #     Required. Supported textual and numerical facet keys in
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} object, over
    #     which the facet values are computed. Facet key is case-sensitive.
    # @!attribute [rw] intervals
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Interval>]
    #     Set only if values should be bucketized into intervals. Must be set
    #     for facets with numerical values. Must not be set for facet with text
    #     values. Maximum number of intervals is 30.
    # @!attribute [rw] restricted_values
    #   @return [::Array<::String>]
    #     Only get facet for the given restricted values. Only supported on
    #     textual fields. For example, suppose "category" has three values
    #     "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
    #     "restricted_values" to "Action > 2022", the "category" facet will only
    #     contain "Action > 2022". Only supported on textual fields. Maximum
    #     is 10.
    # @!attribute [rw] prefixes
    #   @return [::Array<::String>]
    #     Only get facet values that start with the given string prefix. For
    #     example, suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
    #     "category" facet will only contain "Action > 2022" and "Action > 2021".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] contains
    #   @return [::Array<::String>]
    #     Only get facet values that contains the given strings. For example,
    #     suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
    #     "category" facet will only contain "Action > 2022" and "Sci-Fi > 2022".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] case_insensitive
    #   @return [::Boolean]
    #     True to make facet keys case insensitive when getting faceting
    #     values with prefixes or contains; false otherwise.
    # @!attribute [rw] order_by
    #   @return [::String]
    #     The order in which documents are returned.
    #
    #     Allowed values are:
    #
    #     * "count desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
    #     descending.
    #
    #     * "value desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
    #     descending.
    #       Only applies to textual facets.
    #
    #     If not set, textual values are sorted in [natural
    #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
    #     intervals are sorted in the order given by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
    class FacetKey
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Boost specification to boost certain documents.
  # @!attribute [rw] condition_boost_specs
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec>]
  #     Condition boost specifications. If a document matches multiple conditions
  #     in the specifictions, boost scores from these specifications are all
  #     applied and combined in a non-linear way. Maximum number of
  #     specifications is 20.
  class BoostSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost applies to documents which match a condition.
    # @!attribute [rw] condition
    #   @return [::String]
    #     An expression which specifies a boost condition. The syntax and
    #     supported fields are the same as a filter expression. See
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#filter SearchRequest.filter}
    #     for detail syntax and limitations.
    #
    #     Examples:
    #
    #     * To boost documents with document ID "doc_1" or "doc_2", and
    #     color
    #       "Red" or "Blue":
    #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
    # @!attribute [rw] boost
    #   @return [::Float]
    #     Strength of the condition boost, which should be in [-1, 1]. Negative
    #     boost means demotion. Default is 0.0.
    #
    #     Setting to 1.0 gives the document a big promotion. However, it does not
    #     necessarily mean that the boosted document will be the top result at
    #     all times, nor that other documents will be excluded. Results could
    #     still be shown even when none of them matches the condition. And
    #     results that are significantly more relevant to the search query can
    #     still trump your heavily favored but irrelevant documents.
    #
    #     Setting to -1.0 gives the document a big demotion. However, results
    #     that are deeply relevant might still be shown. The document will have
    #     an upstream battle to get a fairly high ranking, but it is not blocked
    #     out completely.
    #
    #     Setting to 0.0 means no boost applied. The boosting condition is
    #     ignored.
    class ConditionBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specification to determine under which conditions query expansion should
  # occur.
  # @!attribute [rw] condition
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition]
  #     The condition under which query expansion should occur. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
  class QueryExpansionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which condition query expansion should occur.
    module Condition
      # Unspecified query expansion condition. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
      CONDITION_UNSPECIFIED = 0

      # Disabled query expansion. Only the exact search query is used, even if
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#total_size SearchResponse.total_size}
      # is zero.
      DISABLED = 1

      # Automatic query expansion built by the Search API.
      AUTO = 2
    end
  end

  # The specification for query spell correction.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode]
  #     The mode under which spell correction should take effect to
  #     replace the original search query. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
  class SpellCorrectionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which mode spell correction should occur.
    module Mode
      # Unspecified spell correction mode. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
      MODE_UNSPECIFIED = 0

      # Search API will try to find a spell suggestion if there
      # is any and put in the
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#corrected_query SearchResponse.corrected_query}.
      # The spell suggestion will not be used as the search query.
      SUGGESTION_ONLY = 1

      # Automatic spell correction built by the Search API. Search will
      # be based on the corrected query if found.
      AUTO = 2
    end
  end

  # The specification that configs the desired behavior of the UCS content
  # search.
  # @!attribute [rw] snippet_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec]
  #     If there is no snippet spec provided, there will be no snippet in the
  #     search result.
  # @!attribute [rw] summary_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec]
  #     If there is no summary spec provided, there will be no summary in the
  #     search response.
  class ContentSearchSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The specification that configs the snippet in the search results.
    # @!attribute [rw] max_snippet_count
    #   @return [::Integer]
    #     Max number of snippets returned in each search result.
    #     If the matching snippets is less than the max_snippet_count, return all
    #     of the snippets; otherwise, return the max_snippet_count.
    #
    #     At most 5 snippets will be returned for each SearchResult.
    # @!attribute [rw] reference_only
    #   @return [::Boolean]
    #     if true, only snippet reference is returned.
    class SnippetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The specification that configs the summary in the search response.
    # @!attribute [rw] summary_result_count
    #   @return [::Integer]
    #     The number of top results the summary should be generated from.
    #     If the number of returned results is less than summary_result_count,
    #     then the summary would be derived from all the results; otherwise, the
    #     summary would be derived from the top results.
    #
    #     At most 5 results can be used for generating summary.
    class SummarySpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Protobuf::Value]
  class ParamsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#order_by ⇒ ::String

Returns The order in which documents are returned. Document can be ordered by a field in an Document object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

Returns:

• (::String) —

  The order in which documents are returned. Document can be ordered by a field in an Document object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive.

  If this field is unrecognizable, an INVALID_ARGUMENT is returned.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 161

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A facet specification to perform faceted search.
  # @!attribute [rw] facet_key
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey]
  #     Required. The facet key specification.
  # @!attribute [rw] limit
  #   @return [::Integer]
  #     Maximum of facet values that should be returned for this facet. If
  #     unspecified, defaults to 20. The maximum allowed value is 300. Values
  #     above 300 will be coerced to 300.
  #
  #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
  # @!attribute [rw] excluded_filter_keys
  #   @return [::Array<::String>]
  #     List of keys to exclude when faceting.
  #
  #
  #     By default,
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     is not excluded from the filter unless it is listed in this field.
  #
  #     Listing a facet key in this field allows its values to appear as facet
  #     results, even when they are filtered out of search results. Using this
  #     field does not affect what search results are returned.
  #
  #     For example, suppose there are 100 documents with the color facet "Red"
  #     and 200 documents with the color facet "Blue". A query containing the
  #     filter "color:ANY("Red")" and having "color" as
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     would by default return only "Red" documents in the search results, and
  #     also return "Red" with count 100 as the only color facet. Although there
  #     are also blue documents available, "Blue" would not be shown as an
  #     available facet value.
  #
  #     If "color" is listed in "excludedFilterKeys", then the query returns the
  #     facet values "Red" with count 100 and "Blue" with count 200, because the
  #     "color" key is now excluded from the filter. Because this field doesn't
  #     affect search results, the search results are still correctly filtered to
  #     return only "Red" documents.
  #
  #     A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
  #     error is returned.
  # @!attribute [rw] enable_dynamic_position
  #   @return [::Boolean]
  #     Enables dynamic position for this facet. If set to true, the position of
  #     this facet among all facets in the response is determined automatically.
  #     It will be ordered together with dynamic facets if dynamic
  #     facets is enabled. If set to false, the position of this facet in the
  #     response will be the same as in the request, and it will be ranked before
  #     the facets with dynamic position enable and all dynamic facets.
  #
  #     For example, you may always want to have rating facet returned in
  #     the response, but it's not necessarily to always display the rating facet
  #     at the top. In that case, you can set enable_dynamic_position to true so
  #     that the position of rating facet in response will be determined
  #     automatically.
  #
  #     Another example, assuming you have the following facets in the request:
  #
  #     * "rating", enable_dynamic_position = true
  #
  #     * "price", enable_dynamic_position = false
  #
  #     * "brands", enable_dynamic_position = false
  #
  #     And also you have a dynamic facets enable, which will generate a facet
  #     'gender'. Then the final order of the facets in the response can be
  #     ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
  #     "rating") depends on how API orders "gender" and "rating" facets.
  #     However, notice that "price" and "brands" will always be
  #     ranked at 1st and 2nd position since their enable_dynamic_position are
  #     false.
  class FacetSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how a facet is computed.
    # @!attribute [rw] key
    #   @return [::String]
    #     Required. Supported textual and numerical facet keys in
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} object, over
    #     which the facet values are computed. Facet key is case-sensitive.
    # @!attribute [rw] intervals
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Interval>]
    #     Set only if values should be bucketized into intervals. Must be set
    #     for facets with numerical values. Must not be set for facet with text
    #     values. Maximum number of intervals is 30.
    # @!attribute [rw] restricted_values
    #   @return [::Array<::String>]
    #     Only get facet for the given restricted values. Only supported on
    #     textual fields. For example, suppose "category" has three values
    #     "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
    #     "restricted_values" to "Action > 2022", the "category" facet will only
    #     contain "Action > 2022". Only supported on textual fields. Maximum
    #     is 10.
    # @!attribute [rw] prefixes
    #   @return [::Array<::String>]
    #     Only get facet values that start with the given string prefix. For
    #     example, suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
    #     "category" facet will only contain "Action > 2022" and "Action > 2021".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] contains
    #   @return [::Array<::String>]
    #     Only get facet values that contains the given strings. For example,
    #     suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
    #     "category" facet will only contain "Action > 2022" and "Sci-Fi > 2022".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] case_insensitive
    #   @return [::Boolean]
    #     True to make facet keys case insensitive when getting faceting
    #     values with prefixes or contains; false otherwise.
    # @!attribute [rw] order_by
    #   @return [::String]
    #     The order in which documents are returned.
    #
    #     Allowed values are:
    #
    #     * "count desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
    #     descending.
    #
    #     * "value desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
    #     descending.
    #       Only applies to textual facets.
    #
    #     If not set, textual values are sorted in [natural
    #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
    #     intervals are sorted in the order given by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
    class FacetKey
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Boost specification to boost certain documents.
  # @!attribute [rw] condition_boost_specs
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec>]
  #     Condition boost specifications. If a document matches multiple conditions
  #     in the specifictions, boost scores from these specifications are all
  #     applied and combined in a non-linear way. Maximum number of
  #     specifications is 20.
  class BoostSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost applies to documents which match a condition.
    # @!attribute [rw] condition
    #   @return [::String]
    #     An expression which specifies a boost condition. The syntax and
    #     supported fields are the same as a filter expression. See
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#filter SearchRequest.filter}
    #     for detail syntax and limitations.
    #
    #     Examples:
    #
    #     * To boost documents with document ID "doc_1" or "doc_2", and
    #     color
    #       "Red" or "Blue":
    #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
    # @!attribute [rw] boost
    #   @return [::Float]
    #     Strength of the condition boost, which should be in [-1, 1]. Negative
    #     boost means demotion. Default is 0.0.
    #
    #     Setting to 1.0 gives the document a big promotion. However, it does not
    #     necessarily mean that the boosted document will be the top result at
    #     all times, nor that other documents will be excluded. Results could
    #     still be shown even when none of them matches the condition. And
    #     results that are significantly more relevant to the search query can
    #     still trump your heavily favored but irrelevant documents.
    #
    #     Setting to -1.0 gives the document a big demotion. However, results
    #     that are deeply relevant might still be shown. The document will have
    #     an upstream battle to get a fairly high ranking, but it is not blocked
    #     out completely.
    #
    #     Setting to 0.0 means no boost applied. The boosting condition is
    #     ignored.
    class ConditionBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specification to determine under which conditions query expansion should
  # occur.
  # @!attribute [rw] condition
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition]
  #     The condition under which query expansion should occur. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
  class QueryExpansionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which condition query expansion should occur.
    module Condition
      # Unspecified query expansion condition. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
      CONDITION_UNSPECIFIED = 0

      # Disabled query expansion. Only the exact search query is used, even if
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#total_size SearchResponse.total_size}
      # is zero.
      DISABLED = 1

      # Automatic query expansion built by the Search API.
      AUTO = 2
    end
  end

  # The specification for query spell correction.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode]
  #     The mode under which spell correction should take effect to
  #     replace the original search query. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
  class SpellCorrectionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which mode spell correction should occur.
    module Mode
      # Unspecified spell correction mode. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
      MODE_UNSPECIFIED = 0

      # Search API will try to find a spell suggestion if there
      # is any and put in the
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#corrected_query SearchResponse.corrected_query}.
      # The spell suggestion will not be used as the search query.
      SUGGESTION_ONLY = 1

      # Automatic spell correction built by the Search API. Search will
      # be based on the corrected query if found.
      AUTO = 2
    end
  end

  # The specification that configs the desired behavior of the UCS content
  # search.
  # @!attribute [rw] snippet_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec]
  #     If there is no snippet spec provided, there will be no snippet in the
  #     search result.
  # @!attribute [rw] summary_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec]
  #     If there is no summary spec provided, there will be no summary in the
  #     search response.
  class ContentSearchSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The specification that configs the snippet in the search results.
    # @!attribute [rw] max_snippet_count
    #   @return [::Integer]
    #     Max number of snippets returned in each search result.
    #     If the matching snippets is less than the max_snippet_count, return all
    #     of the snippets; otherwise, return the max_snippet_count.
    #
    #     At most 5 snippets will be returned for each SearchResult.
    # @!attribute [rw] reference_only
    #   @return [::Boolean]
    #     if true, only snippet reference is returned.
    class SnippetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The specification that configs the summary in the search response.
    # @!attribute [rw] summary_result_count
    #   @return [::Integer]
    #     The number of top results the summary should be generated from.
    #     If the number of returned results is less than summary_result_count,
    #     then the summary would be derived from all the results; otherwise, the
    #     summary would be derived from the top results.
    #
    #     At most 5 results can be used for generating summary.
    class SummarySpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Protobuf::Value]
  class ParamsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#page_size ⇒ ::Integer

Returns Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 will be coerced to 100.

If this field is negative, an INVALID_ARGUMENT is returned.

Returns:

• (::Integer) —

  Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 will be coerced to 100.

  If this field is negative, an INVALID_ARGUMENT is returned.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 161

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A facet specification to perform faceted search.
  # @!attribute [rw] facet_key
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey]
  #     Required. The facet key specification.
  # @!attribute [rw] limit
  #   @return [::Integer]
  #     Maximum of facet values that should be returned for this facet. If
  #     unspecified, defaults to 20. The maximum allowed value is 300. Values
  #     above 300 will be coerced to 300.
  #
  #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
  # @!attribute [rw] excluded_filter_keys
  #   @return [::Array<::String>]
  #     List of keys to exclude when faceting.
  #
  #
  #     By default,
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     is not excluded from the filter unless it is listed in this field.
  #
  #     Listing a facet key in this field allows its values to appear as facet
  #     results, even when they are filtered out of search results. Using this
  #     field does not affect what search results are returned.
  #
  #     For example, suppose there are 100 documents with the color facet "Red"
  #     and 200 documents with the color facet "Blue". A query containing the
  #     filter "color:ANY("Red")" and having "color" as
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     would by default return only "Red" documents in the search results, and
  #     also return "Red" with count 100 as the only color facet. Although there
  #     are also blue documents available, "Blue" would not be shown as an
  #     available facet value.
  #
  #     If "color" is listed in "excludedFilterKeys", then the query returns the
  #     facet values "Red" with count 100 and "Blue" with count 200, because the
  #     "color" key is now excluded from the filter. Because this field doesn't
  #     affect search results, the search results are still correctly filtered to
  #     return only "Red" documents.
  #
  #     A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
  #     error is returned.
  # @!attribute [rw] enable_dynamic_position
  #   @return [::Boolean]
  #     Enables dynamic position for this facet. If set to true, the position of
  #     this facet among all facets in the response is determined automatically.
  #     It will be ordered together with dynamic facets if dynamic
  #     facets is enabled. If set to false, the position of this facet in the
  #     response will be the same as in the request, and it will be ranked before
  #     the facets with dynamic position enable and all dynamic facets.
  #
  #     For example, you may always want to have rating facet returned in
  #     the response, but it's not necessarily to always display the rating facet
  #     at the top. In that case, you can set enable_dynamic_position to true so
  #     that the position of rating facet in response will be determined
  #     automatically.
  #
  #     Another example, assuming you have the following facets in the request:
  #
  #     * "rating", enable_dynamic_position = true
  #
  #     * "price", enable_dynamic_position = false
  #
  #     * "brands", enable_dynamic_position = false
  #
  #     And also you have a dynamic facets enable, which will generate a facet
  #     'gender'. Then the final order of the facets in the response can be
  #     ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
  #     "rating") depends on how API orders "gender" and "rating" facets.
  #     However, notice that "price" and "brands" will always be
  #     ranked at 1st and 2nd position since their enable_dynamic_position are
  #     false.
  class FacetSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how a facet is computed.
    # @!attribute [rw] key
    #   @return [::String]
    #     Required. Supported textual and numerical facet keys in
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} object, over
    #     which the facet values are computed. Facet key is case-sensitive.
    # @!attribute [rw] intervals
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Interval>]
    #     Set only if values should be bucketized into intervals. Must be set
    #     for facets with numerical values. Must not be set for facet with text
    #     values. Maximum number of intervals is 30.
    # @!attribute [rw] restricted_values
    #   @return [::Array<::String>]
    #     Only get facet for the given restricted values. Only supported on
    #     textual fields. For example, suppose "category" has three values
    #     "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
    #     "restricted_values" to "Action > 2022", the "category" facet will only
    #     contain "Action > 2022". Only supported on textual fields. Maximum
    #     is 10.
    # @!attribute [rw] prefixes
    #   @return [::Array<::String>]
    #     Only get facet values that start with the given string prefix. For
    #     example, suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
    #     "category" facet will only contain "Action > 2022" and "Action > 2021".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] contains
    #   @return [::Array<::String>]
    #     Only get facet values that contains the given strings. For example,
    #     suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
    #     "category" facet will only contain "Action > 2022" and "Sci-Fi > 2022".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] case_insensitive
    #   @return [::Boolean]
    #     True to make facet keys case insensitive when getting faceting
    #     values with prefixes or contains; false otherwise.
    # @!attribute [rw] order_by
    #   @return [::String]
    #     The order in which documents are returned.
    #
    #     Allowed values are:
    #
    #     * "count desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
    #     descending.
    #
    #     * "value desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
    #     descending.
    #       Only applies to textual facets.
    #
    #     If not set, textual values are sorted in [natural
    #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
    #     intervals are sorted in the order given by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
    class FacetKey
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Boost specification to boost certain documents.
  # @!attribute [rw] condition_boost_specs
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec>]
  #     Condition boost specifications. If a document matches multiple conditions
  #     in the specifictions, boost scores from these specifications are all
  #     applied and combined in a non-linear way. Maximum number of
  #     specifications is 20.
  class BoostSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost applies to documents which match a condition.
    # @!attribute [rw] condition
    #   @return [::String]
    #     An expression which specifies a boost condition. The syntax and
    #     supported fields are the same as a filter expression. See
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#filter SearchRequest.filter}
    #     for detail syntax and limitations.
    #
    #     Examples:
    #
    #     * To boost documents with document ID "doc_1" or "doc_2", and
    #     color
    #       "Red" or "Blue":
    #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
    # @!attribute [rw] boost
    #   @return [::Float]
    #     Strength of the condition boost, which should be in [-1, 1]. Negative
    #     boost means demotion. Default is 0.0.
    #
    #     Setting to 1.0 gives the document a big promotion. However, it does not
    #     necessarily mean that the boosted document will be the top result at
    #     all times, nor that other documents will be excluded. Results could
    #     still be shown even when none of them matches the condition. And
    #     results that are significantly more relevant to the search query can
    #     still trump your heavily favored but irrelevant documents.
    #
    #     Setting to -1.0 gives the document a big demotion. However, results
    #     that are deeply relevant might still be shown. The document will have
    #     an upstream battle to get a fairly high ranking, but it is not blocked
    #     out completely.
    #
    #     Setting to 0.0 means no boost applied. The boosting condition is
    #     ignored.
    class ConditionBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specification to determine under which conditions query expansion should
  # occur.
  # @!attribute [rw] condition
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition]
  #     The condition under which query expansion should occur. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
  class QueryExpansionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which condition query expansion should occur.
    module Condition
      # Unspecified query expansion condition. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
      CONDITION_UNSPECIFIED = 0

      # Disabled query expansion. Only the exact search query is used, even if
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#total_size SearchResponse.total_size}
      # is zero.
      DISABLED = 1

      # Automatic query expansion built by the Search API.
      AUTO = 2
    end
  end

  # The specification for query spell correction.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode]
  #     The mode under which spell correction should take effect to
  #     replace the original search query. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
  class SpellCorrectionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which mode spell correction should occur.
    module Mode
      # Unspecified spell correction mode. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
      MODE_UNSPECIFIED = 0

      # Search API will try to find a spell suggestion if there
      # is any and put in the
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#corrected_query SearchResponse.corrected_query}.
      # The spell suggestion will not be used as the search query.
      SUGGESTION_ONLY = 1

      # Automatic spell correction built by the Search API. Search will
      # be based on the corrected query if found.
      AUTO = 2
    end
  end

  # The specification that configs the desired behavior of the UCS content
  # search.
  # @!attribute [rw] snippet_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec]
  #     If there is no snippet spec provided, there will be no snippet in the
  #     search result.
  # @!attribute [rw] summary_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec]
  #     If there is no summary spec provided, there will be no summary in the
  #     search response.
  class ContentSearchSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The specification that configs the snippet in the search results.
    # @!attribute [rw] max_snippet_count
    #   @return [::Integer]
    #     Max number of snippets returned in each search result.
    #     If the matching snippets is less than the max_snippet_count, return all
    #     of the snippets; otherwise, return the max_snippet_count.
    #
    #     At most 5 snippets will be returned for each SearchResult.
    # @!attribute [rw] reference_only
    #   @return [::Boolean]
    #     if true, only snippet reference is returned.
    class SnippetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The specification that configs the summary in the search response.
    # @!attribute [rw] summary_result_count
    #   @return [::Integer]
    #     The number of top results the summary should be generated from.
    #     If the number of returned results is less than summary_result_count,
    #     then the summary would be derived from all the results; otherwise, the
    #     summary would be derived from the top results.
    #
    #     At most 5 results can be used for generating summary.
    class SummarySpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Protobuf::Value]
  class ParamsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#page_token ⇒ ::String

Returns A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

Returns:

• (::String) —

  A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page.

  When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 161

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A facet specification to perform faceted search.
  # @!attribute [rw] facet_key
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey]
  #     Required. The facet key specification.
  # @!attribute [rw] limit
  #   @return [::Integer]
  #     Maximum of facet values that should be returned for this facet. If
  #     unspecified, defaults to 20. The maximum allowed value is 300. Values
  #     above 300 will be coerced to 300.
  #
  #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
  # @!attribute [rw] excluded_filter_keys
  #   @return [::Array<::String>]
  #     List of keys to exclude when faceting.
  #
  #
  #     By default,
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     is not excluded from the filter unless it is listed in this field.
  #
  #     Listing a facet key in this field allows its values to appear as facet
  #     results, even when they are filtered out of search results. Using this
  #     field does not affect what search results are returned.
  #
  #     For example, suppose there are 100 documents with the color facet "Red"
  #     and 200 documents with the color facet "Blue". A query containing the
  #     filter "color:ANY("Red")" and having "color" as
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     would by default return only "Red" documents in the search results, and
  #     also return "Red" with count 100 as the only color facet. Although there
  #     are also blue documents available, "Blue" would not be shown as an
  #     available facet value.
  #
  #     If "color" is listed in "excludedFilterKeys", then the query returns the
  #     facet values "Red" with count 100 and "Blue" with count 200, because the
  #     "color" key is now excluded from the filter. Because this field doesn't
  #     affect search results, the search results are still correctly filtered to
  #     return only "Red" documents.
  #
  #     A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
  #     error is returned.
  # @!attribute [rw] enable_dynamic_position
  #   @return [::Boolean]
  #     Enables dynamic position for this facet. If set to true, the position of
  #     this facet among all facets in the response is determined automatically.
  #     It will be ordered together with dynamic facets if dynamic
  #     facets is enabled. If set to false, the position of this facet in the
  #     response will be the same as in the request, and it will be ranked before
  #     the facets with dynamic position enable and all dynamic facets.
  #
  #     For example, you may always want to have rating facet returned in
  #     the response, but it's not necessarily to always display the rating facet
  #     at the top. In that case, you can set enable_dynamic_position to true so
  #     that the position of rating facet in response will be determined
  #     automatically.
  #
  #     Another example, assuming you have the following facets in the request:
  #
  #     * "rating", enable_dynamic_position = true
  #
  #     * "price", enable_dynamic_position = false
  #
  #     * "brands", enable_dynamic_position = false
  #
  #     And also you have a dynamic facets enable, which will generate a facet
  #     'gender'. Then the final order of the facets in the response can be
  #     ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
  #     "rating") depends on how API orders "gender" and "rating" facets.
  #     However, notice that "price" and "brands" will always be
  #     ranked at 1st and 2nd position since their enable_dynamic_position are
  #     false.
  class FacetSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how a facet is computed.
    # @!attribute [rw] key
    #   @return [::String]
    #     Required. Supported textual and numerical facet keys in
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} object, over
    #     which the facet values are computed. Facet key is case-sensitive.
    # @!attribute [rw] intervals
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Interval>]
    #     Set only if values should be bucketized into intervals. Must be set
    #     for facets with numerical values. Must not be set for facet with text
    #     values. Maximum number of intervals is 30.
    # @!attribute [rw] restricted_values
    #   @return [::Array<::String>]
    #     Only get facet for the given restricted values. Only supported on
    #     textual fields. For example, suppose "category" has three values
    #     "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
    #     "restricted_values" to "Action > 2022", the "category" facet will only
    #     contain "Action > 2022". Only supported on textual fields. Maximum
    #     is 10.
    # @!attribute [rw] prefixes
    #   @return [::Array<::String>]
    #     Only get facet values that start with the given string prefix. For
    #     example, suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
    #     "category" facet will only contain "Action > 2022" and "Action > 2021".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] contains
    #   @return [::Array<::String>]
    #     Only get facet values that contains the given strings. For example,
    #     suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
    #     "category" facet will only contain "Action > 2022" and "Sci-Fi > 2022".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] case_insensitive
    #   @return [::Boolean]
    #     True to make facet keys case insensitive when getting faceting
    #     values with prefixes or contains; false otherwise.
    # @!attribute [rw] order_by
    #   @return [::String]
    #     The order in which documents are returned.
    #
    #     Allowed values are:
    #
    #     * "count desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
    #     descending.
    #
    #     * "value desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
    #     descending.
    #       Only applies to textual facets.
    #
    #     If not set, textual values are sorted in [natural
    #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
    #     intervals are sorted in the order given by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
    class FacetKey
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Boost specification to boost certain documents.
  # @!attribute [rw] condition_boost_specs
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec>]
  #     Condition boost specifications. If a document matches multiple conditions
  #     in the specifictions, boost scores from these specifications are all
  #     applied and combined in a non-linear way. Maximum number of
  #     specifications is 20.
  class BoostSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost applies to documents which match a condition.
    # @!attribute [rw] condition
    #   @return [::String]
    #     An expression which specifies a boost condition. The syntax and
    #     supported fields are the same as a filter expression. See
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#filter SearchRequest.filter}
    #     for detail syntax and limitations.
    #
    #     Examples:
    #
    #     * To boost documents with document ID "doc_1" or "doc_2", and
    #     color
    #       "Red" or "Blue":
    #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
    # @!attribute [rw] boost
    #   @return [::Float]
    #     Strength of the condition boost, which should be in [-1, 1]. Negative
    #     boost means demotion. Default is 0.0.
    #
    #     Setting to 1.0 gives the document a big promotion. However, it does not
    #     necessarily mean that the boosted document will be the top result at
    #     all times, nor that other documents will be excluded. Results could
    #     still be shown even when none of them matches the condition. And
    #     results that are significantly more relevant to the search query can
    #     still trump your heavily favored but irrelevant documents.
    #
    #     Setting to -1.0 gives the document a big demotion. However, results
    #     that are deeply relevant might still be shown. The document will have
    #     an upstream battle to get a fairly high ranking, but it is not blocked
    #     out completely.
    #
    #     Setting to 0.0 means no boost applied. The boosting condition is
    #     ignored.
    class ConditionBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specification to determine under which conditions query expansion should
  # occur.
  # @!attribute [rw] condition
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition]
  #     The condition under which query expansion should occur. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
  class QueryExpansionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which condition query expansion should occur.
    module Condition
      # Unspecified query expansion condition. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
      CONDITION_UNSPECIFIED = 0

      # Disabled query expansion. Only the exact search query is used, even if
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#total_size SearchResponse.total_size}
      # is zero.
      DISABLED = 1

      # Automatic query expansion built by the Search API.
      AUTO = 2
    end
  end

  # The specification for query spell correction.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode]
  #     The mode under which spell correction should take effect to
  #     replace the original search query. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
  class SpellCorrectionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which mode spell correction should occur.
    module Mode
      # Unspecified spell correction mode. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
      MODE_UNSPECIFIED = 0

      # Search API will try to find a spell suggestion if there
      # is any and put in the
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#corrected_query SearchResponse.corrected_query}.
      # The spell suggestion will not be used as the search query.
      SUGGESTION_ONLY = 1

      # Automatic spell correction built by the Search API. Search will
      # be based on the corrected query if found.
      AUTO = 2
    end
  end

  # The specification that configs the desired behavior of the UCS content
  # search.
  # @!attribute [rw] snippet_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec]
  #     If there is no snippet spec provided, there will be no snippet in the
  #     search result.
  # @!attribute [rw] summary_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec]
  #     If there is no summary spec provided, there will be no summary in the
  #     search response.
  class ContentSearchSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The specification that configs the snippet in the search results.
    # @!attribute [rw] max_snippet_count
    #   @return [::Integer]
    #     Max number of snippets returned in each search result.
    #     If the matching snippets is less than the max_snippet_count, return all
    #     of the snippets; otherwise, return the max_snippet_count.
    #
    #     At most 5 snippets will be returned for each SearchResult.
    # @!attribute [rw] reference_only
    #   @return [::Boolean]
    #     if true, only snippet reference is returned.
    class SnippetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The specification that configs the summary in the search response.
    # @!attribute [rw] summary_result_count
    #   @return [::Integer]
    #     The number of top results the summary should be generated from.
    #     If the number of returned results is less than summary_result_count,
    #     then the summary would be derived from all the results; otherwise, the
    #     summary would be derived from the top results.
    #
    #     At most 5 results can be used for generating summary.
    class SummarySpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Protobuf::Value]
  class ParamsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#params ⇒ ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}

Returns Additional search parameters.

For public website search only, supported values are:

• user_country_code: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided.
• search_type: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching.

Returns:

• (::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}) —

  Additional search parameters.

  For public website search only, supported values are:

  • user_country_code: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided.
  • search_type: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 161

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A facet specification to perform faceted search.
  # @!attribute [rw] facet_key
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey]
  #     Required. The facet key specification.
  # @!attribute [rw] limit
  #   @return [::Integer]
  #     Maximum of facet values that should be returned for this facet. If
  #     unspecified, defaults to 20. The maximum allowed value is 300. Values
  #     above 300 will be coerced to 300.
  #
  #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
  # @!attribute [rw] excluded_filter_keys
  #   @return [::Array<::String>]
  #     List of keys to exclude when faceting.
  #
  #
  #     By default,
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     is not excluded from the filter unless it is listed in this field.
  #
  #     Listing a facet key in this field allows its values to appear as facet
  #     results, even when they are filtered out of search results. Using this
  #     field does not affect what search results are returned.
  #
  #     For example, suppose there are 100 documents with the color facet "Red"
  #     and 200 documents with the color facet "Blue". A query containing the
  #     filter "color:ANY("Red")" and having "color" as
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     would by default return only "Red" documents in the search results, and
  #     also return "Red" with count 100 as the only color facet. Although there
  #     are also blue documents available, "Blue" would not be shown as an
  #     available facet value.
  #
  #     If "color" is listed in "excludedFilterKeys", then the query returns the
  #     facet values "Red" with count 100 and "Blue" with count 200, because the
  #     "color" key is now excluded from the filter. Because this field doesn't
  #     affect search results, the search results are still correctly filtered to
  #     return only "Red" documents.
  #
  #     A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
  #     error is returned.
  # @!attribute [rw] enable_dynamic_position
  #   @return [::Boolean]
  #     Enables dynamic position for this facet. If set to true, the position of
  #     this facet among all facets in the response is determined automatically.
  #     It will be ordered together with dynamic facets if dynamic
  #     facets is enabled. If set to false, the position of this facet in the
  #     response will be the same as in the request, and it will be ranked before
  #     the facets with dynamic position enable and all dynamic facets.
  #
  #     For example, you may always want to have rating facet returned in
  #     the response, but it's not necessarily to always display the rating facet
  #     at the top. In that case, you can set enable_dynamic_position to true so
  #     that the position of rating facet in response will be determined
  #     automatically.
  #
  #     Another example, assuming you have the following facets in the request:
  #
  #     * "rating", enable_dynamic_position = true
  #
  #     * "price", enable_dynamic_position = false
  #
  #     * "brands", enable_dynamic_position = false
  #
  #     And also you have a dynamic facets enable, which will generate a facet
  #     'gender'. Then the final order of the facets in the response can be
  #     ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
  #     "rating") depends on how API orders "gender" and "rating" facets.
  #     However, notice that "price" and "brands" will always be
  #     ranked at 1st and 2nd position since their enable_dynamic_position are
  #     false.
  class FacetSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how a facet is computed.
    # @!attribute [rw] key
    #   @return [::String]
    #     Required. Supported textual and numerical facet keys in
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} object, over
    #     which the facet values are computed. Facet key is case-sensitive.
    # @!attribute [rw] intervals
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Interval>]
    #     Set only if values should be bucketized into intervals. Must be set
    #     for facets with numerical values. Must not be set for facet with text
    #     values. Maximum number of intervals is 30.
    # @!attribute [rw] restricted_values
    #   @return [::Array<::String>]
    #     Only get facet for the given restricted values. Only supported on
    #     textual fields. For example, suppose "category" has three values
    #     "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
    #     "restricted_values" to "Action > 2022", the "category" facet will only
    #     contain "Action > 2022". Only supported on textual fields. Maximum
    #     is 10.
    # @!attribute [rw] prefixes
    #   @return [::Array<::String>]
    #     Only get facet values that start with the given string prefix. For
    #     example, suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
    #     "category" facet will only contain "Action > 2022" and "Action > 2021".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] contains
    #   @return [::Array<::String>]
    #     Only get facet values that contains the given strings. For example,
    #     suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
    #     "category" facet will only contain "Action > 2022" and "Sci-Fi > 2022".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] case_insensitive
    #   @return [::Boolean]
    #     True to make facet keys case insensitive when getting faceting
    #     values with prefixes or contains; false otherwise.
    # @!attribute [rw] order_by
    #   @return [::String]
    #     The order in which documents are returned.
    #
    #     Allowed values are:
    #
    #     * "count desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
    #     descending.
    #
    #     * "value desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
    #     descending.
    #       Only applies to textual facets.
    #
    #     If not set, textual values are sorted in [natural
    #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
    #     intervals are sorted in the order given by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
    class FacetKey
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Boost specification to boost certain documents.
  # @!attribute [rw] condition_boost_specs
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec>]
  #     Condition boost specifications. If a document matches multiple conditions
  #     in the specifictions, boost scores from these specifications are all
  #     applied and combined in a non-linear way. Maximum number of
  #     specifications is 20.
  class BoostSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost applies to documents which match a condition.
    # @!attribute [rw] condition
    #   @return [::String]
    #     An expression which specifies a boost condition. The syntax and
    #     supported fields are the same as a filter expression. See
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#filter SearchRequest.filter}
    #     for detail syntax and limitations.
    #
    #     Examples:
    #
    #     * To boost documents with document ID "doc_1" or "doc_2", and
    #     color
    #       "Red" or "Blue":
    #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
    # @!attribute [rw] boost
    #   @return [::Float]
    #     Strength of the condition boost, which should be in [-1, 1]. Negative
    #     boost means demotion. Default is 0.0.
    #
    #     Setting to 1.0 gives the document a big promotion. However, it does not
    #     necessarily mean that the boosted document will be the top result at
    #     all times, nor that other documents will be excluded. Results could
    #     still be shown even when none of them matches the condition. And
    #     results that are significantly more relevant to the search query can
    #     still trump your heavily favored but irrelevant documents.
    #
    #     Setting to -1.0 gives the document a big demotion. However, results
    #     that are deeply relevant might still be shown. The document will have
    #     an upstream battle to get a fairly high ranking, but it is not blocked
    #     out completely.
    #
    #     Setting to 0.0 means no boost applied. The boosting condition is
    #     ignored.
    class ConditionBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specification to determine under which conditions query expansion should
  # occur.
  # @!attribute [rw] condition
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition]
  #     The condition under which query expansion should occur. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
  class QueryExpansionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which condition query expansion should occur.
    module Condition
      # Unspecified query expansion condition. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
      CONDITION_UNSPECIFIED = 0

      # Disabled query expansion. Only the exact search query is used, even if
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#total_size SearchResponse.total_size}
      # is zero.
      DISABLED = 1

      # Automatic query expansion built by the Search API.
      AUTO = 2
    end
  end

  # The specification for query spell correction.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode]
  #     The mode under which spell correction should take effect to
  #     replace the original search query. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
  class SpellCorrectionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which mode spell correction should occur.
    module Mode
      # Unspecified spell correction mode. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
      MODE_UNSPECIFIED = 0

      # Search API will try to find a spell suggestion if there
      # is any and put in the
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#corrected_query SearchResponse.corrected_query}.
      # The spell suggestion will not be used as the search query.
      SUGGESTION_ONLY = 1

      # Automatic spell correction built by the Search API. Search will
      # be based on the corrected query if found.
      AUTO = 2
    end
  end

  # The specification that configs the desired behavior of the UCS content
  # search.
  # @!attribute [rw] snippet_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec]
  #     If there is no snippet spec provided, there will be no snippet in the
  #     search result.
  # @!attribute [rw] summary_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec]
  #     If there is no summary spec provided, there will be no summary in the
  #     search response.
  class ContentSearchSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The specification that configs the snippet in the search results.
    # @!attribute [rw] max_snippet_count
    #   @return [::Integer]
    #     Max number of snippets returned in each search result.
    #     If the matching snippets is less than the max_snippet_count, return all
    #     of the snippets; otherwise, return the max_snippet_count.
    #
    #     At most 5 snippets will be returned for each SearchResult.
    # @!attribute [rw] reference_only
    #   @return [::Boolean]
    #     if true, only snippet reference is returned.
    class SnippetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The specification that configs the summary in the search response.
    # @!attribute [rw] summary_result_count
    #   @return [::Integer]
    #     The number of top results the summary should be generated from.
    #     If the number of returned results is less than summary_result_count,
    #     then the summary would be derived from all the results; otherwise, the
    #     summary would be derived from the top results.
    #
    #     At most 5 results can be used for generating summary.
    class SummarySpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Protobuf::Value]
  class ParamsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#query ⇒ ::String

Returns Raw search query.

Returns:

• (::String) —

  Raw search query.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 161

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A facet specification to perform faceted search.
  # @!attribute [rw] facet_key
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey]
  #     Required. The facet key specification.
  # @!attribute [rw] limit
  #   @return [::Integer]
  #     Maximum of facet values that should be returned for this facet. If
  #     unspecified, defaults to 20. The maximum allowed value is 300. Values
  #     above 300 will be coerced to 300.
  #
  #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
  # @!attribute [rw] excluded_filter_keys
  #   @return [::Array<::String>]
  #     List of keys to exclude when faceting.
  #
  #
  #     By default,
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     is not excluded from the filter unless it is listed in this field.
  #
  #     Listing a facet key in this field allows its values to appear as facet
  #     results, even when they are filtered out of search results. Using this
  #     field does not affect what search results are returned.
  #
  #     For example, suppose there are 100 documents with the color facet "Red"
  #     and 200 documents with the color facet "Blue". A query containing the
  #     filter "color:ANY("Red")" and having "color" as
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     would by default return only "Red" documents in the search results, and
  #     also return "Red" with count 100 as the only color facet. Although there
  #     are also blue documents available, "Blue" would not be shown as an
  #     available facet value.
  #
  #     If "color" is listed in "excludedFilterKeys", then the query returns the
  #     facet values "Red" with count 100 and "Blue" with count 200, because the
  #     "color" key is now excluded from the filter. Because this field doesn't
  #     affect search results, the search results are still correctly filtered to
  #     return only "Red" documents.
  #
  #     A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
  #     error is returned.
  # @!attribute [rw] enable_dynamic_position
  #   @return [::Boolean]
  #     Enables dynamic position for this facet. If set to true, the position of
  #     this facet among all facets in the response is determined automatically.
  #     It will be ordered together with dynamic facets if dynamic
  #     facets is enabled. If set to false, the position of this facet in the
  #     response will be the same as in the request, and it will be ranked before
  #     the facets with dynamic position enable and all dynamic facets.
  #
  #     For example, you may always want to have rating facet returned in
  #     the response, but it's not necessarily to always display the rating facet
  #     at the top. In that case, you can set enable_dynamic_position to true so
  #     that the position of rating facet in response will be determined
  #     automatically.
  #
  #     Another example, assuming you have the following facets in the request:
  #
  #     * "rating", enable_dynamic_position = true
  #
  #     * "price", enable_dynamic_position = false
  #
  #     * "brands", enable_dynamic_position = false
  #
  #     And also you have a dynamic facets enable, which will generate a facet
  #     'gender'. Then the final order of the facets in the response can be
  #     ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
  #     "rating") depends on how API orders "gender" and "rating" facets.
  #     However, notice that "price" and "brands" will always be
  #     ranked at 1st and 2nd position since their enable_dynamic_position are
  #     false.
  class FacetSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how a facet is computed.
    # @!attribute [rw] key
    #   @return [::String]
    #     Required. Supported textual and numerical facet keys in
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} object, over
    #     which the facet values are computed. Facet key is case-sensitive.
    # @!attribute [rw] intervals
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Interval>]
    #     Set only if values should be bucketized into intervals. Must be set
    #     for facets with numerical values. Must not be set for facet with text
    #     values. Maximum number of intervals is 30.
    # @!attribute [rw] restricted_values
    #   @return [::Array<::String>]
    #     Only get facet for the given restricted values. Only supported on
    #     textual fields. For example, suppose "category" has three values
    #     "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
    #     "restricted_values" to "Action > 2022", the "category" facet will only
    #     contain "Action > 2022". Only supported on textual fields. Maximum
    #     is 10.
    # @!attribute [rw] prefixes
    #   @return [::Array<::String>]
    #     Only get facet values that start with the given string prefix. For
    #     example, suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
    #     "category" facet will only contain "Action > 2022" and "Action > 2021".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] contains
    #   @return [::Array<::String>]
    #     Only get facet values that contains the given strings. For example,
    #     suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
    #     "category" facet will only contain "Action > 2022" and "Sci-Fi > 2022".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] case_insensitive
    #   @return [::Boolean]
    #     True to make facet keys case insensitive when getting faceting
    #     values with prefixes or contains; false otherwise.
    # @!attribute [rw] order_by
    #   @return [::String]
    #     The order in which documents are returned.
    #
    #     Allowed values are:
    #
    #     * "count desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
    #     descending.
    #
    #     * "value desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
    #     descending.
    #       Only applies to textual facets.
    #
    #     If not set, textual values are sorted in [natural
    #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
    #     intervals are sorted in the order given by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
    class FacetKey
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Boost specification to boost certain documents.
  # @!attribute [rw] condition_boost_specs
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec>]
  #     Condition boost specifications. If a document matches multiple conditions
  #     in the specifictions, boost scores from these specifications are all
  #     applied and combined in a non-linear way. Maximum number of
  #     specifications is 20.
  class BoostSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost applies to documents which match a condition.
    # @!attribute [rw] condition
    #   @return [::String]
    #     An expression which specifies a boost condition. The syntax and
    #     supported fields are the same as a filter expression. See
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#filter SearchRequest.filter}
    #     for detail syntax and limitations.
    #
    #     Examples:
    #
    #     * To boost documents with document ID "doc_1" or "doc_2", and
    #     color
    #       "Red" or "Blue":
    #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
    # @!attribute [rw] boost
    #   @return [::Float]
    #     Strength of the condition boost, which should be in [-1, 1]. Negative
    #     boost means demotion. Default is 0.0.
    #
    #     Setting to 1.0 gives the document a big promotion. However, it does not
    #     necessarily mean that the boosted document will be the top result at
    #     all times, nor that other documents will be excluded. Results could
    #     still be shown even when none of them matches the condition. And
    #     results that are significantly more relevant to the search query can
    #     still trump your heavily favored but irrelevant documents.
    #
    #     Setting to -1.0 gives the document a big demotion. However, results
    #     that are deeply relevant might still be shown. The document will have
    #     an upstream battle to get a fairly high ranking, but it is not blocked
    #     out completely.
    #
    #     Setting to 0.0 means no boost applied. The boosting condition is
    #     ignored.
    class ConditionBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specification to determine under which conditions query expansion should
  # occur.
  # @!attribute [rw] condition
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition]
  #     The condition under which query expansion should occur. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
  class QueryExpansionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which condition query expansion should occur.
    module Condition
      # Unspecified query expansion condition. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
      CONDITION_UNSPECIFIED = 0

      # Disabled query expansion. Only the exact search query is used, even if
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#total_size SearchResponse.total_size}
      # is zero.
      DISABLED = 1

      # Automatic query expansion built by the Search API.
      AUTO = 2
    end
  end

  # The specification for query spell correction.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode]
  #     The mode under which spell correction should take effect to
  #     replace the original search query. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
  class SpellCorrectionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which mode spell correction should occur.
    module Mode
      # Unspecified spell correction mode. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
      MODE_UNSPECIFIED = 0

      # Search API will try to find a spell suggestion if there
      # is any and put in the
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#corrected_query SearchResponse.corrected_query}.
      # The spell suggestion will not be used as the search query.
      SUGGESTION_ONLY = 1

      # Automatic spell correction built by the Search API. Search will
      # be based on the corrected query if found.
      AUTO = 2
    end
  end

  # The specification that configs the desired behavior of the UCS content
  # search.
  # @!attribute [rw] snippet_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec]
  #     If there is no snippet spec provided, there will be no snippet in the
  #     search result.
  # @!attribute [rw] summary_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec]
  #     If there is no summary spec provided, there will be no summary in the
  #     search response.
  class ContentSearchSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The specification that configs the snippet in the search results.
    # @!attribute [rw] max_snippet_count
    #   @return [::Integer]
    #     Max number of snippets returned in each search result.
    #     If the matching snippets is less than the max_snippet_count, return all
    #     of the snippets; otherwise, return the max_snippet_count.
    #
    #     At most 5 snippets will be returned for each SearchResult.
    # @!attribute [rw] reference_only
    #   @return [::Boolean]
    #     if true, only snippet reference is returned.
    class SnippetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The specification that configs the summary in the search response.
    # @!attribute [rw] summary_result_count
    #   @return [::Integer]
    #     The number of top results the summary should be generated from.
    #     If the number of returned results is less than summary_result_count,
    #     then the summary would be derived from all the results; otherwise, the
    #     summary would be derived from the top results.
    #
    #     At most 5 results can be used for generating summary.
    class SummarySpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Protobuf::Value]
  class ParamsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#query_expansion_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec

Returns The query expansion specification that specifies the conditions under which query expansion will occur.

Returns:

• (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec) —

  The query expansion specification that specifies the conditions under which query expansion will occur.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 161

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A facet specification to perform faceted search.
  # @!attribute [rw] facet_key
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey]
  #     Required. The facet key specification.
  # @!attribute [rw] limit
  #   @return [::Integer]
  #     Maximum of facet values that should be returned for this facet. If
  #     unspecified, defaults to 20. The maximum allowed value is 300. Values
  #     above 300 will be coerced to 300.
  #
  #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
  # @!attribute [rw] excluded_filter_keys
  #   @return [::Array<::String>]
  #     List of keys to exclude when faceting.
  #
  #
  #     By default,
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     is not excluded from the filter unless it is listed in this field.
  #
  #     Listing a facet key in this field allows its values to appear as facet
  #     results, even when they are filtered out of search results. Using this
  #     field does not affect what search results are returned.
  #
  #     For example, suppose there are 100 documents with the color facet "Red"
  #     and 200 documents with the color facet "Blue". A query containing the
  #     filter "color:ANY("Red")" and having "color" as
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     would by default return only "Red" documents in the search results, and
  #     also return "Red" with count 100 as the only color facet. Although there
  #     are also blue documents available, "Blue" would not be shown as an
  #     available facet value.
  #
  #     If "color" is listed in "excludedFilterKeys", then the query returns the
  #     facet values "Red" with count 100 and "Blue" with count 200, because the
  #     "color" key is now excluded from the filter. Because this field doesn't
  #     affect search results, the search results are still correctly filtered to
  #     return only "Red" documents.
  #
  #     A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
  #     error is returned.
  # @!attribute [rw] enable_dynamic_position
  #   @return [::Boolean]
  #     Enables dynamic position for this facet. If set to true, the position of
  #     this facet among all facets in the response is determined automatically.
  #     It will be ordered together with dynamic facets if dynamic
  #     facets is enabled. If set to false, the position of this facet in the
  #     response will be the same as in the request, and it will be ranked before
  #     the facets with dynamic position enable and all dynamic facets.
  #
  #     For example, you may always want to have rating facet returned in
  #     the response, but it's not necessarily to always display the rating facet
  #     at the top. In that case, you can set enable_dynamic_position to true so
  #     that the position of rating facet in response will be determined
  #     automatically.
  #
  #     Another example, assuming you have the following facets in the request:
  #
  #     * "rating", enable_dynamic_position = true
  #
  #     * "price", enable_dynamic_position = false
  #
  #     * "brands", enable_dynamic_position = false
  #
  #     And also you have a dynamic facets enable, which will generate a facet
  #     'gender'. Then the final order of the facets in the response can be
  #     ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
  #     "rating") depends on how API orders "gender" and "rating" facets.
  #     However, notice that "price" and "brands" will always be
  #     ranked at 1st and 2nd position since their enable_dynamic_position are
  #     false.
  class FacetSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how a facet is computed.
    # @!attribute [rw] key
    #   @return [::String]
    #     Required. Supported textual and numerical facet keys in
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} object, over
    #     which the facet values are computed. Facet key is case-sensitive.
    # @!attribute [rw] intervals
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Interval>]
    #     Set only if values should be bucketized into intervals. Must be set
    #     for facets with numerical values. Must not be set for facet with text
    #     values. Maximum number of intervals is 30.
    # @!attribute [rw] restricted_values
    #   @return [::Array<::String>]
    #     Only get facet for the given restricted values. Only supported on
    #     textual fields. For example, suppose "category" has three values
    #     "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
    #     "restricted_values" to "Action > 2022", the "category" facet will only
    #     contain "Action > 2022". Only supported on textual fields. Maximum
    #     is 10.
    # @!attribute [rw] prefixes
    #   @return [::Array<::String>]
    #     Only get facet values that start with the given string prefix. For
    #     example, suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
    #     "category" facet will only contain "Action > 2022" and "Action > 2021".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] contains
    #   @return [::Array<::String>]
    #     Only get facet values that contains the given strings. For example,
    #     suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
    #     "category" facet will only contain "Action > 2022" and "Sci-Fi > 2022".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] case_insensitive
    #   @return [::Boolean]
    #     True to make facet keys case insensitive when getting faceting
    #     values with prefixes or contains; false otherwise.
    # @!attribute [rw] order_by
    #   @return [::String]
    #     The order in which documents are returned.
    #
    #     Allowed values are:
    #
    #     * "count desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
    #     descending.
    #
    #     * "value desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
    #     descending.
    #       Only applies to textual facets.
    #
    #     If not set, textual values are sorted in [natural
    #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
    #     intervals are sorted in the order given by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
    class FacetKey
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Boost specification to boost certain documents.
  # @!attribute [rw] condition_boost_specs
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec>]
  #     Condition boost specifications. If a document matches multiple conditions
  #     in the specifictions, boost scores from these specifications are all
  #     applied and combined in a non-linear way. Maximum number of
  #     specifications is 20.
  class BoostSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost applies to documents which match a condition.
    # @!attribute [rw] condition
    #   @return [::String]
    #     An expression which specifies a boost condition. The syntax and
    #     supported fields are the same as a filter expression. See
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#filter SearchRequest.filter}
    #     for detail syntax and limitations.
    #
    #     Examples:
    #
    #     * To boost documents with document ID "doc_1" or "doc_2", and
    #     color
    #       "Red" or "Blue":
    #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
    # @!attribute [rw] boost
    #   @return [::Float]
    #     Strength of the condition boost, which should be in [-1, 1]. Negative
    #     boost means demotion. Default is 0.0.
    #
    #     Setting to 1.0 gives the document a big promotion. However, it does not
    #     necessarily mean that the boosted document will be the top result at
    #     all times, nor that other documents will be excluded. Results could
    #     still be shown even when none of them matches the condition. And
    #     results that are significantly more relevant to the search query can
    #     still trump your heavily favored but irrelevant documents.
    #
    #     Setting to -1.0 gives the document a big demotion. However, results
    #     that are deeply relevant might still be shown. The document will have
    #     an upstream battle to get a fairly high ranking, but it is not blocked
    #     out completely.
    #
    #     Setting to 0.0 means no boost applied. The boosting condition is
    #     ignored.
    class ConditionBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specification to determine under which conditions query expansion should
  # occur.
  # @!attribute [rw] condition
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition]
  #     The condition under which query expansion should occur. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
  class QueryExpansionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which condition query expansion should occur.
    module Condition
      # Unspecified query expansion condition. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
      CONDITION_UNSPECIFIED = 0

      # Disabled query expansion. Only the exact search query is used, even if
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#total_size SearchResponse.total_size}
      # is zero.
      DISABLED = 1

      # Automatic query expansion built by the Search API.
      AUTO = 2
    end
  end

  # The specification for query spell correction.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode]
  #     The mode under which spell correction should take effect to
  #     replace the original search query. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
  class SpellCorrectionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which mode spell correction should occur.
    module Mode
      # Unspecified spell correction mode. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
      MODE_UNSPECIFIED = 0

      # Search API will try to find a spell suggestion if there
      # is any and put in the
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#corrected_query SearchResponse.corrected_query}.
      # The spell suggestion will not be used as the search query.
      SUGGESTION_ONLY = 1

      # Automatic spell correction built by the Search API. Search will
      # be based on the corrected query if found.
      AUTO = 2
    end
  end

  # The specification that configs the desired behavior of the UCS content
  # search.
  # @!attribute [rw] snippet_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec]
  #     If there is no snippet spec provided, there will be no snippet in the
  #     search result.
  # @!attribute [rw] summary_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec]
  #     If there is no summary spec provided, there will be no summary in the
  #     search response.
  class ContentSearchSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The specification that configs the snippet in the search results.
    # @!attribute [rw] max_snippet_count
    #   @return [::Integer]
    #     Max number of snippets returned in each search result.
    #     If the matching snippets is less than the max_snippet_count, return all
    #     of the snippets; otherwise, return the max_snippet_count.
    #
    #     At most 5 snippets will be returned for each SearchResult.
    # @!attribute [rw] reference_only
    #   @return [::Boolean]
    #     if true, only snippet reference is returned.
    class SnippetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The specification that configs the summary in the search response.
    # @!attribute [rw] summary_result_count
    #   @return [::Integer]
    #     The number of top results the summary should be generated from.
    #     If the number of returned results is less than summary_result_count,
    #     then the summary would be derived from all the results; otherwise, the
    #     summary would be derived from the top results.
    #
    #     At most 5 results can be used for generating summary.
    class SummarySpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Protobuf::Value]
  class ParamsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#safe_search ⇒ ::Boolean

Returns Whether to turn on safe search. This is only supported for [ContentConfig.PUBLIC_WEBSITE][].

Returns:

• (::Boolean) —

  Whether to turn on safe search. This is only supported for [ContentConfig.PUBLIC_WEBSITE][].

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 161

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A facet specification to perform faceted search.
  # @!attribute [rw] facet_key
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey]
  #     Required. The facet key specification.
  # @!attribute [rw] limit
  #   @return [::Integer]
  #     Maximum of facet values that should be returned for this facet. If
  #     unspecified, defaults to 20. The maximum allowed value is 300. Values
  #     above 300 will be coerced to 300.
  #
  #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
  # @!attribute [rw] excluded_filter_keys
  #   @return [::Array<::String>]
  #     List of keys to exclude when faceting.
  #
  #
  #     By default,
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     is not excluded from the filter unless it is listed in this field.
  #
  #     Listing a facet key in this field allows its values to appear as facet
  #     results, even when they are filtered out of search results. Using this
  #     field does not affect what search results are returned.
  #
  #     For example, suppose there are 100 documents with the color facet "Red"
  #     and 200 documents with the color facet "Blue". A query containing the
  #     filter "color:ANY("Red")" and having "color" as
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     would by default return only "Red" documents in the search results, and
  #     also return "Red" with count 100 as the only color facet. Although there
  #     are also blue documents available, "Blue" would not be shown as an
  #     available facet value.
  #
  #     If "color" is listed in "excludedFilterKeys", then the query returns the
  #     facet values "Red" with count 100 and "Blue" with count 200, because the
  #     "color" key is now excluded from the filter. Because this field doesn't
  #     affect search results, the search results are still correctly filtered to
  #     return only "Red" documents.
  #
  #     A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
  #     error is returned.
  # @!attribute [rw] enable_dynamic_position
  #   @return [::Boolean]
  #     Enables dynamic position for this facet. If set to true, the position of
  #     this facet among all facets in the response is determined automatically.
  #     It will be ordered together with dynamic facets if dynamic
  #     facets is enabled. If set to false, the position of this facet in the
  #     response will be the same as in the request, and it will be ranked before
  #     the facets with dynamic position enable and all dynamic facets.
  #
  #     For example, you may always want to have rating facet returned in
  #     the response, but it's not necessarily to always display the rating facet
  #     at the top. In that case, you can set enable_dynamic_position to true so
  #     that the position of rating facet in response will be determined
  #     automatically.
  #
  #     Another example, assuming you have the following facets in the request:
  #
  #     * "rating", enable_dynamic_position = true
  #
  #     * "price", enable_dynamic_position = false
  #
  #     * "brands", enable_dynamic_position = false
  #
  #     And also you have a dynamic facets enable, which will generate a facet
  #     'gender'. Then the final order of the facets in the response can be
  #     ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
  #     "rating") depends on how API orders "gender" and "rating" facets.
  #     However, notice that "price" and "brands" will always be
  #     ranked at 1st and 2nd position since their enable_dynamic_position are
  #     false.
  class FacetSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how a facet is computed.
    # @!attribute [rw] key
    #   @return [::String]
    #     Required. Supported textual and numerical facet keys in
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} object, over
    #     which the facet values are computed. Facet key is case-sensitive.
    # @!attribute [rw] intervals
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Interval>]
    #     Set only if values should be bucketized into intervals. Must be set
    #     for facets with numerical values. Must not be set for facet with text
    #     values. Maximum number of intervals is 30.
    # @!attribute [rw] restricted_values
    #   @return [::Array<::String>]
    #     Only get facet for the given restricted values. Only supported on
    #     textual fields. For example, suppose "category" has three values
    #     "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
    #     "restricted_values" to "Action > 2022", the "category" facet will only
    #     contain "Action > 2022". Only supported on textual fields. Maximum
    #     is 10.
    # @!attribute [rw] prefixes
    #   @return [::Array<::String>]
    #     Only get facet values that start with the given string prefix. For
    #     example, suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
    #     "category" facet will only contain "Action > 2022" and "Action > 2021".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] contains
    #   @return [::Array<::String>]
    #     Only get facet values that contains the given strings. For example,
    #     suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
    #     "category" facet will only contain "Action > 2022" and "Sci-Fi > 2022".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] case_insensitive
    #   @return [::Boolean]
    #     True to make facet keys case insensitive when getting faceting
    #     values with prefixes or contains; false otherwise.
    # @!attribute [rw] order_by
    #   @return [::String]
    #     The order in which documents are returned.
    #
    #     Allowed values are:
    #
    #     * "count desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
    #     descending.
    #
    #     * "value desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
    #     descending.
    #       Only applies to textual facets.
    #
    #     If not set, textual values are sorted in [natural
    #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
    #     intervals are sorted in the order given by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
    class FacetKey
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Boost specification to boost certain documents.
  # @!attribute [rw] condition_boost_specs
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec>]
  #     Condition boost specifications. If a document matches multiple conditions
  #     in the specifictions, boost scores from these specifications are all
  #     applied and combined in a non-linear way. Maximum number of
  #     specifications is 20.
  class BoostSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost applies to documents which match a condition.
    # @!attribute [rw] condition
    #   @return [::String]
    #     An expression which specifies a boost condition. The syntax and
    #     supported fields are the same as a filter expression. See
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#filter SearchRequest.filter}
    #     for detail syntax and limitations.
    #
    #     Examples:
    #
    #     * To boost documents with document ID "doc_1" or "doc_2", and
    #     color
    #       "Red" or "Blue":
    #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
    # @!attribute [rw] boost
    #   @return [::Float]
    #     Strength of the condition boost, which should be in [-1, 1]. Negative
    #     boost means demotion. Default is 0.0.
    #
    #     Setting to 1.0 gives the document a big promotion. However, it does not
    #     necessarily mean that the boosted document will be the top result at
    #     all times, nor that other documents will be excluded. Results could
    #     still be shown even when none of them matches the condition. And
    #     results that are significantly more relevant to the search query can
    #     still trump your heavily favored but irrelevant documents.
    #
    #     Setting to -1.0 gives the document a big demotion. However, results
    #     that are deeply relevant might still be shown. The document will have
    #     an upstream battle to get a fairly high ranking, but it is not blocked
    #     out completely.
    #
    #     Setting to 0.0 means no boost applied. The boosting condition is
    #     ignored.
    class ConditionBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specification to determine under which conditions query expansion should
  # occur.
  # @!attribute [rw] condition
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition]
  #     The condition under which query expansion should occur. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
  class QueryExpansionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which condition query expansion should occur.
    module Condition
      # Unspecified query expansion condition. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
      CONDITION_UNSPECIFIED = 0

      # Disabled query expansion. Only the exact search query is used, even if
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#total_size SearchResponse.total_size}
      # is zero.
      DISABLED = 1

      # Automatic query expansion built by the Search API.
      AUTO = 2
    end
  end

  # The specification for query spell correction.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode]
  #     The mode under which spell correction should take effect to
  #     replace the original search query. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
  class SpellCorrectionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which mode spell correction should occur.
    module Mode
      # Unspecified spell correction mode. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
      MODE_UNSPECIFIED = 0

      # Search API will try to find a spell suggestion if there
      # is any and put in the
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#corrected_query SearchResponse.corrected_query}.
      # The spell suggestion will not be used as the search query.
      SUGGESTION_ONLY = 1

      # Automatic spell correction built by the Search API. Search will
      # be based on the corrected query if found.
      AUTO = 2
    end
  end

  # The specification that configs the desired behavior of the UCS content
  # search.
  # @!attribute [rw] snippet_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec]
  #     If there is no snippet spec provided, there will be no snippet in the
  #     search result.
  # @!attribute [rw] summary_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec]
  #     If there is no summary spec provided, there will be no summary in the
  #     search response.
  class ContentSearchSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The specification that configs the snippet in the search results.
    # @!attribute [rw] max_snippet_count
    #   @return [::Integer]
    #     Max number of snippets returned in each search result.
    #     If the matching snippets is less than the max_snippet_count, return all
    #     of the snippets; otherwise, return the max_snippet_count.
    #
    #     At most 5 snippets will be returned for each SearchResult.
    # @!attribute [rw] reference_only
    #   @return [::Boolean]
    #     if true, only snippet reference is returned.
    class SnippetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The specification that configs the summary in the search response.
    # @!attribute [rw] summary_result_count
    #   @return [::Integer]
    #     The number of top results the summary should be generated from.
    #     If the number of returned results is less than summary_result_count,
    #     then the summary would be derived from all the results; otherwise, the
    #     summary would be derived from the top results.
    #
    #     At most 5 results can be used for generating summary.
    class SummarySpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Protobuf::Value]
  class ParamsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#serving_config ⇒ ::String

Returns Required. The resource name of the Search serving config, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config. This field is used to identify the serving configuration name, set of models used to make the search.

Returns:

• (::String) —

  Required. The resource name of the Search serving config, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config. This field is used to identify the serving configuration name, set of models used to make the search.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 161

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A facet specification to perform faceted search.
  # @!attribute [rw] facet_key
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey]
  #     Required. The facet key specification.
  # @!attribute [rw] limit
  #   @return [::Integer]
  #     Maximum of facet values that should be returned for this facet. If
  #     unspecified, defaults to 20. The maximum allowed value is 300. Values
  #     above 300 will be coerced to 300.
  #
  #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
  # @!attribute [rw] excluded_filter_keys
  #   @return [::Array<::String>]
  #     List of keys to exclude when faceting.
  #
  #
  #     By default,
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     is not excluded from the filter unless it is listed in this field.
  #
  #     Listing a facet key in this field allows its values to appear as facet
  #     results, even when they are filtered out of search results. Using this
  #     field does not affect what search results are returned.
  #
  #     For example, suppose there are 100 documents with the color facet "Red"
  #     and 200 documents with the color facet "Blue". A query containing the
  #     filter "color:ANY("Red")" and having "color" as
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     would by default return only "Red" documents in the search results, and
  #     also return "Red" with count 100 as the only color facet. Although there
  #     are also blue documents available, "Blue" would not be shown as an
  #     available facet value.
  #
  #     If "color" is listed in "excludedFilterKeys", then the query returns the
  #     facet values "Red" with count 100 and "Blue" with count 200, because the
  #     "color" key is now excluded from the filter. Because this field doesn't
  #     affect search results, the search results are still correctly filtered to
  #     return only "Red" documents.
  #
  #     A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
  #     error is returned.
  # @!attribute [rw] enable_dynamic_position
  #   @return [::Boolean]
  #     Enables dynamic position for this facet. If set to true, the position of
  #     this facet among all facets in the response is determined automatically.
  #     It will be ordered together with dynamic facets if dynamic
  #     facets is enabled. If set to false, the position of this facet in the
  #     response will be the same as in the request, and it will be ranked before
  #     the facets with dynamic position enable and all dynamic facets.
  #
  #     For example, you may always want to have rating facet returned in
  #     the response, but it's not necessarily to always display the rating facet
  #     at the top. In that case, you can set enable_dynamic_position to true so
  #     that the position of rating facet in response will be determined
  #     automatically.
  #
  #     Another example, assuming you have the following facets in the request:
  #
  #     * "rating", enable_dynamic_position = true
  #
  #     * "price", enable_dynamic_position = false
  #
  #     * "brands", enable_dynamic_position = false
  #
  #     And also you have a dynamic facets enable, which will generate a facet
  #     'gender'. Then the final order of the facets in the response can be
  #     ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
  #     "rating") depends on how API orders "gender" and "rating" facets.
  #     However, notice that "price" and "brands" will always be
  #     ranked at 1st and 2nd position since their enable_dynamic_position are
  #     false.
  class FacetSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how a facet is computed.
    # @!attribute [rw] key
    #   @return [::String]
    #     Required. Supported textual and numerical facet keys in
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} object, over
    #     which the facet values are computed. Facet key is case-sensitive.
    # @!attribute [rw] intervals
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Interval>]
    #     Set only if values should be bucketized into intervals. Must be set
    #     for facets with numerical values. Must not be set for facet with text
    #     values. Maximum number of intervals is 30.
    # @!attribute [rw] restricted_values
    #   @return [::Array<::String>]
    #     Only get facet for the given restricted values. Only supported on
    #     textual fields. For example, suppose "category" has three values
    #     "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
    #     "restricted_values" to "Action > 2022", the "category" facet will only
    #     contain "Action > 2022". Only supported on textual fields. Maximum
    #     is 10.
    # @!attribute [rw] prefixes
    #   @return [::Array<::String>]
    #     Only get facet values that start with the given string prefix. For
    #     example, suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
    #     "category" facet will only contain "Action > 2022" and "Action > 2021".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] contains
    #   @return [::Array<::String>]
    #     Only get facet values that contains the given strings. For example,
    #     suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
    #     "category" facet will only contain "Action > 2022" and "Sci-Fi > 2022".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] case_insensitive
    #   @return [::Boolean]
    #     True to make facet keys case insensitive when getting faceting
    #     values with prefixes or contains; false otherwise.
    # @!attribute [rw] order_by
    #   @return [::String]
    #     The order in which documents are returned.
    #
    #     Allowed values are:
    #
    #     * "count desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
    #     descending.
    #
    #     * "value desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
    #     descending.
    #       Only applies to textual facets.
    #
    #     If not set, textual values are sorted in [natural
    #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
    #     intervals are sorted in the order given by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
    class FacetKey
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Boost specification to boost certain documents.
  # @!attribute [rw] condition_boost_specs
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec>]
  #     Condition boost specifications. If a document matches multiple conditions
  #     in the specifictions, boost scores from these specifications are all
  #     applied and combined in a non-linear way. Maximum number of
  #     specifications is 20.
  class BoostSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost applies to documents which match a condition.
    # @!attribute [rw] condition
    #   @return [::String]
    #     An expression which specifies a boost condition. The syntax and
    #     supported fields are the same as a filter expression. See
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#filter SearchRequest.filter}
    #     for detail syntax and limitations.
    #
    #     Examples:
    #
    #     * To boost documents with document ID "doc_1" or "doc_2", and
    #     color
    #       "Red" or "Blue":
    #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
    # @!attribute [rw] boost
    #   @return [::Float]
    #     Strength of the condition boost, which should be in [-1, 1]. Negative
    #     boost means demotion. Default is 0.0.
    #
    #     Setting to 1.0 gives the document a big promotion. However, it does not
    #     necessarily mean that the boosted document will be the top result at
    #     all times, nor that other documents will be excluded. Results could
    #     still be shown even when none of them matches the condition. And
    #     results that are significantly more relevant to the search query can
    #     still trump your heavily favored but irrelevant documents.
    #
    #     Setting to -1.0 gives the document a big demotion. However, results
    #     that are deeply relevant might still be shown. The document will have
    #     an upstream battle to get a fairly high ranking, but it is not blocked
    #     out completely.
    #
    #     Setting to 0.0 means no boost applied. The boosting condition is
    #     ignored.
    class ConditionBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specification to determine under which conditions query expansion should
  # occur.
  # @!attribute [rw] condition
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition]
  #     The condition under which query expansion should occur. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
  class QueryExpansionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which condition query expansion should occur.
    module Condition
      # Unspecified query expansion condition. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
      CONDITION_UNSPECIFIED = 0

      # Disabled query expansion. Only the exact search query is used, even if
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#total_size SearchResponse.total_size}
      # is zero.
      DISABLED = 1

      # Automatic query expansion built by the Search API.
      AUTO = 2
    end
  end

  # The specification for query spell correction.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode]
  #     The mode under which spell correction should take effect to
  #     replace the original search query. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
  class SpellCorrectionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which mode spell correction should occur.
    module Mode
      # Unspecified spell correction mode. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
      MODE_UNSPECIFIED = 0

      # Search API will try to find a spell suggestion if there
      # is any and put in the
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#corrected_query SearchResponse.corrected_query}.
      # The spell suggestion will not be used as the search query.
      SUGGESTION_ONLY = 1

      # Automatic spell correction built by the Search API. Search will
      # be based on the corrected query if found.
      AUTO = 2
    end
  end

  # The specification that configs the desired behavior of the UCS content
  # search.
  # @!attribute [rw] snippet_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec]
  #     If there is no snippet spec provided, there will be no snippet in the
  #     search result.
  # @!attribute [rw] summary_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec]
  #     If there is no summary spec provided, there will be no summary in the
  #     search response.
  class ContentSearchSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The specification that configs the snippet in the search results.
    # @!attribute [rw] max_snippet_count
    #   @return [::Integer]
    #     Max number of snippets returned in each search result.
    #     If the matching snippets is less than the max_snippet_count, return all
    #     of the snippets; otherwise, return the max_snippet_count.
    #
    #     At most 5 snippets will be returned for each SearchResult.
    # @!attribute [rw] reference_only
    #   @return [::Boolean]
    #     if true, only snippet reference is returned.
    class SnippetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The specification that configs the summary in the search response.
    # @!attribute [rw] summary_result_count
    #   @return [::Integer]
    #     The number of top results the summary should be generated from.
    #     If the number of returned results is less than summary_result_count,
    #     then the summary would be derived from all the results; otherwise, the
    #     summary would be derived from the top results.
    #
    #     At most 5 results can be used for generating summary.
    class SummarySpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Protobuf::Value]
  class ParamsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#spell_correction_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec

Returns The spell correction specification that specifies the mode under which spell correction will take effect.

Returns:

• (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec) —

  The spell correction specification that specifies the mode under which spell correction will take effect.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 161

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A facet specification to perform faceted search.
  # @!attribute [rw] facet_key
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey]
  #     Required. The facet key specification.
  # @!attribute [rw] limit
  #   @return [::Integer]
  #     Maximum of facet values that should be returned for this facet. If
  #     unspecified, defaults to 20. The maximum allowed value is 300. Values
  #     above 300 will be coerced to 300.
  #
  #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
  # @!attribute [rw] excluded_filter_keys
  #   @return [::Array<::String>]
  #     List of keys to exclude when faceting.
  #
  #
  #     By default,
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     is not excluded from the filter unless it is listed in this field.
  #
  #     Listing a facet key in this field allows its values to appear as facet
  #     results, even when they are filtered out of search results. Using this
  #     field does not affect what search results are returned.
  #
  #     For example, suppose there are 100 documents with the color facet "Red"
  #     and 200 documents with the color facet "Blue". A query containing the
  #     filter "color:ANY("Red")" and having "color" as
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     would by default return only "Red" documents in the search results, and
  #     also return "Red" with count 100 as the only color facet. Although there
  #     are also blue documents available, "Blue" would not be shown as an
  #     available facet value.
  #
  #     If "color" is listed in "excludedFilterKeys", then the query returns the
  #     facet values "Red" with count 100 and "Blue" with count 200, because the
  #     "color" key is now excluded from the filter. Because this field doesn't
  #     affect search results, the search results are still correctly filtered to
  #     return only "Red" documents.
  #
  #     A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
  #     error is returned.
  # @!attribute [rw] enable_dynamic_position
  #   @return [::Boolean]
  #     Enables dynamic position for this facet. If set to true, the position of
  #     this facet among all facets in the response is determined automatically.
  #     It will be ordered together with dynamic facets if dynamic
  #     facets is enabled. If set to false, the position of this facet in the
  #     response will be the same as in the request, and it will be ranked before
  #     the facets with dynamic position enable and all dynamic facets.
  #
  #     For example, you may always want to have rating facet returned in
  #     the response, but it's not necessarily to always display the rating facet
  #     at the top. In that case, you can set enable_dynamic_position to true so
  #     that the position of rating facet in response will be determined
  #     automatically.
  #
  #     Another example, assuming you have the following facets in the request:
  #
  #     * "rating", enable_dynamic_position = true
  #
  #     * "price", enable_dynamic_position = false
  #
  #     * "brands", enable_dynamic_position = false
  #
  #     And also you have a dynamic facets enable, which will generate a facet
  #     'gender'. Then the final order of the facets in the response can be
  #     ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
  #     "rating") depends on how API orders "gender" and "rating" facets.
  #     However, notice that "price" and "brands" will always be
  #     ranked at 1st and 2nd position since their enable_dynamic_position are
  #     false.
  class FacetSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how a facet is computed.
    # @!attribute [rw] key
    #   @return [::String]
    #     Required. Supported textual and numerical facet keys in
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} object, over
    #     which the facet values are computed. Facet key is case-sensitive.
    # @!attribute [rw] intervals
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Interval>]
    #     Set only if values should be bucketized into intervals. Must be set
    #     for facets with numerical values. Must not be set for facet with text
    #     values. Maximum number of intervals is 30.
    # @!attribute [rw] restricted_values
    #   @return [::Array<::String>]
    #     Only get facet for the given restricted values. Only supported on
    #     textual fields. For example, suppose "category" has three values
    #     "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
    #     "restricted_values" to "Action > 2022", the "category" facet will only
    #     contain "Action > 2022". Only supported on textual fields. Maximum
    #     is 10.
    # @!attribute [rw] prefixes
    #   @return [::Array<::String>]
    #     Only get facet values that start with the given string prefix. For
    #     example, suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
    #     "category" facet will only contain "Action > 2022" and "Action > 2021".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] contains
    #   @return [::Array<::String>]
    #     Only get facet values that contains the given strings. For example,
    #     suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
    #     "category" facet will only contain "Action > 2022" and "Sci-Fi > 2022".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] case_insensitive
    #   @return [::Boolean]
    #     True to make facet keys case insensitive when getting faceting
    #     values with prefixes or contains; false otherwise.
    # @!attribute [rw] order_by
    #   @return [::String]
    #     The order in which documents are returned.
    #
    #     Allowed values are:
    #
    #     * "count desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
    #     descending.
    #
    #     * "value desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
    #     descending.
    #       Only applies to textual facets.
    #
    #     If not set, textual values are sorted in [natural
    #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
    #     intervals are sorted in the order given by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
    class FacetKey
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Boost specification to boost certain documents.
  # @!attribute [rw] condition_boost_specs
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec>]
  #     Condition boost specifications. If a document matches multiple conditions
  #     in the specifictions, boost scores from these specifications are all
  #     applied and combined in a non-linear way. Maximum number of
  #     specifications is 20.
  class BoostSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost applies to documents which match a condition.
    # @!attribute [rw] condition
    #   @return [::String]
    #     An expression which specifies a boost condition. The syntax and
    #     supported fields are the same as a filter expression. See
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#filter SearchRequest.filter}
    #     for detail syntax and limitations.
    #
    #     Examples:
    #
    #     * To boost documents with document ID "doc_1" or "doc_2", and
    #     color
    #       "Red" or "Blue":
    #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
    # @!attribute [rw] boost
    #   @return [::Float]
    #     Strength of the condition boost, which should be in [-1, 1]. Negative
    #     boost means demotion. Default is 0.0.
    #
    #     Setting to 1.0 gives the document a big promotion. However, it does not
    #     necessarily mean that the boosted document will be the top result at
    #     all times, nor that other documents will be excluded. Results could
    #     still be shown even when none of them matches the condition. And
    #     results that are significantly more relevant to the search query can
    #     still trump your heavily favored but irrelevant documents.
    #
    #     Setting to -1.0 gives the document a big demotion. However, results
    #     that are deeply relevant might still be shown. The document will have
    #     an upstream battle to get a fairly high ranking, but it is not blocked
    #     out completely.
    #
    #     Setting to 0.0 means no boost applied. The boosting condition is
    #     ignored.
    class ConditionBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specification to determine under which conditions query expansion should
  # occur.
  # @!attribute [rw] condition
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition]
  #     The condition under which query expansion should occur. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
  class QueryExpansionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which condition query expansion should occur.
    module Condition
      # Unspecified query expansion condition. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
      CONDITION_UNSPECIFIED = 0

      # Disabled query expansion. Only the exact search query is used, even if
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#total_size SearchResponse.total_size}
      # is zero.
      DISABLED = 1

      # Automatic query expansion built by the Search API.
      AUTO = 2
    end
  end

  # The specification for query spell correction.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode]
  #     The mode under which spell correction should take effect to
  #     replace the original search query. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
  class SpellCorrectionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which mode spell correction should occur.
    module Mode
      # Unspecified spell correction mode. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
      MODE_UNSPECIFIED = 0

      # Search API will try to find a spell suggestion if there
      # is any and put in the
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#corrected_query SearchResponse.corrected_query}.
      # The spell suggestion will not be used as the search query.
      SUGGESTION_ONLY = 1

      # Automatic spell correction built by the Search API. Search will
      # be based on the corrected query if found.
      AUTO = 2
    end
  end

  # The specification that configs the desired behavior of the UCS content
  # search.
  # @!attribute [rw] snippet_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec]
  #     If there is no snippet spec provided, there will be no snippet in the
  #     search result.
  # @!attribute [rw] summary_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec]
  #     If there is no summary spec provided, there will be no summary in the
  #     search response.
  class ContentSearchSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The specification that configs the snippet in the search results.
    # @!attribute [rw] max_snippet_count
    #   @return [::Integer]
    #     Max number of snippets returned in each search result.
    #     If the matching snippets is less than the max_snippet_count, return all
    #     of the snippets; otherwise, return the max_snippet_count.
    #
    #     At most 5 snippets will be returned for each SearchResult.
    # @!attribute [rw] reference_only
    #   @return [::Boolean]
    #     if true, only snippet reference is returned.
    class SnippetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The specification that configs the summary in the search response.
    # @!attribute [rw] summary_result_count
    #   @return [::Integer]
    #     The number of top results the summary should be generated from.
    #     If the number of returned results is less than summary_result_count,
    #     then the summary would be derived from all the results; otherwise, the
    #     summary would be derived from the top results.
    #
    #     At most 5 results can be used for generating summary.
    class SummarySpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Protobuf::Value]
  class ParamsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#user_info ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::UserInfo

Returns Information about the end user. Highly recommended for analytics. The user_agent string in UserInfo will be used to deduce device_type for analytics.

Returns:

• (::Google::Cloud::DiscoveryEngine::V1beta::UserInfo) —

  Information about the end user. Highly recommended for analytics. The user_agent string in UserInfo will be used to deduce device_type for analytics.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 161

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A facet specification to perform faceted search.
  # @!attribute [rw] facet_key
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey]
  #     Required. The facet key specification.
  # @!attribute [rw] limit
  #   @return [::Integer]
  #     Maximum of facet values that should be returned for this facet. If
  #     unspecified, defaults to 20. The maximum allowed value is 300. Values
  #     above 300 will be coerced to 300.
  #
  #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
  # @!attribute [rw] excluded_filter_keys
  #   @return [::Array<::String>]
  #     List of keys to exclude when faceting.
  #
  #
  #     By default,
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     is not excluded from the filter unless it is listed in this field.
  #
  #     Listing a facet key in this field allows its values to appear as facet
  #     results, even when they are filtered out of search results. Using this
  #     field does not affect what search results are returned.
  #
  #     For example, suppose there are 100 documents with the color facet "Red"
  #     and 200 documents with the color facet "Blue". A query containing the
  #     filter "color:ANY("Red")" and having "color" as
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     would by default return only "Red" documents in the search results, and
  #     also return "Red" with count 100 as the only color facet. Although there
  #     are also blue documents available, "Blue" would not be shown as an
  #     available facet value.
  #
  #     If "color" is listed in "excludedFilterKeys", then the query returns the
  #     facet values "Red" with count 100 and "Blue" with count 200, because the
  #     "color" key is now excluded from the filter. Because this field doesn't
  #     affect search results, the search results are still correctly filtered to
  #     return only "Red" documents.
  #
  #     A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
  #     error is returned.
  # @!attribute [rw] enable_dynamic_position
  #   @return [::Boolean]
  #     Enables dynamic position for this facet. If set to true, the position of
  #     this facet among all facets in the response is determined automatically.
  #     It will be ordered together with dynamic facets if dynamic
  #     facets is enabled. If set to false, the position of this facet in the
  #     response will be the same as in the request, and it will be ranked before
  #     the facets with dynamic position enable and all dynamic facets.
  #
  #     For example, you may always want to have rating facet returned in
  #     the response, but it's not necessarily to always display the rating facet
  #     at the top. In that case, you can set enable_dynamic_position to true so
  #     that the position of rating facet in response will be determined
  #     automatically.
  #
  #     Another example, assuming you have the following facets in the request:
  #
  #     * "rating", enable_dynamic_position = true
  #
  #     * "price", enable_dynamic_position = false
  #
  #     * "brands", enable_dynamic_position = false
  #
  #     And also you have a dynamic facets enable, which will generate a facet
  #     'gender'. Then the final order of the facets in the response can be
  #     ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
  #     "rating") depends on how API orders "gender" and "rating" facets.
  #     However, notice that "price" and "brands" will always be
  #     ranked at 1st and 2nd position since their enable_dynamic_position are
  #     false.
  class FacetSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how a facet is computed.
    # @!attribute [rw] key
    #   @return [::String]
    #     Required. Supported textual and numerical facet keys in
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} object, over
    #     which the facet values are computed. Facet key is case-sensitive.
    # @!attribute [rw] intervals
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Interval>]
    #     Set only if values should be bucketized into intervals. Must be set
    #     for facets with numerical values. Must not be set for facet with text
    #     values. Maximum number of intervals is 30.
    # @!attribute [rw] restricted_values
    #   @return [::Array<::String>]
    #     Only get facet for the given restricted values. Only supported on
    #     textual fields. For example, suppose "category" has three values
    #     "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
    #     "restricted_values" to "Action > 2022", the "category" facet will only
    #     contain "Action > 2022". Only supported on textual fields. Maximum
    #     is 10.
    # @!attribute [rw] prefixes
    #   @return [::Array<::String>]
    #     Only get facet values that start with the given string prefix. For
    #     example, suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
    #     "category" facet will only contain "Action > 2022" and "Action > 2021".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] contains
    #   @return [::Array<::String>]
    #     Only get facet values that contains the given strings. For example,
    #     suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
    #     "category" facet will only contain "Action > 2022" and "Sci-Fi > 2022".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] case_insensitive
    #   @return [::Boolean]
    #     True to make facet keys case insensitive when getting faceting
    #     values with prefixes or contains; false otherwise.
    # @!attribute [rw] order_by
    #   @return [::String]
    #     The order in which documents are returned.
    #
    #     Allowed values are:
    #
    #     * "count desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
    #     descending.
    #
    #     * "value desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
    #     descending.
    #       Only applies to textual facets.
    #
    #     If not set, textual values are sorted in [natural
    #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
    #     intervals are sorted in the order given by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
    class FacetKey
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Boost specification to boost certain documents.
  # @!attribute [rw] condition_boost_specs
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec>]
  #     Condition boost specifications. If a document matches multiple conditions
  #     in the specifictions, boost scores from these specifications are all
  #     applied and combined in a non-linear way. Maximum number of
  #     specifications is 20.
  class BoostSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost applies to documents which match a condition.
    # @!attribute [rw] condition
    #   @return [::String]
    #     An expression which specifies a boost condition. The syntax and
    #     supported fields are the same as a filter expression. See
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#filter SearchRequest.filter}
    #     for detail syntax and limitations.
    #
    #     Examples:
    #
    #     * To boost documents with document ID "doc_1" or "doc_2", and
    #     color
    #       "Red" or "Blue":
    #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
    # @!attribute [rw] boost
    #   @return [::Float]
    #     Strength of the condition boost, which should be in [-1, 1]. Negative
    #     boost means demotion. Default is 0.0.
    #
    #     Setting to 1.0 gives the document a big promotion. However, it does not
    #     necessarily mean that the boosted document will be the top result at
    #     all times, nor that other documents will be excluded. Results could
    #     still be shown even when none of them matches the condition. And
    #     results that are significantly more relevant to the search query can
    #     still trump your heavily favored but irrelevant documents.
    #
    #     Setting to -1.0 gives the document a big demotion. However, results
    #     that are deeply relevant might still be shown. The document will have
    #     an upstream battle to get a fairly high ranking, but it is not blocked
    #     out completely.
    #
    #     Setting to 0.0 means no boost applied. The boosting condition is
    #     ignored.
    class ConditionBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specification to determine under which conditions query expansion should
  # occur.
  # @!attribute [rw] condition
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition]
  #     The condition under which query expansion should occur. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
  class QueryExpansionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which condition query expansion should occur.
    module Condition
      # Unspecified query expansion condition. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
      CONDITION_UNSPECIFIED = 0

      # Disabled query expansion. Only the exact search query is used, even if
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#total_size SearchResponse.total_size}
      # is zero.
      DISABLED = 1

      # Automatic query expansion built by the Search API.
      AUTO = 2
    end
  end

  # The specification for query spell correction.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode]
  #     The mode under which spell correction should take effect to
  #     replace the original search query. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
  class SpellCorrectionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which mode spell correction should occur.
    module Mode
      # Unspecified spell correction mode. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
      MODE_UNSPECIFIED = 0

      # Search API will try to find a spell suggestion if there
      # is any and put in the
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#corrected_query SearchResponse.corrected_query}.
      # The spell suggestion will not be used as the search query.
      SUGGESTION_ONLY = 1

      # Automatic spell correction built by the Search API. Search will
      # be based on the corrected query if found.
      AUTO = 2
    end
  end

  # The specification that configs the desired behavior of the UCS content
  # search.
  # @!attribute [rw] snippet_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec]
  #     If there is no snippet spec provided, there will be no snippet in the
  #     search result.
  # @!attribute [rw] summary_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec]
  #     If there is no summary spec provided, there will be no summary in the
  #     search response.
  class ContentSearchSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The specification that configs the snippet in the search results.
    # @!attribute [rw] max_snippet_count
    #   @return [::Integer]
    #     Max number of snippets returned in each search result.
    #     If the matching snippets is less than the max_snippet_count, return all
    #     of the snippets; otherwise, return the max_snippet_count.
    #
    #     At most 5 snippets will be returned for each SearchResult.
    # @!attribute [rw] reference_only
    #   @return [::Boolean]
    #     if true, only snippet reference is returned.
    class SnippetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The specification that configs the summary in the search response.
    # @!attribute [rw] summary_result_count
    #   @return [::Integer]
    #     The number of top results the summary should be generated from.
    #     If the number of returned results is less than summary_result_count,
    #     then the summary would be derived from all the results; otherwise, the
    #     summary would be derived from the top results.
    #
    #     At most 5 results can be used for generating summary.
    class SummarySpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Protobuf::Value]
  class ParamsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#user_labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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 for more details.

Returns:

• (::Google::Protobuf::Map{::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 for more details.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 161

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A facet specification to perform faceted search.
  # @!attribute [rw] facet_key
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey]
  #     Required. The facet key specification.
  # @!attribute [rw] limit
  #   @return [::Integer]
  #     Maximum of facet values that should be returned for this facet. If
  #     unspecified, defaults to 20. The maximum allowed value is 300. Values
  #     above 300 will be coerced to 300.
  #
  #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
  # @!attribute [rw] excluded_filter_keys
  #   @return [::Array<::String>]
  #     List of keys to exclude when faceting.
  #
  #
  #     By default,
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     is not excluded from the filter unless it is listed in this field.
  #
  #     Listing a facet key in this field allows its values to appear as facet
  #     results, even when they are filtered out of search results. Using this
  #     field does not affect what search results are returned.
  #
  #     For example, suppose there are 100 documents with the color facet "Red"
  #     and 200 documents with the color facet "Blue". A query containing the
  #     filter "color:ANY("Red")" and having "color" as
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     would by default return only "Red" documents in the search results, and
  #     also return "Red" with count 100 as the only color facet. Although there
  #     are also blue documents available, "Blue" would not be shown as an
  #     available facet value.
  #
  #     If "color" is listed in "excludedFilterKeys", then the query returns the
  #     facet values "Red" with count 100 and "Blue" with count 200, because the
  #     "color" key is now excluded from the filter. Because this field doesn't
  #     affect search results, the search results are still correctly filtered to
  #     return only "Red" documents.
  #
  #     A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
  #     error is returned.
  # @!attribute [rw] enable_dynamic_position
  #   @return [::Boolean]
  #     Enables dynamic position for this facet. If set to true, the position of
  #     this facet among all facets in the response is determined automatically.
  #     It will be ordered together with dynamic facets if dynamic
  #     facets is enabled. If set to false, the position of this facet in the
  #     response will be the same as in the request, and it will be ranked before
  #     the facets with dynamic position enable and all dynamic facets.
  #
  #     For example, you may always want to have rating facet returned in
  #     the response, but it's not necessarily to always display the rating facet
  #     at the top. In that case, you can set enable_dynamic_position to true so
  #     that the position of rating facet in response will be determined
  #     automatically.
  #
  #     Another example, assuming you have the following facets in the request:
  #
  #     * "rating", enable_dynamic_position = true
  #
  #     * "price", enable_dynamic_position = false
  #
  #     * "brands", enable_dynamic_position = false
  #
  #     And also you have a dynamic facets enable, which will generate a facet
  #     'gender'. Then the final order of the facets in the response can be
  #     ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
  #     "rating") depends on how API orders "gender" and "rating" facets.
  #     However, notice that "price" and "brands" will always be
  #     ranked at 1st and 2nd position since their enable_dynamic_position are
  #     false.
  class FacetSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how a facet is computed.
    # @!attribute [rw] key
    #   @return [::String]
    #     Required. Supported textual and numerical facet keys in
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} object, over
    #     which the facet values are computed. Facet key is case-sensitive.
    # @!attribute [rw] intervals
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Interval>]
    #     Set only if values should be bucketized into intervals. Must be set
    #     for facets with numerical values. Must not be set for facet with text
    #     values. Maximum number of intervals is 30.
    # @!attribute [rw] restricted_values
    #   @return [::Array<::String>]
    #     Only get facet for the given restricted values. Only supported on
    #     textual fields. For example, suppose "category" has three values
    #     "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
    #     "restricted_values" to "Action > 2022", the "category" facet will only
    #     contain "Action > 2022". Only supported on textual fields. Maximum
    #     is 10.
    # @!attribute [rw] prefixes
    #   @return [::Array<::String>]
    #     Only get facet values that start with the given string prefix. For
    #     example, suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
    #     "category" facet will only contain "Action > 2022" and "Action > 2021".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] contains
    #   @return [::Array<::String>]
    #     Only get facet values that contains the given strings. For example,
    #     suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
    #     "category" facet will only contain "Action > 2022" and "Sci-Fi > 2022".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] case_insensitive
    #   @return [::Boolean]
    #     True to make facet keys case insensitive when getting faceting
    #     values with prefixes or contains; false otherwise.
    # @!attribute [rw] order_by
    #   @return [::String]
    #     The order in which documents are returned.
    #
    #     Allowed values are:
    #
    #     * "count desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
    #     descending.
    #
    #     * "value desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
    #     descending.
    #       Only applies to textual facets.
    #
    #     If not set, textual values are sorted in [natural
    #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
    #     intervals are sorted in the order given by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
    class FacetKey
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Boost specification to boost certain documents.
  # @!attribute [rw] condition_boost_specs
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec>]
  #     Condition boost specifications. If a document matches multiple conditions
  #     in the specifictions, boost scores from these specifications are all
  #     applied and combined in a non-linear way. Maximum number of
  #     specifications is 20.
  class BoostSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost applies to documents which match a condition.
    # @!attribute [rw] condition
    #   @return [::String]
    #     An expression which specifies a boost condition. The syntax and
    #     supported fields are the same as a filter expression. See
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#filter SearchRequest.filter}
    #     for detail syntax and limitations.
    #
    #     Examples:
    #
    #     * To boost documents with document ID "doc_1" or "doc_2", and
    #     color
    #       "Red" or "Blue":
    #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
    # @!attribute [rw] boost
    #   @return [::Float]
    #     Strength of the condition boost, which should be in [-1, 1]. Negative
    #     boost means demotion. Default is 0.0.
    #
    #     Setting to 1.0 gives the document a big promotion. However, it does not
    #     necessarily mean that the boosted document will be the top result at
    #     all times, nor that other documents will be excluded. Results could
    #     still be shown even when none of them matches the condition. And
    #     results that are significantly more relevant to the search query can
    #     still trump your heavily favored but irrelevant documents.
    #
    #     Setting to -1.0 gives the document a big demotion. However, results
    #     that are deeply relevant might still be shown. The document will have
    #     an upstream battle to get a fairly high ranking, but it is not blocked
    #     out completely.
    #
    #     Setting to 0.0 means no boost applied. The boosting condition is
    #     ignored.
    class ConditionBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specification to determine under which conditions query expansion should
  # occur.
  # @!attribute [rw] condition
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition]
  #     The condition under which query expansion should occur. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
  class QueryExpansionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which condition query expansion should occur.
    module Condition
      # Unspecified query expansion condition. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
      CONDITION_UNSPECIFIED = 0

      # Disabled query expansion. Only the exact search query is used, even if
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#total_size SearchResponse.total_size}
      # is zero.
      DISABLED = 1

      # Automatic query expansion built by the Search API.
      AUTO = 2
    end
  end

  # The specification for query spell correction.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode]
  #     The mode under which spell correction should take effect to
  #     replace the original search query. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
  class SpellCorrectionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which mode spell correction should occur.
    module Mode
      # Unspecified spell correction mode. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
      MODE_UNSPECIFIED = 0

      # Search API will try to find a spell suggestion if there
      # is any and put in the
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#corrected_query SearchResponse.corrected_query}.
      # The spell suggestion will not be used as the search query.
      SUGGESTION_ONLY = 1

      # Automatic spell correction built by the Search API. Search will
      # be based on the corrected query if found.
      AUTO = 2
    end
  end

  # The specification that configs the desired behavior of the UCS content
  # search.
  # @!attribute [rw] snippet_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec]
  #     If there is no snippet spec provided, there will be no snippet in the
  #     search result.
  # @!attribute [rw] summary_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec]
  #     If there is no summary spec provided, there will be no summary in the
  #     search response.
  class ContentSearchSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The specification that configs the snippet in the search results.
    # @!attribute [rw] max_snippet_count
    #   @return [::Integer]
    #     Max number of snippets returned in each search result.
    #     If the matching snippets is less than the max_snippet_count, return all
    #     of the snippets; otherwise, return the max_snippet_count.
    #
    #     At most 5 snippets will be returned for each SearchResult.
    # @!attribute [rw] reference_only
    #   @return [::Boolean]
    #     if true, only snippet reference is returned.
    class SnippetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The specification that configs the summary in the search response.
    # @!attribute [rw] summary_result_count
    #   @return [::Integer]
    #     The number of top results the summary should be generated from.
    #     If the number of returned results is less than summary_result_count,
    #     then the summary would be derived from all the results; otherwise, the
    #     summary would be derived from the top results.
    #
    #     At most 5 results can be used for generating summary.
    class SummarySpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Protobuf::Value]
  class ParamsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#user_pseudo_id ⇒ ::String

Returns 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 UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id

The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Returns:

• (::String) —

  A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website.

  This field should NOT have a fixed value such as unknown_visitor.

  This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id

  The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 161

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A facet specification to perform faceted search.
  # @!attribute [rw] facet_key
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey]
  #     Required. The facet key specification.
  # @!attribute [rw] limit
  #   @return [::Integer]
  #     Maximum of facet values that should be returned for this facet. If
  #     unspecified, defaults to 20. The maximum allowed value is 300. Values
  #     above 300 will be coerced to 300.
  #
  #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
  # @!attribute [rw] excluded_filter_keys
  #   @return [::Array<::String>]
  #     List of keys to exclude when faceting.
  #
  #
  #     By default,
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     is not excluded from the filter unless it is listed in this field.
  #
  #     Listing a facet key in this field allows its values to appear as facet
  #     results, even when they are filtered out of search results. Using this
  #     field does not affect what search results are returned.
  #
  #     For example, suppose there are 100 documents with the color facet "Red"
  #     and 200 documents with the color facet "Blue". A query containing the
  #     filter "color:ANY("Red")" and having "color" as
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
  #     would by default return only "Red" documents in the search results, and
  #     also return "Red" with count 100 as the only color facet. Although there
  #     are also blue documents available, "Blue" would not be shown as an
  #     available facet value.
  #
  #     If "color" is listed in "excludedFilterKeys", then the query returns the
  #     facet values "Red" with count 100 and "Blue" with count 200, because the
  #     "color" key is now excluded from the filter. Because this field doesn't
  #     affect search results, the search results are still correctly filtered to
  #     return only "Red" documents.
  #
  #     A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
  #     error is returned.
  # @!attribute [rw] enable_dynamic_position
  #   @return [::Boolean]
  #     Enables dynamic position for this facet. If set to true, the position of
  #     this facet among all facets in the response is determined automatically.
  #     It will be ordered together with dynamic facets if dynamic
  #     facets is enabled. If set to false, the position of this facet in the
  #     response will be the same as in the request, and it will be ranked before
  #     the facets with dynamic position enable and all dynamic facets.
  #
  #     For example, you may always want to have rating facet returned in
  #     the response, but it's not necessarily to always display the rating facet
  #     at the top. In that case, you can set enable_dynamic_position to true so
  #     that the position of rating facet in response will be determined
  #     automatically.
  #
  #     Another example, assuming you have the following facets in the request:
  #
  #     * "rating", enable_dynamic_position = true
  #
  #     * "price", enable_dynamic_position = false
  #
  #     * "brands", enable_dynamic_position = false
  #
  #     And also you have a dynamic facets enable, which will generate a facet
  #     'gender'. Then the final order of the facets in the response can be
  #     ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
  #     "rating") depends on how API orders "gender" and "rating" facets.
  #     However, notice that "price" and "brands" will always be
  #     ranked at 1st and 2nd position since their enable_dynamic_position are
  #     false.
  class FacetSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Specifies how a facet is computed.
    # @!attribute [rw] key
    #   @return [::String]
    #     Required. Supported textual and numerical facet keys in
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} object, over
    #     which the facet values are computed. Facet key is case-sensitive.
    # @!attribute [rw] intervals
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Interval>]
    #     Set only if values should be bucketized into intervals. Must be set
    #     for facets with numerical values. Must not be set for facet with text
    #     values. Maximum number of intervals is 30.
    # @!attribute [rw] restricted_values
    #   @return [::Array<::String>]
    #     Only get facet for the given restricted values. Only supported on
    #     textual fields. For example, suppose "category" has three values
    #     "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set
    #     "restricted_values" to "Action > 2022", the "category" facet will only
    #     contain "Action > 2022". Only supported on textual fields. Maximum
    #     is 10.
    # @!attribute [rw] prefixes
    #   @return [::Array<::String>]
    #     Only get facet values that start with the given string prefix. For
    #     example, suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the
    #     "category" facet will only contain "Action > 2022" and "Action > 2021".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] contains
    #   @return [::Array<::String>]
    #     Only get facet values that contains the given strings. For example,
    #     suppose "category" has three values "Action > 2022",
    #     "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
    #     "category" facet will only contain "Action > 2022" and "Sci-Fi > 2022".
    #     Only supported on textual fields. Maximum is 10.
    # @!attribute [rw] case_insensitive
    #   @return [::Boolean]
    #     True to make facet keys case insensitive when getting faceting
    #     values with prefixes or contains; false otherwise.
    # @!attribute [rw] order_by
    #   @return [::String]
    #     The order in which documents are returned.
    #
    #     Allowed values are:
    #
    #     * "count desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
    #     descending.
    #
    #     * "value desc", which means order by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
    #     descending.
    #       Only applies to textual facets.
    #
    #     If not set, textual values are sorted in [natural
    #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
    #     intervals are sorted in the order given by
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
    class FacetKey
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Boost specification to boost certain documents.
  # @!attribute [rw] condition_boost_specs
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec>]
  #     Condition boost specifications. If a document matches multiple conditions
  #     in the specifictions, boost scores from these specifications are all
  #     applied and combined in a non-linear way. Maximum number of
  #     specifications is 20.
  class BoostSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost applies to documents which match a condition.
    # @!attribute [rw] condition
    #   @return [::String]
    #     An expression which specifies a boost condition. The syntax and
    #     supported fields are the same as a filter expression. See
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#filter SearchRequest.filter}
    #     for detail syntax and limitations.
    #
    #     Examples:
    #
    #     * To boost documents with document ID "doc_1" or "doc_2", and
    #     color
    #       "Red" or "Blue":
    #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
    # @!attribute [rw] boost
    #   @return [::Float]
    #     Strength of the condition boost, which should be in [-1, 1]. Negative
    #     boost means demotion. Default is 0.0.
    #
    #     Setting to 1.0 gives the document a big promotion. However, it does not
    #     necessarily mean that the boosted document will be the top result at
    #     all times, nor that other documents will be excluded. Results could
    #     still be shown even when none of them matches the condition. And
    #     results that are significantly more relevant to the search query can
    #     still trump your heavily favored but irrelevant documents.
    #
    #     Setting to -1.0 gives the document a big demotion. However, results
    #     that are deeply relevant might still be shown. The document will have
    #     an upstream battle to get a fairly high ranking, but it is not blocked
    #     out completely.
    #
    #     Setting to 0.0 means no boost applied. The boosting condition is
    #     ignored.
    class ConditionBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Specification to determine under which conditions query expansion should
  # occur.
  # @!attribute [rw] condition
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition]
  #     The condition under which query expansion should occur. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
  class QueryExpansionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which condition query expansion should occur.
    module Condition
      # Unspecified query expansion condition. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
      CONDITION_UNSPECIFIED = 0

      # Disabled query expansion. Only the exact search query is used, even if
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#total_size SearchResponse.total_size}
      # is zero.
      DISABLED = 1

      # Automatic query expansion built by the Search API.
      AUTO = 2
    end
  end

  # The specification for query spell correction.
  # @!attribute [rw] mode
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode]
  #     The mode under which spell correction should take effect to
  #     replace the original search query. Default to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
  class SpellCorrectionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Enum describing under which mode spell correction should occur.
    module Mode
      # Unspecified spell correction mode. In this case, server behavior
      # defaults to
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
      MODE_UNSPECIFIED = 0

      # Search API will try to find a spell suggestion if there
      # is any and put in the
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#corrected_query SearchResponse.corrected_query}.
      # The spell suggestion will not be used as the search query.
      SUGGESTION_ONLY = 1

      # Automatic spell correction built by the Search API. Search will
      # be based on the corrected query if found.
      AUTO = 2
    end
  end

  # The specification that configs the desired behavior of the UCS content
  # search.
  # @!attribute [rw] snippet_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec]
  #     If there is no snippet spec provided, there will be no snippet in the
  #     search result.
  # @!attribute [rw] summary_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec]
  #     If there is no summary spec provided, there will be no summary in the
  #     search response.
  class ContentSearchSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The specification that configs the snippet in the search results.
    # @!attribute [rw] max_snippet_count
    #   @return [::Integer]
    #     Max number of snippets returned in each search result.
    #     If the matching snippets is less than the max_snippet_count, return all
    #     of the snippets; otherwise, return the max_snippet_count.
    #
    #     At most 5 snippets will be returned for each SearchResult.
    # @!attribute [rw] reference_only
    #   @return [::Boolean]
    #     if true, only snippet reference is returned.
    class SnippetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The specification that configs the summary in the search response.
    # @!attribute [rw] summary_result_count
    #   @return [::Integer]
    #     The number of top results the summary should be generated from.
    #     If the number of returned results is less than summary_result_count,
    #     then the summary would be derived from all the results; otherwise, the
    #     summary would be derived from the top results.
    #
    #     At most 5 results can be used for generating summary.
    class SummarySpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Protobuf::Value]
  class ParamsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end