Class: Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/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

Instance Attribute Details

#chunk_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::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:



656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 656

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::V1::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1::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] model_prompt_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1::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::V1::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

    # 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::V1::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::V1::DataStore DataStore} is set to
  #     {::Google::Cloud::DiscoveryEngine::V1::DataStore::ContentConfig::CONTENT_REQUIRED DataStore.ContentConfig.CONTENT_REQUIRED}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::DataStore#solution_types DataStore.solution_types}
  #     is
  #     {::Google::Cloud::DiscoveryEngine::V1::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::V1::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  # is set to
  # {::Google::Cloud::DiscoveryEngine::V1::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
    # [DataStore.DocumentProcessingConfig.chunking_config][] is specified.
    CHUNKS = 2
  end
end

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

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

Returns:



656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 656

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::V1::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1::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] model_prompt_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1::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::V1::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

    # 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::V1::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::V1::DataStore DataStore} is set to
  #     {::Google::Cloud::DiscoveryEngine::V1::DataStore::ContentConfig::CONTENT_REQUIRED DataStore.ContentConfig.CONTENT_REQUIRED}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::DataStore#solution_types DataStore.solution_types}
  #     is
  #     {::Google::Cloud::DiscoveryEngine::V1::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::V1::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  # is set to
  # {::Google::Cloud::DiscoveryEngine::V1::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
    # [DataStore.DocumentProcessingConfig.chunking_config][] is specified.
    CHUNKS = 2
  end
end

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

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

Returns:



656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 656

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::V1::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1::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] model_prompt_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1::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::V1::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

    # 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::V1::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::V1::DataStore DataStore} is set to
  #     {::Google::Cloud::DiscoveryEngine::V1::DataStore::ContentConfig::CONTENT_REQUIRED DataStore.ContentConfig.CONTENT_REQUIRED}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::DataStore#solution_types DataStore.solution_types}
  #     is
  #     {::Google::Cloud::DiscoveryEngine::V1::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::V1::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  # is set to
  # {::Google::Cloud::DiscoveryEngine::V1::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
    # [DataStore.DocumentProcessingConfig.chunking_config][] is specified.
    CHUNKS = 2
  end
end

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

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

Returns:



656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 656

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::V1::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1::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] model_prompt_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1::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::V1::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

    # 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::V1::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::V1::DataStore DataStore} is set to
  #     {::Google::Cloud::DiscoveryEngine::V1::DataStore::ContentConfig::CONTENT_REQUIRED DataStore.ContentConfig.CONTENT_REQUIRED}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::DataStore#solution_types DataStore.solution_types}
  #     is
  #     {::Google::Cloud::DiscoveryEngine::V1::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::V1::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  # is set to
  # {::Google::Cloud::DiscoveryEngine::V1::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
    # [DataStore.DocumentProcessingConfig.chunking_config][] is specified.
    CHUNKS = 2
  end
end

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

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

Returns:



656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 656

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::V1::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1::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] model_prompt_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1::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::V1::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

    # 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::V1::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::V1::DataStore DataStore} is set to
  #     {::Google::Cloud::DiscoveryEngine::V1::DataStore::ContentConfig::CONTENT_REQUIRED DataStore.ContentConfig.CONTENT_REQUIRED}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1::DataStore#solution_types DataStore.solution_types}
  #     is
  #     {::Google::Cloud::DiscoveryEngine::V1::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::V1::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  # is set to
  # {::Google::Cloud::DiscoveryEngine::V1::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
    # [DataStore.DocumentProcessingConfig.chunking_config][] is specified.
    CHUNKS = 2
  end
end