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

Inherits:

Object

Object
Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb

Overview

A specification for configuring the behavior of content search.

Defined Under Namespace

Modules: SearchResultMode Classes: ChunkSpec, ExtractiveContentSpec, SnippetSpec, SummarySpec

Instance Attribute Summary collapse

#chunk_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::ChunkSpec
Specifies the chunk spec to be returned from the search response.
#extractive_content_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::ExtractiveContentSpec
If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
#search_result_mode ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode
Specifies the search result mode.
#snippet_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec
If snippetSpec is not specified, snippets are not included in the search response.
#summary_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec
If summarySpec is not specified, summaries are not included in the search response.

Instance Attribute Details

#chunk_spec ⇒ `::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::ChunkSpec`

Returns Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.

Returns:

(::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::ChunkSpec) —
Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS

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

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
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @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
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @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 10 results for documents mode, or 50 for chunks mode, can be
  #     used to generate a summary. The chunks mode is used when
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
  # @!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] ignore_low_relevant_content
  #   @return [::Boolean]
  #     Specifies whether to filter out queries that have low relevance. The
  #     default value is `false`.
  #
  #     If this field is set to `false`, all search results are used regardless
  #     of relevance to generate answers. If set to `true`, only queries with
  #     high relevance search results will generate answers.
  # @!attribute [rw] ignore_jail_breaking_query
  #   @return [::Boolean]
  #     Optional. Specifies whether to filter out jail-breaking queries. The
  #     default value is `false`.
  #
  #     Google employs search-query classification to detect jail-breaking
  #     queries. No summary is returned if the search query is classified as a
  #     jail-breaking query. A user might add instructions to the query to
  #     change the tone, style, language, content of the answer, or ask the
  #     model to act as a different entity, e.g. "Reply in the tone of a
  #     competing company's CEO". If this field is set to `true`, we skip
  #     generating summaries for jail-breaking queries and return fallback
  #     messages instead.
  # @!attribute [rw] multimodal_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::MultiModalSpec]
  #     Optional. Multimodal specification.
  # @!attribute [rw] model_prompt_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::ModelPromptSpec]
  #     If specified, the spec will be used to modify the prompt provided to
  #     the LLM.
  # @!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).
  #     Note: This is an experimental feature.
  # @!attribute [rw] model_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::ModelSpec]
  #     If specified, the spec will be used to modify the model specification
  #     provided to the LLM.
  # @!attribute [rw] use_semantic_chunks
  #   @return [::Boolean]
  #     If true, answer will be generated from most relevant chunks from top
  #     search results. This feature will improve summary quality.
  #     Note that with this feature enabled, not all top search results
  #     will be referenced and included in the reference list, so the citation
  #     source index only points to the search results listed in the reference
  #     list.
  class SummarySpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Multimodal specification: Will return an image from specified source.
    # If multiple sources are specified, the pick is a quality based
    # decision.
    # @!attribute [rw] image_source
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::MultiModalSpec::ImageSource]
    #     Optional. Source of image returned in the answer.
    class MultiModalSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Specifies the image source.
      module ImageSource
        # Unspecified image source (multimodal feature is disabled by
        # default).
        IMAGE_SOURCE_UNSPECIFIED = 0

        # Behavior when service determines the pick from all available
        # sources.
        ALL_AVAILABLE_SOURCES = 1

        # Includes image from corpus in the answer.
        CORPUS_IMAGE_ONLY = 2

        # Triggers figure generation in the answer.
        FIGURE_GENERATION_ONLY = 3
      end
    end

    # Specification of the prompt to use with the model.
    # @!attribute [rw] preamble
    #   @return [::String]
    #     Text at the beginning of the prompt that instructs the assistant.
    #     Examples are available in the user guide.
    class ModelPromptSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specification of the model.
    # @!attribute [rw] version
    #   @return [::String]
    #     The model version used to generate the summary.
    #
    #     Supported values are:
    #
    #     * `stable`: string. Default value when no value is specified. Uses a
    #        generally available, fine-tuned model. For more information, see
    #        [Answer generation model versions and
    #        lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
    #     * `preview`: string. (Public preview) Uses a preview model. For more
    #        information, see
    #        [Answer generation model versions and
    #        lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
    class ModelSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A specification for configuring the extractive content in a search
  # response.
  # @!attribute [rw] max_extractive_answer_count
  #   @return [::Integer]
  #     The maximum number of extractive answers returned in each search
  #     result.
  #
  #     An extractive answer is a verbatim answer extracted from the original
  #     document, which provides a precise and contextually relevant answer to
  #     the search query.
  #
  #     If the number of matching answers is less than the
  #     `max_extractive_answer_count`, return all of the answers. Otherwise,
  #     return the `max_extractive_answer_count`.
  #
  #     At most five answers are returned for each
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult SearchResult}.
  # @!attribute [rw] max_extractive_segment_count
  #   @return [::Integer]
  #     The max number of extractive segments returned in each search result.
  #     Only applied if the
  #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ContentConfig::CONTENT_REQUIRED DataStore.ContentConfig.CONTENT_REQUIRED}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore#solution_types DataStore.solution_types}
  #     is
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_CHAT SOLUTION_TYPE_CHAT}.
  #
  #     An extractive segment is a text segment extracted from the original
  #     document that is relevant to the search query, and, in general, more
  #     verbose than an extractive answer. The segment could then be used as
  #     input for LLMs to generate summaries and answers.
  #
  #     If the number of matching segments is less than
  #     `max_extractive_segment_count`, return all of the segments. Otherwise,
  #     return the `max_extractive_segment_count`.
  # @!attribute [rw] return_extractive_segment_score
  #   @return [::Boolean]
  #     Specifies whether to return the confidence score from the extractive
  #     segments in each search result. This feature is available only for new
  #     or allowlisted data stores. To allowlist your data store,
  #     contact your Customer Engineer. The default value is `false`.
  # @!attribute [rw] num_previous_segments
  #   @return [::Integer]
  #     Specifies whether to also include the adjacent from each selected
  #     segments.
  #     Return at most `num_previous_segments` segments before each selected
  #     segments.
  # @!attribute [rw] num_next_segments
  #   @return [::Integer]
  #     Return at most `num_next_segments` segments after each selected
  #     segments.
  class ExtractiveContentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the chunk spec to be returned from the search response.
  # Only available if the
  # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  # is set to
  # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}
  # @!attribute [rw] num_previous_chunks
  #   @return [::Integer]
  #     The number of previous chunks to be returned of the current chunk. The
  #     maximum allowed value is 3.
  #     If not specified, no previous chunks will be returned.
  # @!attribute [rw] num_next_chunks
  #   @return [::Integer]
  #     The number of next chunks to be returned of the current chunk. The
  #     maximum allowed value is 3.
  #     If not specified, no next chunks will be returned.
  class ChunkSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the search result mode. If unspecified, the
  # search result mode defaults to `DOCUMENTS`.
  module SearchResultMode
    # Default value.
    SEARCH_RESULT_MODE_UNSPECIFIED = 0

    # Returns documents in the search result.
    DOCUMENTS = 1

    # Returns chunks in the search result. Only available if the
    # {::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig#chunking_config DocumentProcessingConfig.chunking_config}
    # is specified.
    CHUNKS = 2
  end
