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.



2937
2938
2939
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2937

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) 


2886
2887
2888
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2886

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) 


2897
2898
2899
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2897

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) 


2906
2907
2908
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2906

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) 


2917
2918
2919
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2917

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) 


2924
2925
2926
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2924

def include_citations
  @include_citations
end

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

Answer Generation Model specification. Corresponds to the JSON property modelSpec

Returns:



2930
2931
2932
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2930

def model_spec
  @model_spec
end

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

Answer generation prompt specification. Corresponds to the JSON property promptSpec

Returns:



2935
2936
2937
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2935

def prompt_spec
  @prompt_spec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2942
2943
2944
2945
2946
2947
2948
2949
2950
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2942

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