Class: Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec
- Inherits:
-
Object
- Object
- Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb
Overview
A specification for configuring a summary returned in a search response.
Defined Under Namespace
Classes: ModelPromptSpec, ModelSpec
Instance Attribute Summary collapse
-
#ignore_adversarial_query ⇒ ::Boolean
Specifies whether to filter out adversarial queries.
-
#ignore_non_summary_seeking_query ⇒ ::Boolean
Specifies whether to filter out queries that are not summary-seeking.
-
#include_citations ⇒ ::Boolean
Specifies whether to include citations in the summary.
-
#language_code ⇒ ::String
Language code for Summary.
-
#model_prompt_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::ModelPromptSpec
If specified, the spec will be used to modify the prompt provided to the LLM.
-
#model_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::ModelSpec
If specified, the spec will be used to modify the model specification provided to the LLM.
-
#summary_result_count ⇒ ::Integer
The number of top results to generate the summary from.
Instance Attribute Details
#ignore_adversarial_query ⇒ ::Boolean
Returns 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.
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 614 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 version of the text-bison@001 # model. # * `preview`: string. (Public preview) Uses a fine-tuned version of # the text-bison@002 model. This model works only for summaries in # English. class ModelSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#ignore_non_summary_seeking_query ⇒ ::Boolean
Returns 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.
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 614 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 version of the text-bison@001 # model. # * `preview`: string. (Public preview) Uses a fine-tuned version of # the text-bison@002 model. This model works only for summaries in # English. class ModelSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#include_citations ⇒ ::Boolean
Returns 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.
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 614 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 version of the text-bison@001 # model. # * `preview`: string. (Public preview) Uses a fine-tuned version of # the text-bison@002 model. This model works only for summaries in # English. class ModelSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#language_code ⇒ ::String
Returns Language code for Summary. Use language tags defined by BCP47. Note: This is an experimental feature.
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 614 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 version of the text-bison@001 # model. # * `preview`: string. (Public preview) Uses a fine-tuned version of # the text-bison@002 model. This model works only for summaries in # English. class ModelSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#model_prompt_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::ModelPromptSpec
Returns If specified, the spec will be used to modify the prompt provided to the LLM.
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 614 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 version of the text-bison@001 # model. # * `preview`: string. (Public preview) Uses a fine-tuned version of # the text-bison@002 model. This model works only for summaries in # English. class ModelSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#model_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::ModelSpec
Returns If specified, the spec will be used to modify the model specification provided to the LLM.
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 614 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 version of the text-bison@001 # model. # * `preview`: string. (Public preview) Uses a fine-tuned version of # the text-bison@002 model. This model works only for summaries in # English. class ModelSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#summary_result_count ⇒ ::Integer
Returns 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 can be used to generate a summary.
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 614 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 version of the text-bison@001 # model. # * `preview`: string. (Public preview) Uses a fine-tuned version of # the text-bison@002 model. This model works only for summaries in # English. class ModelSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |