Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec

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

Answer generation specification.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec

Returns a new instance of GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec.



4576
4577
4578
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4576

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) 


4512
4513
4514
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4512

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) 


4523
4524
4525
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4523

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) 


4536
4537
4538
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4536

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) 


4545
4546
4547
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4545

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) 


4556
4557
4558
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4556

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) 


4563
4564
4565
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4563

def include_citations
  @include_citations
end

#model_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec

Answer Generation Model specification. Corresponds to the JSON property modelSpec

Returns:



4569
4570
4571
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4569

def model_spec
  @model_spec
end

#prompt_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec

Answer generation prompt specification. Corresponds to the JSON property promptSpec

Returns:



4574
4575
4576
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4574

def prompt_spec
  @prompt_spec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4581

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)
  @prompt_spec = args[:prompt_spec] if args.key?(:prompt_spec)
end