end

#extractive_content_spec ⇒ `::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::ExtractiveContentSpec`

Returns If there is no extractive_content_spec provided, there will be no extractive answer in the search response.

Returns:

(::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::ExtractiveContentSpec) —
If there is no extractive_content_spec provided, there will be no extractive answer in the search response.

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

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
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @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
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @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 10 results for documents mode, or 50 for chunks mode, can be
  #     used to generate a summary. The chunks mode is used when
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
  # @!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] ignore_low_relevant_content
  #   @return [::Boolean]
  #     Specifies whether to filter out queries that have low relevance. The
  #     default value is `false`.
  #
  #     If this field is set to `false`, all search results are used regardless
  #     of relevance to generate answers. If set to `true`, only queries with
  #     high relevance search results will generate answers.
  # @!attribute [rw] ignore_jail_breaking_query
  #   @return [::Boolean]
  #     Optional. Specifies whether to filter out jail-breaking queries. The
  #     default value is `false`.
  #
  #     Google employs search-query classification to detect jail-breaking
  #     queries. No summary is returned if the search query is classified as a
  #     jail-breaking query. A user might add instructions to the query to
  #     change the tone, style, language, content of the answer, or ask the
  #     model to act as a different entity, e.g. "Reply in the tone of a
  #     competing company's CEO". If this field is set to `true`, we skip
  #     generating summaries for jail-breaking queries and return fallback
  #     messages instead.
  # @!attribute [rw] multimodal_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::MultiModalSpec]
  #     Optional. Multimodal specification.
  # @!attribute [rw] model_prompt_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::ModelPromptSpec]
  #     If specified, the spec will be used to modify the prompt provided to
  #     the LLM.
  # @!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).
  #     Note: This is an experimental feature.
  # @!attribute [rw] model_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::ModelSpec]
  #     If specified, the spec will be used to modify the model specification
  #     provided to the LLM.
  # @!attribute [rw] use_semantic_chunks
  #   @return [::Boolean]
  #     If true, answer will be generated from most relevant chunks from top
  #     search results. This feature will improve summary quality.
  #     Note that with this feature enabled, not all top search results
  #     will be referenced and included in the reference list, so the citation
  #     source index only points to the search results listed in the reference
  #     list.
  class SummarySpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Multimodal specification: Will return an image from specified source.
    # If multiple sources are specified, the pick is a quality based
    # decision.
    # @!attribute [rw] image_source
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::MultiModalSpec::ImageSource]
    #     Optional. Source of image returned in the answer.
    class MultiModalSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Specifies the image source.
      module ImageSource
        # Unspecified image source (multimodal feature is disabled by
        # default).
        IMAGE_SOURCE_UNSPECIFIED = 0

        # Behavior when service determines the pick from all available
        # sources.
        ALL_AVAILABLE_SOURCES = 1

        # Includes image from corpus in the answer.
        CORPUS_IMAGE_ONLY = 2

        # Triggers figure generation in the answer.
        FIGURE_GENERATION_ONLY = 3
      end
    end

    # Specification of the prompt to use with the model.
    # @!attribute [rw] preamble
    #   @return [::String]
    #     Text at the beginning of the prompt that instructs the assistant.
    #     Examples are available in the user guide.
    class ModelPromptSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specification of the model.
    # @!attribute [rw] version
    #   @return [::String]
    #     The model version used to generate the summary.
    #
    #     Supported values are:
    #
    #     * `stable`: string. Default value when no value is specified. Uses a
    #        generally available, fine-tuned model. For more information, see
    #        [Answer generation model versions and
    #        lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
    #     * `preview`: string. (Public preview) Uses a preview model. For more
    #        information, see
    #        [Answer generation model versions and
    #        lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
    class ModelSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A specification for configuring the extractive content in a search
  # response.
  # @!attribute [rw] max_extractive_answer_count
  #   @return [::Integer]
  #     The maximum number of extractive answers returned in each search
  #     result.
  #
  #     An extractive answer is a verbatim answer extracted from the original
  #     document, which provides a precise and contextually relevant answer to
  #     the search query.
  #
  #     If the number of matching answers is less than the
  #     `max_extractive_answer_count`, return all of the answers. Otherwise,
  #     return the `max_extractive_answer_count`.
  #
  #     At most five answers are returned for each
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult SearchResult}.
  # @!attribute [rw] max_extractive_segment_count
  #   @return [::Integer]
  #     The max number of extractive segments returned in each search result.
  #     Only applied if the
  #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ContentConfig::CONTENT_REQUIRED DataStore.ContentConfig.CONTENT_REQUIRED}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore#solution_types DataStore.solution_types}
  #     is
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_CHAT SOLUTION_TYPE_CHAT}.
  #
  #     An extractive segment is a text segment extracted from the original
  #     document that is relevant to the search query, and, in general, more
  #     verbose than an extractive answer. The segment could then be used as
  #     input for LLMs to generate summaries and answers.
  #
  #     If the number of matching segments is less than
  #     `max_extractive_segment_count`, return all of the segments. Otherwise,
  #     return the `max_extractive_segment_count`.
  # @!attribute [rw] return_extractive_segment_score
  #   @return [::Boolean]
  #     Specifies whether to return the confidence score from the extractive
  #     segments in each search result. This feature is available only for new
  #     or allowlisted data stores. To allowlist your data store,
  #     contact your Customer Engineer. The default value is `false`.
  # @!attribute [rw] num_previous_segments
  #   @return [::Integer]
  #     Specifies whether to also include the adjacent from each selected
  #     segments.
  #     Return at most `num_previous_segments` segments before each selected
  #     segments.
  # @!attribute [rw] num_next_segments
  #   @return [::Integer]
  #     Return at most `num_next_segments` segments after each selected
  #     segments.
  class ExtractiveContentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the chunk spec to be returned from the search response.
  # Only available if the
  # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  # is set to
  # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}
  # @!attribute [rw] num_previous_chunks
  #   @return [::Integer]
  #     The number of previous chunks to be returned of the current chunk. The
  #     maximum allowed value is 3.
  #     If not specified, no previous chunks will be returned.
  # @!attribute [rw] num_next_chunks
  #   @return [::Integer]
  #     The number of next chunks to be returned of the current chunk. The
  #     maximum allowed value is 3.
  #     If not specified, no next chunks will be returned.
  class ChunkSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the search result mode. If unspecified, the
  # search result mode defaults to `DOCUMENTS`.
  module SearchResultMode
    # Default value.
    SEARCH_RESULT_MODE_UNSPECIFIED = 0

    # Returns documents in the search result.
    DOCUMENTS = 1

    # Returns chunks in the search result. Only available if the
    # {::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig#chunking_config DocumentProcessingConfig.chunking_config}
    # is specified.
    CHUNKS = 2
  end
