Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::AnswerGenerationSpec (v2.6.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::AnswerGenerationSpec.

Answer generation specification.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#answer_language_code

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

#answer_language_code=

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

#ignore_adversarial_query

def ignore_adversarial_query() -> ::Boolean
Returns
  • (::Boolean) — 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.

#ignore_adversarial_query=

def ignore_adversarial_query=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.

Returns
  • (::Boolean) — 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.

#ignore_jail_breaking_query

def ignore_jail_breaking_query() -> ::Boolean
Returns
  • (::Boolean) — 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.

#ignore_jail_breaking_query=

def ignore_jail_breaking_query=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.

Returns
  • (::Boolean) — 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.

#ignore_low_relevant_content

def ignore_low_relevant_content() -> ::Boolean
Returns
  • (::Boolean) — 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.

#ignore_low_relevant_content=

def ignore_low_relevant_content=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.

Returns
  • (::Boolean) — 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.

#ignore_non_answer_seeking_query

def ignore_non_answer_seeking_query() -> ::Boolean
Returns
  • (::Boolean) — 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.

#ignore_non_answer_seeking_query=

def ignore_non_answer_seeking_query=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.

Returns
  • (::Boolean) — 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.

#include_citations

def include_citations() -> ::Boolean
Returns
  • (::Boolean) — Specifies whether to include citation metadata in the answer. The default value is false.

#include_citations=

def include_citations=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Specifies whether to include citation metadata in the answer. The default value is false.
Returns
  • (::Boolean) — Specifies whether to include citation metadata in the answer. The default value is false.

#model_spec

def model_spec() -> ::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::AnswerGenerationSpec::ModelSpec
Returns

#model_spec=

def model_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::AnswerGenerationSpec::ModelSpec
Parameter
Returns

#prompt_spec

def prompt_spec() -> ::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::AnswerGenerationSpec::PromptSpec
Returns

#prompt_spec=

def prompt_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::AnswerGenerationSpec::PromptSpec
Parameter
Returns