google-cloud-discovery_engine-v1 0.a → 0.2.0

data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb

@@ -0,0 +1,730 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module DiscoveryEngine
+      module V1
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
+        # method.
+        # @!attribute [rw] serving_config
+        #   @return [::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.
+        # @!attribute [rw] branch
+        #   @return [::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.
+        # @!attribute [rw] query
+        #   @return [::String]
+        #     Raw search query.
+        # @!attribute [rw] image_query
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ImageQuery]
+        #     Raw image query.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Maximum number of {::Google::Cloud::DiscoveryEngine::V1::Document Document}s to
+        #     return. If unspecified, defaults to a reasonable value. The maximum allowed
+        #     value is 100. Values above 100 are coerced to 100.
+        #
+        #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A page token received from a previous
+        #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
+        #     call. Provide this to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to
+        #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
+        #     must match the call that provided the page token. Otherwise, an
+        #      `INVALID_ARGUMENT`  error is returned.
+        # @!attribute [rw] offset
+        #   @return [::Integer]
+        #     A 0-indexed integer that specifies the current offset (that is, starting
+        #     result location, amongst the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}s deemed by the API as
+        #     relevant) in search results. This field is only considered if
+        #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#page_token page_token} is
+        #     unset.
+        #
+        #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+        # @!attribute [rw] filter
+        #   @return [::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.
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     The order in which documents are returned. Documents can be ordered by
+        #     a field in an {::Google::Cloud::DiscoveryEngine::V1::Document Document} object.
+        #     Leave it unset if ordered by relevance. `order_by` expression is
+        #     case-sensitive.
+        #
+        #     If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+        # @!attribute [rw] user_info
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::UserInfo]
+        #     Information about the end user.
+        #     Highly recommended for analytics.
+        #     {::Google::Cloud::DiscoveryEngine::V1::UserInfo#user_agent UserInfo.user_agent}
+        #     is used to deduce `device_type` for analytics.
+        # @!attribute [rw] facet_specs
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::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.
+        # @!attribute [rw] boost_spec
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec]
+        #     Boost specification to boost certain documents.
+        # @!attribute [rw] params
+        #   @return [::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.
+        # @!attribute [rw] query_expansion_spec
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::QueryExpansionSpec]
+        #     The query expansion specification that specifies the conditions under which
+        #     query expansion occurs.
+        # @!attribute [rw] spell_correction_spec
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::SpellCorrectionSpec]
+        #     The spell correction specification that specifies the mode under
+        #     which spell correction takes effect.
+        # @!attribute [rw] user_pseudo_id
+        #   @return [::String]
+        #     A unique identifier for tracking visitors. For example, this could be
+        #     implemented with an HTTP cookie, which should be able to uniquely identify
+        #     a visitor on a single device. This unique identifier should not change if
+        #     the visitor logs in or out of the website.
+        #
+        #     This field should NOT have a fixed value such as `unknown_visitor`.
+        #
+        #     This should be the same identifier as
+        #     {::Google::Cloud::DiscoveryEngine::V1::UserEvent#user_pseudo_id UserEvent.user_pseudo_id}
+        #     and
+        #     {::Google::Cloud::DiscoveryEngine::V1::CompleteQueryRequest#user_pseudo_id 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.
+        # @!attribute [rw] content_search_spec
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec]
+        #     A specification for configuring the behavior of content search.
+        # @!attribute [rw] safe_search
+        #   @return [::Boolean]
+        #     Whether to turn on safe search. This is only supported for
+        #     website search.
+        # @!attribute [rw] user_labels
+        #   @return [::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](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+        #     for more details.
+        class SearchRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Specifies the image query input.
+          # @!attribute [rw] image_bytes
+          #   @return [::String]
+          #     Base64 encoded image bytes. Supported image formats: JPEG, PNG, and
+          #     BMP.
+          class ImageQuery
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A facet specification to perform faceted search.
+          # @!attribute [rw] facet_key
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::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 are 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::V1::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::V1::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.
+          #     If dynamic facets are enabled, it is ordered together.
+          #     If set to false, the position of this facet in the
+          #     response is the same as in the request, and it is 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 is 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 enabled, which generates 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" are always
+          #     ranked at first and second position because their enable_dynamic_position
+          #     is 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::V1::Document Document} object, over which
+            #     the facet values are computed. Facet key is case-sensitive.
+            # @!attribute [rw] intervals
+            #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Interval>]
+            #     Set only if values should be bucketed 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 only
+            #     contains "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 only contains "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 only contains "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::V1::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
+            #     descending.
+            #
+            #     * "value desc", which means order by
+            #     {::Google::Cloud::DiscoveryEngine::V1::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::V1::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::V1::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::V1::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::V1::SearchRequest::QueryExpansionSpec::Condition]
+          #     The condition under which query expansion should occur. Default to
+          #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
+          # @!attribute [rw] pin_unexpanded_results
+          #   @return [::Boolean]
+          #     Whether to pin unexpanded results. If this field is set to true,
+          #     unexpanded products are always at the top of the search results, followed
+          #     by the expanded results.
+          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::V1::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
+              CONDITION_UNSPECIFIED = 0
+
+              # Disabled query expansion. Only the exact search query is used, even if
+              # {::Google::Cloud::DiscoveryEngine::V1::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::V1::SearchRequest::SpellCorrectionSpec::Mode]
+          #     The mode under which spell correction should take effect to
+          #     replace the original search query. Default to
+          #     {::Google::Cloud::DiscoveryEngine::V1::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::V1::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::V1::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
+
+          # A specification for configuring the behavior of content search.
+          # @!attribute [rw] snippet_spec
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SnippetSpec]
+          #     If `snippetSpec` is not specified, snippets are not included in the
+          #     search response.
+          # @!attribute [rw] summary_spec
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec]
+          #     If `summarySpec` is not specified, summaries are not included in the
+          #     search response.
+          class ContentSearchSpec
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # A specification for configuring snippets in a search response.
+            # @!attribute [rw] max_snippet_count
+            #   @return [::Integer]
+            #     [DEPRECATED] This field is deprecated. To control snippet return, use
+            #     `return_snippet` field. For backwards compatibility, we will return
+            #     snippet if max_snippet_count > 0.
+            # @!attribute [rw] reference_only
+            #   @return [::Boolean]
+            #     [DEPRECATED] This field is deprecated and will have no affect on the
+            #     snippet.
+            # @!attribute [rw] return_snippet
+            #   @return [::Boolean]
+            #     If `true`, then return snippet. If no snippet can be generated, we
+            #     return "No snippet is available for this page." A `snippet_status` with
+            #     `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+            class SnippetSpec
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # A specification for configuring a summary returned in a search
+            # response.
+            # @!attribute [rw] summary_result_count
+            #   @return [::Integer]
+            #     The number of top results to generate the summary from. If the number
+            #     of results returned is less than `summaryResultCount`, the summary is
+            #     generated from all of the results.
+            #
+            #     At most five results can be used to generate a summary.
+            # @!attribute [rw] include_citations
+            #   @return [::Boolean]
+            #     Specifies whether to include citations in the summary. The default
+            #     value is `false`.
+            #
+            #     When this field is set to `true`, summaries include in-line citation
+            #     numbers.
+            #
+            #     Example summary including citations:
+            #
+            #     BigQuery is Google Cloud's fully managed and completely serverless
+            #     enterprise data warehouse [1]. BigQuery supports all data types, works
+            #     across clouds, and has built-in machine learning and business
+            #     intelligence, all within a unified platform [2, 3].
+            #
+            #     The citation numbers refer to the returned search results and are
+            #     1-indexed. For example, [1] means that the sentence is attributed to
+            #     the first search result. [2, 3] means that the sentence is attributed
+            #     to both the second and third search results.
+            # @!attribute [rw] ignore_adversarial_query
+            #   @return [::Boolean]
+            #     Specifies whether to filter out adversarial queries. The default value
+            #     is `false`.
+            #
+            #     Google employs search-query classification to detect adversarial
+            #     queries. No summary is returned if the search query is classified as an
+            #     adversarial query. For example, a user might ask a question regarding
+            #     negative comments about the company or submit a query designed to
+            #     generate unsafe, policy-violating output. If this field is set to
+            #     `true`, we skip generating summaries for adversarial queries and return
+            #     fallback messages instead.
+            # @!attribute [rw] ignore_non_summary_seeking_query
+            #   @return [::Boolean]
+            #     Specifies whether to filter out queries that are not summary-seeking.
+            #     The default value is `false`.
+            #
+            #     Google employs search-query classification to detect summary-seeking
+            #     queries. No summary is returned if the search query is classified as a
+            #     non-summary seeking query. For example, `why is the sky blue` and `Who
+            #     is the best soccer player in the world?` are summary-seeking queries,
+            #     but `SFO airport` and `world cup 2026` are not. They are most likely
+            #     navigational queries. If this field is set to `true`, we skip
+            #     generating summaries for non-summary seeking queries and return
+            #     fallback messages instead.
+            # @!attribute [rw] language_code
+            #   @return [::String]
+            #     Language code for Summary. Use language tags defined by
+            #     [BCP47][https://www.rfc-editor.org/rfc/bcp/bcp47.txt].
+            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
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
+        # method.
+        # @!attribute [rw] results
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult>]
+        #     A list of matched documents. The order represents the ranking.
+        # @!attribute [rw] facets
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Facet>]
+        #     Results of facets requested by user.
+        # @!attribute [rw] total_size
+        #   @return [::Integer]
+        #     The estimated total count of matched items irrespective of pagination. The
+        #     count of {::Google::Cloud::DiscoveryEngine::V1::SearchResponse#results results}
+        #     returned by pagination may be less than the
+        #     {::Google::Cloud::DiscoveryEngine::V1::SearchResponse#total_size total_size}
+        #     that matches.
+        # @!attribute [rw] attribution_token
+        #   @return [::String]
+        #     A unique search token. This should be included in the
+        #     {::Google::Cloud::DiscoveryEngine::V1::UserEvent UserEvent} logs resulting from
+        #     this search, which enables accurate attribution of search model
+        #     performance.
+        # @!attribute [rw] redirect_uri
+        #   @return [::String]
+        #     The URI of a customer-defined redirect page. If redirect action is
+        #     triggered, no search is performed, and only
+        #     {::Google::Cloud::DiscoveryEngine::V1::SearchResponse#redirect_uri redirect_uri}
+        #     and
+        #     {::Google::Cloud::DiscoveryEngine::V1::SearchResponse#attribution_token attribution_token}
+        #     are set in the response.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token that can be sent as
+        #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#page_token SearchRequest.page_token}
+        #     to retrieve the next page. If this field is omitted, there are no
+        #     subsequent pages.
+        # @!attribute [rw] corrected_query
+        #   @return [::String]
+        #     Contains the spell corrected query, if found. If the spell correction type
+        #     is AUTOMATIC, then the search results are based on corrected_query.
+        #     Otherwise the original query is used for search.
+        # @!attribute [rw] summary
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary]
+        #     A summary as part of the search results.
+        #     This field is only returned if
+        #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec#summary_spec SearchRequest.ContentSearchSpec.summary_spec}
+        #     is set.
+        # @!attribute [rw] query_expansion_info
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchResponse::QueryExpansionInfo]
+        #     Query expansion information for the returned results.
+        class SearchResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Represents the search results.
+          # @!attribute [rw] id
+          #   @return [::String]
+          #     {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id} of the
+          #     searched {::Google::Cloud::DiscoveryEngine::V1::Document Document}.
+          # @!attribute [rw] document
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::Document]
+          #     The document data snippet in the search response. Only fields that are
+          #     marked as retrievable are populated.
+          class SearchResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A facet result.
+          # @!attribute [rw] key
+          #   @return [::String]
+          #     The key for this facet. E.g., "colors" or "price". It matches
+          #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::FacetSpec::FacetKey#key SearchRequest.FacetSpec.FacetKey.key}.
+          # @!attribute [rw] values
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Facet::FacetValue>]
+          #     The facet values for this field.
+          # @!attribute [rw] dynamic_facet
+          #   @return [::Boolean]
+          #     Whether the facet is dynamically generated.
+          class Facet
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # A facet value which contains value names and their count.
+            # @!attribute [rw] value
+            #   @return [::String]
+            #     Text value of a facet, such as "Black" for facet "colors".
+            # @!attribute [rw] interval
+            #   @return [::Google::Cloud::DiscoveryEngine::V1::Interval]
+            #     Interval value for a facet, such as [10, 20) for facet "price". It
+            #     matches
+            #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::FacetSpec::FacetKey#intervals SearchRequest.FacetSpec.FacetKey.intervals}.
+            # @!attribute [rw] count
+            #   @return [::Integer]
+            #     Number of items that have this facet value.
+            class FacetValue
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Summary of the top N search result specified by the summary spec.
+          # @!attribute [rw] summary_text
+          #   @return [::String]
+          #     The summary content.
+          # @!attribute [rw] summary_skipped_reasons
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SummarySkippedReason>]
+          #     Additional summary-skipped reasons. This provides the reason for ignored
+          #     cases. If nothing is skipped, this field is not set.
+          # @!attribute [rw] safety_attributes
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SafetyAttributes]
+          #     A collection of Safety Attribute categories and their associated
+          #     confidence scores.
+          class Summary
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Safety Attribute categories and their associated confidence scores.
+            # @!attribute [rw] categories
+            #   @return [::Array<::String>]
+            #     The display names of Safety Attribute categories associated with the
+            #     generated content. Order matches the Scores.
+            # @!attribute [rw] scores
+            #   @return [::Array<::Float>]
+            #     The confidence scores of the each category, higher
+            #     value means higher confidence. Order matches the Categories.
+            class SafetyAttributes
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # An Enum for summary-skipped reasons.
+            module SummarySkippedReason
+              # Default value. The summary skipped reason is not specified.
+              SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0
+
+              # The adversarial query ignored case.
+              #
+              # Only populated when
+              # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
+              # is set to `true`.
+              ADVERSARIAL_QUERY_IGNORED = 1
+
+              # The non-summary seeking query ignored case.
+              #
+              # Only populated when
+              # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
+              # is set to `true`.
+              NON_SUMMARY_SEEKING_QUERY_IGNORED = 2
+
+              # The out-of-domain query ignored case.
+              #
+              # Google skips the summary if there are no high-relevance search results.
+              # For example, the data store contains facts about company A but the
+              # user query is asking questions about company B.
+              OUT_OF_DOMAIN_QUERY_IGNORED = 3
+
+              # The potential policy violation case.
+              #
+              # Google skips the summary if there is a potential policy violation
+              # detected. This includes content that may be violent or toxic.
+              POTENTIAL_POLICY_VIOLATION = 4
+
+              # The LLM addon not enabled case.
+              #
+              # Google skips the summary if the LLM addon is not enabled.
+              LLM_ADDON_NOT_ENABLED = 5
+            end
+          end
+
+          # Information describing query expansion including whether expansion has
+          # occurred.
+          # @!attribute [rw] expanded_query
+          #   @return [::Boolean]
+          #     Bool describing whether query expansion has occurred.
+          # @!attribute [rw] pinned_result_count
+          #   @return [::Integer]
+          #     Number of pinned results. This field will only be set when expansion
+          #     happens and
+          #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::QueryExpansionSpec#pin_unexpanded_results SearchRequest.QueryExpansionSpec.pin_unexpanded_results}
+          #     is set to true.
+          class QueryExpansionInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end