Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::GenerativeAnswerConfig (v2.14.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::GenerativeAnswerConfig.

Describes configuration for generative answer.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

def disable_related_questions() -> ::Boolean
Returns
  • (::Boolean) — Whether generated answer contains suggested related questions.
def disable_related_questions=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether generated answer contains suggested related questions.
Returns
  • (::Boolean) — Whether generated answer contains suggested related questions.

#ignore_adversarial_query

def ignore_adversarial_query() -> ::Boolean
Returns
  • (::Boolean) — Optional. Specifies whether to filter out queries that are adversarial.

#ignore_adversarial_query=

def ignore_adversarial_query=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Specifies whether to filter out queries that are adversarial.
Returns
  • (::Boolean) — Optional. Specifies whether to filter out queries that are adversarial.

#ignore_low_relevant_content

def ignore_low_relevant_content() -> ::Boolean
Returns
  • (::Boolean) — Optional. Specifies whether to filter out queries that are not relevant to the content.

#ignore_low_relevant_content=

def ignore_low_relevant_content=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Specifies whether to filter out queries that are not relevant to the content.
Returns
  • (::Boolean) — Optional. Specifies whether to filter out queries that are not relevant to the content.

#ignore_non_answer_seeking_query

def ignore_non_answer_seeking_query() -> ::Boolean
Returns
  • (::Boolean) — Optional. Specifies whether to filter out queries that are not answer-seeking. The default value is false.

    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.

#ignore_non_answer_seeking_query=

def ignore_non_answer_seeking_query=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Specifies whether to filter out queries that are not answer-seeking. The default value is false.

    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.

Returns
  • (::Boolean) — Optional. Specifies whether to filter out queries that are not answer-seeking. The default value is false.

    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.

#image_source

def image_source() -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::GenerativeAnswerConfig::ImageSource
Returns

#image_source=

def image_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::UiSettings::GenerativeAnswerConfig::ImageSource
Parameter
Returns

#language_code

def language_code() -> ::String
Returns
  • (::String) — Language code for Summary. Use language tags defined by BCP47. Note: This is an experimental feature.

#language_code=

def language_code=(value) -> ::String
Parameter
  • value (::String) — Language code for Summary. Use language tags defined by BCP47. Note: This is an experimental feature.
Returns
  • (::String) — Language code for Summary. Use language tags defined by BCP47. Note: This is an experimental feature.

#max_rephrase_steps

def max_rephrase_steps() -> ::Integer
Returns
  • (::Integer) — Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.

#max_rephrase_steps=

def max_rephrase_steps=(value) -> ::Integer
Parameter
  • value (::Integer) — Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.
Returns
  • (::Integer) — Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.

#model_prompt_preamble

def model_prompt_preamble() -> ::String
Returns
  • (::String) — Text at the beginning of the prompt that instructs the model that generates the answer.

#model_prompt_preamble=

def model_prompt_preamble=(value) -> ::String
Parameter
  • value (::String) — Text at the beginning of the prompt that instructs the model that generates the answer.
Returns
  • (::String) — Text at the beginning of the prompt that instructs the model that generates the answer.

#model_version

def model_version() -> ::String
Returns
  • (::String) — The model version used to generate the answer.

#model_version=

def model_version=(value) -> ::String
Parameter
  • value (::String) — The model version used to generate the answer.
Returns
  • (::String) — The model version used to generate the answer.

#result_count

def result_count() -> ::Integer
Returns
  • (::Integer) — The number of top results to generate the answer from. Up to 10.

#result_count=

def result_count=(value) -> ::Integer
Parameter
  • value (::Integer) — The number of top results to generate the answer from. Up to 10.
Returns
  • (::Integer) — The number of top results to generate the answer from. Up to 10.