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.



2317
2318
2319
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2317

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) 


2266
2267
2268
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2266

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) 


2277
2278
2279
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2277

def ignore_adversarial_query
  @ignore_adversarial_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) 


2286
2287
2288
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2286

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) 


2297
2298
2299
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2297

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) 


2304
2305
2306
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2304

def include_citations
  @include_citations
end

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

Answer Generation Model specification. Corresponds to the JSON property modelSpec

Returns:



2310
2311
2312
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2310

def model_spec
  @model_spec
end

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

Answer generation prompt specification. Corresponds to the JSON property promptSpec

Returns:



2315
2316
2317
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2315

def prompt_spec
  @prompt_spec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2322
2323
2324
2325
2326
2327
2328
2329
2330
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2322

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_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