Interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder (0.39.0)

public static interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAnswerLanguageCode()

public abstract String getAnswerLanguageCode()

Language code for Answer. Use language tags defined by BCP47. Note: This is an experimental feature.

string answer_language_code = 4;

Returns
Type Description
String

The answerLanguageCode.

getAnswerLanguageCodeBytes()

public abstract ByteString getAnswerLanguageCodeBytes()

Language code for Answer. Use language tags defined by BCP47. Note: This is an experimental feature.

string answer_language_code = 4;

Returns
Type Description
ByteString

The bytes for answerLanguageCode.

getIgnoreAdversarialQuery()

public abstract boolean getIgnoreAdversarialQuery()

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.

bool ignore_adversarial_query = 5;

Returns
Type Description
boolean

The ignoreAdversarialQuery.

getIgnoreNonAnswerSeekingQuery()

public abstract boolean getIgnoreNonAnswerSeekingQuery()

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.

bool ignore_non_answer_seeking_query = 6;

Returns
Type Description
boolean

The ignoreNonAnswerSeekingQuery.

getIncludeCitations()

public abstract boolean getIncludeCitations()

Specifies whether to include citation metadata in the answer. The default value is false.

bool include_citations = 3;

Returns
Type Description
boolean

The includeCitations.

getModelSpec()

public abstract AnswerQueryRequest.AnswerGenerationSpec.ModelSpec getModelSpec()

Answer generation model specification.

.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;

Returns
Type Description
AnswerQueryRequest.AnswerGenerationSpec.ModelSpec

The modelSpec.

getModelSpecOrBuilder()

public abstract AnswerQueryRequest.AnswerGenerationSpec.ModelSpecOrBuilder getModelSpecOrBuilder()

Answer generation model specification.

.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;

Returns
Type Description
AnswerQueryRequest.AnswerGenerationSpec.ModelSpecOrBuilder

getPromptSpec()

public abstract AnswerQueryRequest.AnswerGenerationSpec.PromptSpec getPromptSpec()

Answer generation prompt specification.

.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;

Returns
Type Description
AnswerQueryRequest.AnswerGenerationSpec.PromptSpec

The promptSpec.

getPromptSpecOrBuilder()

public abstract AnswerQueryRequest.AnswerGenerationSpec.PromptSpecOrBuilder getPromptSpecOrBuilder()

Answer generation prompt specification.

.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;

Returns
Type Description
AnswerQueryRequest.AnswerGenerationSpec.PromptSpecOrBuilder

hasModelSpec()

public abstract boolean hasModelSpec()

Answer generation model specification.

.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;

Returns
Type Description
boolean

Whether the modelSpec field is set.

hasPromptSpec()

public abstract boolean hasPromptSpec()

Answer generation prompt specification.

.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;

Returns
Type Description
boolean

Whether the promptSpec field is set.