com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig
extends com.google.api.client.json.GenericJson

Describes configuration for generative answer.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig	clone()
Boolean	getDisableRelatedQuestions() Whether generated answer contains suggested related questions.
Boolean	getIgnoreAdversarialQuery() Optional.
Boolean	getIgnoreLowRelevantContent() Optional.
Boolean	getIgnoreNonAnswerSeekingQuery() Optional.
String	getImageSource() Optional.
String	getLanguageCode() Language code for Summary.
Integer	getMaxRephraseSteps() Max rephrase steps.
String	getModelPromptPreamble() Text at the beginning of the prompt that instructs the model that generates the answer.
String	getModelVersion() The model version used to generate the answer.
Integer	getResultCount() The number of top results to generate the answer from.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig	setDisableRelatedQuestions(Boolean disableRelatedQuestions) Whether generated answer contains suggested related questions.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig	setIgnoreAdversarialQuery(Boolean ignoreAdversarialQuery) Optional.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig	setIgnoreLowRelevantContent(Boolean ignoreLowRelevantContent) Optional.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig	setIgnoreNonAnswerSeekingQuery(Boolean ignoreNonAnswerSeekingQuery) Optional.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig	setImageSource(String imageSource) Optional.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig	setLanguageCode(String languageCode) Language code for Summary.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig	setMaxRephraseSteps(Integer maxRephraseSteps) Max rephrase steps.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig	setModelPromptPreamble(String modelPromptPreamble) Text at the beginning of the prompt that instructs the model that generates the answer.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig	setModelVersion(String modelVersion) The model version used to generate the answer.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig	setResultCount(Integer resultCount) The number of top results to generate the answer from.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig()

Method Detail

getDisableRelatedQuestions

public Boolean getDisableRelatedQuestions()

Whether generated answer contains suggested related questions.

Returns:

value or null for none

setDisableRelatedQuestions

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig setDisableRelatedQuestions(Boolean disableRelatedQuestions)

Whether generated answer contains suggested related questions.

Parameters:

disableRelatedQuestions - disableRelatedQuestions or null for none

getIgnoreAdversarialQuery

public Boolean getIgnoreAdversarialQuery()

Optional. Specifies whether to filter out queries that are adversarial.

Returns:

value or null for none

setIgnoreAdversarialQuery

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig setIgnoreAdversarialQuery(Boolean ignoreAdversarialQuery)

Optional. Specifies whether to filter out queries that are adversarial.

Parameters:

ignoreAdversarialQuery - ignoreAdversarialQuery or null for none

getIgnoreLowRelevantContent

public Boolean getIgnoreLowRelevantContent()

Optional. Specifies whether to filter out queries that are not relevant to the content.

Returns:

value or null for none

setIgnoreLowRelevantContent

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig setIgnoreLowRelevantContent(Boolean ignoreLowRelevantContent)

Optional. Specifies whether to filter out queries that are not relevant to the content.

Parameters:

ignoreLowRelevantContent - ignoreLowRelevantContent or null for none

getIgnoreNonAnswerSeekingQuery

public Boolean getIgnoreNonAnswerSeekingQuery()

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:

value or null for none

setIgnoreNonAnswerSeekingQuery

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig setIgnoreNonAnswerSeekingQuery(Boolean ignoreNonAnswerSeekingQuery)

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.

Parameters:

ignoreNonAnswerSeekingQuery - ignoreNonAnswerSeekingQuery or null for none

getImageSource

public String getImageSource()

Optional. Source of image returned in the answer.

Returns:

value or null for none

setImageSource

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig setImageSource(String imageSource)

Optional. Source of image returned in the answer.

Parameters:

imageSource - imageSource or null for none

getLanguageCode

public String getLanguageCode()

Language code for Summary. Use language tags defined by [BCP47](https://www.rfc- editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.

Returns:

value or null for none

setLanguageCode

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig setLanguageCode(String languageCode)

Language code for Summary. Use language tags defined by [BCP47](https://www.rfc- editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.

Parameters:

languageCode - languageCode or null for none

getMaxRephraseSteps

public Integer getMaxRephraseSteps()

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:

value or null for none

setMaxRephraseSteps

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig setMaxRephraseSteps(Integer maxRephraseSteps)

Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.

Parameters:

maxRephraseSteps - maxRephraseSteps or null for none

getModelPromptPreamble

public String getModelPromptPreamble()

Text at the beginning of the prompt that instructs the model that generates the answer.

Returns:

value or null for none

setModelPromptPreamble

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig setModelPromptPreamble(String modelPromptPreamble)

Text at the beginning of the prompt that instructs the model that generates the answer.

Parameters:

modelPromptPreamble - modelPromptPreamble or null for none

getModelVersion

public String getModelVersion()

The model version used to generate the answer.

Returns:

value or null for none

setModelVersion

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig setModelVersion(String modelVersion)

The model version used to generate the answer.

Parameters:

modelVersion - modelVersion or null for none

getResultCount

public Integer getResultCount()

The number of top results to generate the answer from. Up to 10.

Returns:

value or null for none

setResultCount

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig setResultCount(Integer resultCount)

The number of top results to generate the answer from. Up to 10.

Parameters:

resultCount - resultCount or null for none

set

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig set(String fieldName,
                                                                                    Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig clone()

Overrides:

clone in class com.google.api.client.json.GenericJson