Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb

Overview

A specification for configuring a summary returned in a search response.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec.



5617
5618
5619
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5617

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#ignore_adversarial_query ⇒ Boolean Also known as: ignore_adversarial_query?

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. Corresponds to the JSON property ignoreAdversarialQuery

Returns:

  • (Boolean) 


5562
5563
5564
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5562

def ignore_adversarial_query
  @ignore_adversarial_query
end

#ignore_non_summary_seeking_query ⇒ Boolean Also known as: ignore_non_summary_seeking_query?

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. Corresponds to the JSON property ignoreNonSummarySeekingQuery

Returns:

  • (Boolean) 


5575
5576
5577
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5575

def ignore_non_summary_seeking_query
  @ignore_non_summary_seeking_query
end

#include_citations ⇒ Boolean Also known as: include_citations?

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. Corresponds to the JSON property includeCitations

Returns:

  • (Boolean) 


5590
5591
5592
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5590

def include_citations
  @include_citations
end

#language_code ⇒ String

Language code for Summary. Use language tags defined by BCP47. Note: This is an experimental feature. Corresponds to the JSON property languageCode

Returns:

  • (String) 


5597
5598
5599
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5597

def language_code
  @language_code
end

#model_prompt_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec

Specification of the prompt to use with the model. Corresponds to the JSON property modelPromptSpec

Returns:



5602
5603
5604
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5602

def model_prompt_spec
  @model_prompt_spec
end

#model_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec

Specification of the model. Corresponds to the JSON property modelSpec

Returns:



5607
5608
5609
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5607

def model_spec
  @model_spec
end

#summary_result_count ⇒ Fixnum

The number of top results to generate the summary from. If the number of results returned is less than summaryResultCount, the summary is generated from all of the results. At most five results can be used to generate a summary. Corresponds to the JSON property summaryResultCount

Returns:

  • (Fixnum) 


5615
5616
5617
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5615

def summary_result_count
  @summary_result_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5622
5623
5624
5625
5626
5627
5628
5629
5630
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5622

def update!(**args)
  @ignore_adversarial_query = args[:ignore_adversarial_query] if args.key?(:ignore_adversarial_query)
  @ignore_non_summary_seeking_query = args[:ignore_non_summary_seeking_query] if args.key?(:ignore_non_summary_seeking_query)
  @include_citations = args[:include_citations] if args.key?(:include_citations)
  @language_code = args[:language_code] if args.key?(:language_code)
  @model_prompt_spec = args[:model_prompt_spec] if args.key?(:model_prompt_spec)
  @model_spec = args[:model_spec] if args.key?(:model_spec)
  @summary_result_count = args[:summary_result_count] if args.key?(:summary_result_count)
end