Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec

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

Overview

Answer generation specification.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec

Returns a new instance of GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec.



19522
19523
19524
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 19522

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

Instance Attribute Details

#answer_language_code ⇒ String

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

Returns:

  • (String) 


19452
19453
19454
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 19452

def answer_language_code
  @answer_language_code
end

#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 answer 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 answers for adversarial queries and return fallback messages instead. Corresponds to the JSON property ignoreAdversarialQuery

Returns:

  • (Boolean) 


19463
19464
19465
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 19463

def ignore_adversarial_query
  @ignore_adversarial_query
end

#ignore_jail_breaking_query ⇒ Boolean Also known as: ignore_jail_breaking_query?

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

Returns:

  • (Boolean) 


19476
19477
19478
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 19476

def ignore_jail_breaking_query
  @ignore_jail_breaking_query
end

#ignore_low_relevant_content ⇒ Boolean Also known as: ignore_low_relevant_content?

Specifies whether to filter out queries that have low relevance. If this field is set to false, all search results are used regardless of relevance to generate answers. If set to true or unset, the behavior will be determined automatically by the service. Corresponds to the JSON property ignoreLowRelevantContent

Returns:

  • (Boolean) 


19485
19486
19487
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 19485

def ignore_low_relevant_content
  @ignore_low_relevant_content
end

#ignore_non_answer_seeking_query ⇒ Boolean Also known as: ignore_non_answer_seeking_query?

Specifies whether to filter out queries that are not answer-seeking. The default value is false. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to true, we skip generating answers for non-answer seeking queries and return fallback messages instead. Corresponds to the JSON property ignoreNonAnswerSeekingQuery

Returns:

  • (Boolean) 


19496
19497
19498
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 19496

def ignore_non_answer_seeking_query
  @ignore_non_answer_seeking_query
end

#include_citations ⇒ Boolean Also known as: include_citations?

Specifies whether to include citation metadata in the answer. The default value is false. Corresponds to the JSON property includeCitations

Returns:

  • (Boolean) 


19503
19504
19505
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 19503

def include_citations
  @include_citations
end

#model_spec ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec

Answer Generation Model specification. Corresponds to the JSON property modelSpec

Returns:



19509
19510
19511
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 19509

def model_spec
  @model_spec
end

#multimodal_spec ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecMultimodalSpec

Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision. Corresponds to the JSON property multimodalSpec

Returns:



19515
19516
19517
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 19515

def multimodal_spec
  @multimodal_spec
end

#prompt_spec ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec

Answer generation prompt specification. Corresponds to the JSON property promptSpec

Returns:



19520
19521
19522
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 19520

def prompt_spec
  @prompt_spec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



19527
19528
19529
19530
19531
19532
19533
19534
19535
19536
19537
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 19527

def update!(**args)
  @answer_language_code = args[:answer_language_code] if args.key?(:answer_language_code)
  @ignore_adversarial_query = args[:ignore_adversarial_query] if args.key?(:ignore_adversarial_query)
  @ignore_jail_breaking_query = args[:ignore_jail_breaking_query] if args.key?(:ignore_jail_breaking_query)
  @ignore_low_relevant_content = args[:ignore_low_relevant_content] if args.key?(:ignore_low_relevant_content)
  @ignore_non_answer_seeking_query = args[:ignore_non_answer_seeking_query] if args.key?(:ignore_non_answer_seeking_query)
  @include_citations = args[:include_citations] if args.key?(:include_citations)
  @model_spec = args[:model_spec] if args.key?(:model_spec)
  @multimodal_spec = args[:multimodal_spec] if args.key?(:multimodal_spec)
  @prompt_spec = args[:prompt_spec] if args.key?(:prompt_spec)
end