end

#search_result_mode ⇒ `::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode`

Returns Specifies the search result mode. If unspecified, the search result mode defaults to DOCUMENTS.

Returns:

(::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode) —
Specifies the search result mode. If unspecified, the search result mode defaults to DOCUMENTS.

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

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
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @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
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @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 10 results for documents mode, or 50 for chunks mode, can be
  #     used to generate a summary. The chunks mode is used when
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
  # @!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] ignore_low_relevant_content
  #   @return [::Boolean]
  #     Specifies whether to filter out queries that have low relevance. The
  #     default value is `false`.
  #
  #     If this field is set to `false`, all search results are used regardless
  #     of relevance to generate answers. If set to `true`, only queries with
  #     high relevance search results will generate answers.
  # @!attribute [rw] ignore_jail_breaking_query
  #   @return [::Boolean]
  #     Optional. Specifies whether to filter out jail-breaking queries. The
  #     default value is `false`.
  #
  #     Google employs search-query classification to detect jail-breaking
  #     queries. No summary is returned if the search query is classified as a
  #     jail-breaking query. A user might add instructions to the query to
  #     change the tone, style, language, content of the answer, or ask the
  #     model to act as a different entity, e.g. "Reply in the tone of a
  #     competing company's CEO". If this field is set to `true`, we skip
  #     generating summaries for jail-breaking queries and return fallback
  #     messages instead.
  # @!attribute [rw] multimodal_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::MultiModalSpec]
  #     Optional. Multimodal specification.
  # @!attribute [rw] model_prompt_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::ModelPromptSpec]
  #     If specified, the spec will be used to modify the prompt provided to
  #     the LLM.
  # @!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).
  #     Note: This is an experimental feature.
  # @!attribute [rw] model_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::ModelSpec]
  #     If specified, the spec will be used to modify the model specification
  #     provided to the LLM.
  # @!attribute [rw] use_semantic_chunks
  #   @return [::Boolean]
  #     If true, answer will be generated from most relevant chunks from top
  #     search results. This feature will improve summary quality.
  #     Note that with this feature enabled, not all top search results
  #     will be referenced and included in the reference list, so the citation
  #     source index only points to the search results listed in the reference
  #     list.
  class SummarySpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Multimodal specification: Will return an image from specified source.
    # If multiple sources are specified, the pick is a quality based
    # decision.
    # @!attribute [rw] image_source
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::MultiModalSpec::ImageSource]
    #     Optional. Source of image returned in the answer.
    class MultiModalSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Specifies the image source.
      module ImageSource
        # Unspecified image source (multimodal feature is disabled by
        # default).
        IMAGE_SOURCE_UNSPECIFIED = 0

        # Behavior when service determines the pick from all available
        # sources.
        ALL_AVAILABLE_SOURCES = 1

        # Includes image from corpus in the answer.
        CORPUS_IMAGE_ONLY = 2

        # Triggers figure generation in the answer.
        FIGURE_GENERATION_ONLY = 3
      end
    end

    # Specification of the prompt to use with the model.
    # @!attribute [rw] preamble
    #   @return [::String]
    #     Text at the beginning of the prompt that instructs the assistant.
    #     Examples are available in the user guide.
    class ModelPromptSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specification of the model.
    # @!attribute [rw] version
    #   @return [::String]
    #     The model version used to generate the summary.
    #
    #     Supported values are:
    #
    #     * `stable`: string. Default value when no value is specified. Uses a
    #        generally available, fine-tuned model. For more information, see
    #        [Answer generation model versions and
    #        lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
    #     * `preview`: string. (Public preview) Uses a preview model. For more
    #        information, see
    #        [Answer generation model versions and
    #        lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
    class ModelSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A specification for configuring the extractive content in a search
  # response.
  # @!attribute [rw] max_extractive_answer_count
  #   @return [::Integer]
  #     The maximum number of extractive answers returned in each search
  #     result.
  #
  #     An extractive answer is a verbatim answer extracted from the original
  #     document, which provides a precise and contextually relevant answer to
  #     the search query.
  #
  #     If the number of matching answers is less than the
  #     `max_extractive_answer_count`, return all of the answers. Otherwise,
  #     return the `max_extractive_answer_count`.
  #
  #     At most five answers are returned for each
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult SearchResult}.
  # @!attribute [rw] max_extractive_segment_count
  #   @return [::Integer]
  #     The max number of extractive segments returned in each search result.
  #     Only applied if the
  #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ContentConfig::CONTENT_REQUIRED DataStore.ContentConfig.CONTENT_REQUIRED}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore#solution_types DataStore.solution_types}
  #     is
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_CHAT SOLUTION_TYPE_CHAT}.
  #
  #     An extractive segment is a text segment extracted from the original
  #     document that is relevant to the search query, and, in general, more
  #     verbose than an extractive answer. The segment could then be used as
  #     input for LLMs to generate summaries and answers.
  #
  #     If the number of matching segments is less than
  #     `max_extractive_segment_count`, return all of the segments. Otherwise,
  #     return the `max_extractive_segment_count`.
  # @!attribute [rw] return_extractive_segment_score
  #   @return [::Boolean]
  #     Specifies whether to return the confidence score from the extractive
  #     segments in each search result. This feature is available only for new
  #     or allowlisted data stores. To allowlist your data store,
  #     contact your Customer Engineer. The default value is `false`.
  # @!attribute [rw] num_previous_segments
  #   @return [::Integer]
  #     Specifies whether to also include the adjacent from each selected
  #     segments.
  #     Return at most `num_previous_segments` segments before each selected
  #     segments.
  # @!attribute [rw] num_next_segments
  #   @return [::Integer]
  #     Return at most `num_next_segments` segments after each selected
  #     segments.
  class ExtractiveContentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the chunk spec to be returned from the search response.
  # Only available if the
  # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  # is set to
  # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}
  # @!attribute [rw] num_previous_chunks
  #   @return [::Integer]
  #     The number of previous chunks to be returned of the current chunk. The
  #     maximum allowed value is 3.
  #     If not specified, no previous chunks will be returned.
  # @!attribute [rw] num_next_chunks
  #   @return [::Integer]
  #     The number of next chunks to be returned of the current chunk. The
  #     maximum allowed value is 3.
  #     If not specified, no next chunks will be returned.
  class ChunkSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the search result mode. If unspecified, the
  # search result mode defaults to `DOCUMENTS`.
  module SearchResultMode
    # Default value.
    SEARCH_RESULT_MODE_UNSPECIFIED = 0

    # Returns documents in the search result.
    DOCUMENTS = 1

    # Returns chunks in the search result. Only available if the
    # {::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig#chunking_config DocumentProcessingConfig.chunking_config}
    # is specified.
    CHUNKS = 2
  end
