Google Cloud Discovery Engine V1beta Client - Class AnswerGenerationSpec (0.11.1)

Version 0.11.1

• 0.11.3 (latest)
• 0.11.2
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class AnswerGenerationSpec.

Answer generation specification.

Generated from protobuf message google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec

Namespace

Google \ Cloud \ DiscoveryEngine \ V1beta \ AnswerQueryRequest

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ model_spec	Google\Cloud\DiscoveryEngine\V1beta\AnswerQueryRequest\AnswerGenerationSpec\ModelSpec Answer generation model specification.
↳ prompt_spec	Google\Cloud\DiscoveryEngine\V1beta\AnswerQueryRequest\AnswerGenerationSpec\PromptSpec Answer generation prompt specification.
↳ include_citations	bool Specifies whether to include citation metadata in the answer. The default value is false.
↳ answer_language_code	string Language code for Answer. Use language tags defined by BCP47. Note: This is an experimental feature.
↳ ignore_adversarial_query	bool 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_non_answer_seeking_query	bool 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.

getModelSpec

Answer generation model specification.

Returns
Type	Description
Google\Cloud\DiscoveryEngine\V1beta\AnswerQueryRequest\AnswerGenerationSpec\ModelSpec|null

hasModelSpec

clearModelSpec

setModelSpec

Answer generation model specification.

Parameter
Name	Description
var	Google\Cloud\DiscoveryEngine\V1beta\AnswerQueryRequest\AnswerGenerationSpec\ModelSpec

Returns
Type	Description
$this

getPromptSpec

Answer generation prompt specification.

Returns
Type	Description
Google\Cloud\DiscoveryEngine\V1beta\AnswerQueryRequest\AnswerGenerationSpec\PromptSpec|null

hasPromptSpec

clearPromptSpec

setPromptSpec

Answer generation prompt specification.

Parameter
Name	Description
var	Google\Cloud\DiscoveryEngine\V1beta\AnswerQueryRequest\AnswerGenerationSpec\PromptSpec

Returns
Type	Description
$this

getIncludeCitations

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

Returns
Type	Description
bool

setIncludeCitations

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

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getAnswerLanguageCode

Language code for Answer. Use language tags defined by BCP47.

Note: This is an experimental feature.

Returns
Type	Description
string

setAnswerLanguageCode

Language code for Answer. Use language tags defined by BCP47.

Note: This is an experimental feature.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

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.

Returns
Type	Description
bool

setIgnoreAdversarialQuery

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.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

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.

Returns
Type	Description
bool

setIgnoreNonAnswerSeekingQuery

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.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this