end

#snippet_spec ⇒ `::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec`

Returns If snippetSpec is not specified, snippets are not included in the search response.

Returns:

(::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec) —
If snippetSpec is not specified, snippets are not included in the search response.

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

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
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @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
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @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 10 results for documents mode, or 50 for chunks mode, can be
  #     used to generate a summary. The chunks mode is used when
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
  # @!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] ignore_low_relevant_content
  #   @return [::Boolean]
  #     Specifies whether to filter out queries that have low relevance. The
  #     default value is `false`.
  #
  #     If this field is set to `false`, all search results are used regardless
  #     of relevance to generate answers. If set to `true`, only queries with
  #     high relevance search results will generate answers.
  # @!attribute [rw] ignore_jail_breaking_query
  #   @return [::Boolean]
  #     Optional. Specifies whether to filter out jail-breaking queries. The
  #     default value is `false`.
  #
  #     Google employs search-query classification to detect jail-breaking
  #     queries. No summary is returned if the search query is classified as a
  #     jail-breaking query. A user might add instructions to the query to
  #     change the tone, style, language, content of the answer, or ask the
  #     model to act as a different entity, e.g. "Reply in the tone of a
  #     competing company's CEO". If this field is set to `true`, we skip
  #     generating summaries for jail-breaking queries and return fallback
  #     messages instead.
  # @!attribute [rw] multimodal_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::MultiModalSpec]
  #     Optional. Multimodal specification.
  # @!attribute [rw] model_prompt_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::ModelPromptSpec]
  #     If specified, the spec will be used to modify the prompt provided to
  #     the LLM.
  # @!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).
  #     Note: This is an experimental feature.
  # @!attribute [rw] model_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::ModelSpec]
  #     If specified, the spec will be used to modify the model specification
  #     provided to the LLM.
  # @!attribute [rw] use_semantic_chunks
  #   @return [::Boolean]
  #     If true, answer will be generated from most relevant chunks from top
  #     search results. This feature will improve summary quality.
  #     Note that with this feature enabled, not all top search results
  #     will be referenced and included in the reference list, so the citation
  #     source index only points to the search results listed in the reference
  #     list.
  class SummarySpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Multimodal specification: Will return an image from specified source.
    # If multiple sources are specified, the pick is a quality based
    # decision.
    # @!attribute [rw] image_source
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::MultiModalSpec::ImageSource]
    #     Optional. Source of image returned in the answer.
    class MultiModalSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Specifies the image source.
      module ImageSource
        # Unspecified image source (multimodal feature is disabled by
        # default).
        IMAGE_SOURCE_UNSPECIFIED = 0

        # Behavior when service determines the pick from all available
        # sources.
        ALL_AVAILABLE_SOURCES = 1

        # Includes image from corpus in the answer.
        CORPUS_IMAGE_ONLY = 2

        # Triggers figure generation in the answer.
        FIGURE_GENERATION_ONLY = 3
      end
    end

    # Specification of the prompt to use with the model.
    # @!attribute [rw] preamble
    #   @return [::String]
    #     Text at the beginning of the prompt that instructs the assistant.
    #     Examples are available in the user guide.
    class ModelPromptSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specification of the model.
    # @!attribute [rw] version
    #   @return [::String]
    #     The model version used to generate the summary.
    #
    #     Supported values are:
    #
    #     * `stable`: string. Default value when no value is specified. Uses a
    #        generally available, fine-tuned model. For more information, see
    #        [Answer generation model versions and
    #        lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
    #     * `preview`: string. (Public preview) Uses a preview model. For more
    #        information, see
    #        [Answer generation model versions and
    #        lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
    class ModelSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A specification for configuring the extractive content in a search
  # response.
  # @!attribute [rw] max_extractive_answer_count
  #   @return [::Integer]
  #     The maximum number of extractive answers returned in each search
  #     result.
  #
  #     An extractive answer is a verbatim answer extracted from the original
  #     document, which provides a precise and contextually relevant answer to
  #     the search query.
  #
  #     If the number of matching answers is less than the
  #     `max_extractive_answer_count`, return all of the answers. Otherwise,
  #     return the `max_extractive_answer_count`.
  #
  #     At most five answers are returned for each
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult SearchResult}.
  # @!attribute [rw] max_extractive_segment_count
  #   @return [::Integer]
  #     The max number of extractive segments returned in each search result.
  #     Only applied if the
  #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ContentConfig::CONTENT_REQUIRED DataStore.ContentConfig.CONTENT_REQUIRED}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore#solution_types DataStore.solution_types}
  #     is
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_CHAT SOLUTION_TYPE_CHAT}.
  #
  #     An extractive segment is a text segment extracted from the original
  #     document that is relevant to the search query, and, in general, more
  #     verbose than an extractive answer. The segment could then be used as
  #     input for LLMs to generate summaries and answers.
  #
  #     If the number of matching segments is less than
  #     `max_extractive_segment_count`, return all of the segments. Otherwise,
  #     return the `max_extractive_segment_count`.
  # @!attribute [rw] return_extractive_segment_score
  #   @return [::Boolean]
  #     Specifies whether to return the confidence score from the extractive
  #     segments in each search result. This feature is available only for new
  #     or allowlisted data stores. To allowlist your data store,
  #     contact your Customer Engineer. The default value is `false`.
  # @!attribute [rw] num_previous_segments
  #   @return [::Integer]
  #     Specifies whether to also include the adjacent from each selected
  #     segments.
  #     Return at most `num_previous_segments` segments before each selected
  #     segments.
  # @!attribute [rw] num_next_segments
  #   @return [::Integer]
  #     Return at most `num_next_segments` segments after each selected
  #     segments.
  class ExtractiveContentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the chunk spec to be returned from the search response.
  # Only available if the
  # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  # is set to
  # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}
  # @!attribute [rw] num_previous_chunks
  #   @return [::Integer]
  #     The number of previous chunks to be returned of the current chunk. The
  #     maximum allowed value is 3.
  #     If not specified, no previous chunks will be returned.
  # @!attribute [rw] num_next_chunks
  #   @return [::Integer]
  #     The number of next chunks to be returned of the current chunk. The
  #     maximum allowed value is 3.
  #     If not specified, no next chunks will be returned.
  class ChunkSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the search result mode. If unspecified, the
  # search result mode defaults to `DOCUMENTS`.
  module SearchResultMode
    # Default value.
    SEARCH_RESULT_MODE_UNSPECIFIED = 0

    # Returns documents in the search result.
    DOCUMENTS = 1

    # Returns chunks in the search result. Only available if the
    # {::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig#chunking_config DocumentProcessingConfig.chunking_config}
    # is specified.
    CHUNKS = 2
  end
end

#summary_spec ⇒ `::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec`

Returns If summarySpec is not specified, summaries are not included in the search response.

Returns:

(::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec) —
If summarySpec is not specified, summaries are not included in the search response.

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

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
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @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
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @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 10 results for documents mode, or 50 for chunks mode, can be
  #     used to generate a summary. The chunks mode is used when
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
  # @!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] ignore_low_relevant_content
  #   @return [::Boolean]
  #     Specifies whether to filter out queries that have low relevance. The
  #     default value is `false`.
  #
  #     If this field is set to `false`, all search results are used regardless
  #     of relevance to generate answers. If set to `true`, only queries with
  #     high relevance search results will generate answers.
  # @!attribute [rw] ignore_jail_breaking_query
  #   @return [::Boolean]
  #     Optional. Specifies whether to filter out jail-breaking queries. The
  #     default value is `false`.
  #
  #     Google employs search-query classification to detect jail-breaking
  #     queries. No summary is returned if the search query is classified as a
  #     jail-breaking query. A user might add instructions to the query to
  #     change the tone, style, language, content of the answer, or ask the
  #     model to act as a different entity, e.g. "Reply in the tone of a
  #     competing company's CEO". If this field is set to `true`, we skip
  #     generating summaries for jail-breaking queries and return fallback
  #     messages instead.
  # @!attribute [rw] multimodal_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::MultiModalSpec]
  #     Optional. Multimodal specification.
  # @!attribute [rw] model_prompt_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::ModelPromptSpec]
  #     If specified, the spec will be used to modify the prompt provided to
  #     the LLM.
  # @!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).
  #     Note: This is an experimental feature.
  # @!attribute [rw] model_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::ModelSpec]
  #     If specified, the spec will be used to modify the model specification
  #     provided to the LLM.
  # @!attribute [rw] use_semantic_chunks
  #   @return [::Boolean]
  #     If true, answer will be generated from most relevant chunks from top
  #     search results. This feature will improve summary quality.
  #     Note that with this feature enabled, not all top search results
  #     will be referenced and included in the reference list, so the citation
  #     source index only points to the search results listed in the reference
  #     list.
  class SummarySpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Multimodal specification: Will return an image from specified source.
    # If multiple sources are specified, the pick is a quality based
    # decision.
    # @!attribute [rw] image_source
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::MultiModalSpec::ImageSource]
    #     Optional. Source of image returned in the answer.
    class MultiModalSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Specifies the image source.
      module ImageSource
        # Unspecified image source (multimodal feature is disabled by
        # default).
        IMAGE_SOURCE_UNSPECIFIED = 0

        # Behavior when service determines the pick from all available
        # sources.
        ALL_AVAILABLE_SOURCES = 1

        # Includes image from corpus in the answer.
        CORPUS_IMAGE_ONLY = 2

        # Triggers figure generation in the answer.
        FIGURE_GENERATION_ONLY = 3
      end
    end

    # Specification of the prompt to use with the model.
    # @!attribute [rw] preamble
    #   @return [::String]
    #     Text at the beginning of the prompt that instructs the assistant.
    #     Examples are available in the user guide.
    class ModelPromptSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Specification of the model.
    # @!attribute [rw] version
    #   @return [::String]
    #     The model version used to generate the summary.
    #
    #     Supported values are:
    #
    #     * `stable`: string. Default value when no value is specified. Uses a
    #        generally available, fine-tuned model. For more information, see
    #        [Answer generation model versions and
    #        lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
    #     * `preview`: string. (Public preview) Uses a preview model. For more
    #        information, see
    #        [Answer generation model versions and
    #        lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
    class ModelSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A specification for configuring the extractive content in a search
  # response.
  # @!attribute [rw] max_extractive_answer_count
  #   @return [::Integer]
  #     The maximum number of extractive answers returned in each search
  #     result.
  #
  #     An extractive answer is a verbatim answer extracted from the original
  #     document, which provides a precise and contextually relevant answer to
  #     the search query.
  #
  #     If the number of matching answers is less than the
  #     `max_extractive_answer_count`, return all of the answers. Otherwise,
  #     return the `max_extractive_answer_count`.
  #
  #     At most five answers are returned for each
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult SearchResult}.
  # @!attribute [rw] max_extractive_segment_count
  #   @return [::Integer]
  #     The max number of extractive segments returned in each search result.
  #     Only applied if the
  #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ContentConfig::CONTENT_REQUIRED DataStore.ContentConfig.CONTENT_REQUIRED}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore#solution_types DataStore.solution_types}
  #     is
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_CHAT SOLUTION_TYPE_CHAT}.
  #
  #     An extractive segment is a text segment extracted from the original
  #     document that is relevant to the search query, and, in general, more
  #     verbose than an extractive answer. The segment could then be used as
  #     input for LLMs to generate summaries and answers.
  #
  #     If the number of matching segments is less than
  #     `max_extractive_segment_count`, return all of the segments. Otherwise,
  #     return the `max_extractive_segment_count`.
  # @!attribute [rw] return_extractive_segment_score
  #   @return [::Boolean]
  #     Specifies whether to return the confidence score from the extractive
  #     segments in each search result. This feature is available only for new
  #     or allowlisted data stores. To allowlist your data store,
  #     contact your Customer Engineer. The default value is `false`.
  # @!attribute [rw] num_previous_segments
  #   @return [::Integer]
  #     Specifies whether to also include the adjacent from each selected
  #     segments.
  #     Return at most `num_previous_segments` segments before each selected
  #     segments.
  # @!attribute [rw] num_next_segments
  #   @return [::Integer]
  #     Return at most `num_next_segments` segments after each selected
  #     segments.
  class ExtractiveContentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the chunk spec to be returned from the search response.
  # Only available if the
  # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  # is set to
  # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}
  # @!attribute [rw] num_previous_chunks
  #   @return [::Integer]
  #     The number of previous chunks to be returned of the current chunk. The
  #     maximum allowed value is 3.
  #     If not specified, no previous chunks will be returned.
  # @!attribute [rw] num_next_chunks
  #   @return [::Integer]
  #     The number of next chunks to be returned of the current chunk. The
  #     maximum allowed value is 3.
  #     If not specified, no next chunks will be returned.
  class ChunkSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the search result mode. If unspecified, the
  # search result mode defaults to `DOCUMENTS`.
  module SearchResultMode
    # Default value.
    SEARCH_RESULT_MODE_UNSPECIFIED = 0

    # Returns documents in the search result.
    DOCUMENTS = 1

    # Returns chunks in the search result. Only available if the
    # {::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig#chunking_config DocumentProcessingConfig.chunking_config}
    # is specified.
    CHUNKS = 2
  end
end

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

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#chunk_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::ChunkSpec

#extractive_content_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::ExtractiveContentSpec

#search_result_mode ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode

#snippet_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec

#summary_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec

#chunk_spec ⇒ `::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::ChunkSpec`

#extractive_content_spec ⇒ `::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::ExtractiveContentSpec`

#search_result_mode ⇒ `::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode`

#snippet_spec ⇒ `::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec`

#summary_spec ⇒ `::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec`