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

Class GoogleCloudDiscoveryengineV1WidgetConfigUiSettings

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.GoogleCloudDiscoveryengineV1WidgetConfigUiSettings

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page.

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
GoogleCloudDiscoveryengineV1WidgetConfigUiSettings()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1WidgetConfigUiSettings	clone()
List<GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig>	getDataStoreUiConfigs() Per data store configuration.
String	getDefaultSearchRequestOrderBy() The default ordering for search results if specified.
Boolean	getDisableUserEventsCollection() If set to true, the widget will not collect user events.
Boolean	getEnableAutocomplete() Whether or not to enable autocomplete.
Boolean	getEnableCreateAgentButton() Optional.
Boolean	getEnablePeopleSearch() Optional.
Boolean	getEnableQualityFeedback() Turn on or off collecting the search result quality feedback from end users.
Boolean	getEnableSafeSearch() Whether to enable safe search.
Boolean	getEnableSearchAsYouType() Whether to enable search-as-you-type behavior for the search widget.
Boolean	getEnableVisualContentSummary() If set to true, the widget will enable visual content summary on applicable search requests.
Map<String,String>	getFeatures() Output only.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig	getGenerativeAnswerConfig() Describes generative answer configuration.
String	getInteractionType() Describes widget (or web app) interaction type
Map<String,String>	getModelConfigs() Output only.
String	getResultDescriptionType() Controls whether result extract is display and how (snippet or extractive answer).
GoogleCloudDiscoveryengineV1WidgetConfigUiSettings	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1WidgetConfigUiSettings	setDataStoreUiConfigs(List<GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig> dataStoreUiConfigs) Per data store configuration.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettings	setDefaultSearchRequestOrderBy(String defaultSearchRequestOrderBy) The default ordering for search results if specified.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettings	setDisableUserEventsCollection(Boolean disableUserEventsCollection) If set to true, the widget will not collect user events.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettings	setEnableAutocomplete(Boolean enableAutocomplete) Whether or not to enable autocomplete.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettings	setEnableCreateAgentButton(Boolean enableCreateAgentButton) Optional.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettings	setEnablePeopleSearch(Boolean enablePeopleSearch) Optional.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettings	setEnableQualityFeedback(Boolean enableQualityFeedback) Turn on or off collecting the search result quality feedback from end users.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettings	setEnableSafeSearch(Boolean enableSafeSearch) Whether to enable safe search.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettings	setEnableSearchAsYouType(Boolean enableSearchAsYouType) Whether to enable search-as-you-type behavior for the search widget.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettings	setEnableVisualContentSummary(Boolean enableVisualContentSummary) If set to true, the widget will enable visual content summary on applicable search requests.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettings	setFeatures(Map<String,String> features) Output only.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettings	setGenerativeAnswerConfig(GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig generativeAnswerConfig) Describes generative answer configuration.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettings	setInteractionType(String interactionType) Describes widget (or web app) interaction type
GoogleCloudDiscoveryengineV1WidgetConfigUiSettings	setModelConfigs(Map<String,String> modelConfigs) Output only.
GoogleCloudDiscoveryengineV1WidgetConfigUiSettings	setResultDescriptionType(String resultDescriptionType) Controls whether result extract is display and how (snippet or extractive answer).

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

GoogleCloudDiscoveryengineV1WidgetConfigUiSettings

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettings()

Method Detail

getDataStoreUiConfigs

public List<GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig> getDataStoreUiConfigs()

Per data store configuration.

Returns:

value or null for none

setDataStoreUiConfigs

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettings setDataStoreUiConfigs(List<GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig> dataStoreUiConfigs)

Per data store configuration.

Parameters:

dataStoreUiConfigs - dataStoreUiConfigs or null for none

getDefaultSearchRequestOrderBy

public String getDefaultSearchRequestOrderBy()

The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1a lpha/projects.locations.dataStores.servingConfigs/search#request-body

Returns:

value or null for none

setDefaultSearchRequestOrderBy

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettings setDefaultSearchRequestOrderBy(String defaultSearchRequestOrderBy)

The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1a lpha/projects.locations.dataStores.servingConfigs/search#request-body

Parameters:

defaultSearchRequestOrderBy - defaultSearchRequestOrderBy or null for none

getDisableUserEventsCollection

public Boolean getDisableUserEventsCollection()

If set to true, the widget will not collect user events.

Returns:

value or null for none

setDisableUserEventsCollection

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettings setDisableUserEventsCollection(Boolean disableUserEventsCollection)

If set to true, the widget will not collect user events.

Parameters:

disableUserEventsCollection - disableUserEventsCollection or null for none

getEnableAutocomplete

public Boolean getEnableAutocomplete()

Whether or not to enable autocomplete.

Returns:

value or null for none

setEnableAutocomplete

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettings setEnableAutocomplete(Boolean enableAutocomplete)

Whether or not to enable autocomplete.

Parameters:

enableAutocomplete - enableAutocomplete or null for none

getEnableCreateAgentButton

public Boolean getEnableCreateAgentButton()

Optional. If set to true, the widget will enable the create agent button.

Returns:

value or null for none

setEnableCreateAgentButton

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettings setEnableCreateAgentButton(Boolean enableCreateAgentButton)

Optional. If set to true, the widget will enable the create agent button.

Parameters:

enableCreateAgentButton - enableCreateAgentButton or null for none

getEnablePeopleSearch

public Boolean getEnablePeopleSearch()

Optional. If set to true, the widget will enable people search.

Returns:

value or null for none

setEnablePeopleSearch

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettings setEnablePeopleSearch(Boolean enablePeopleSearch)

Optional. If set to true, the widget will enable people search.

Parameters:

enablePeopleSearch - enablePeopleSearch or null for none

getEnableQualityFeedback

public Boolean getEnableQualityFeedback()

Turn on or off collecting the search result quality feedback from end users.

Returns:

value or null for none

setEnableQualityFeedback

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettings setEnableQualityFeedback(Boolean enableQualityFeedback)

Turn on or off collecting the search result quality feedback from end users.

Parameters:

enableQualityFeedback - enableQualityFeedback or null for none

getEnableSafeSearch

public Boolean getEnableSafeSearch()

Whether to enable safe search.

Returns:

value or null for none

setEnableSafeSearch

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettings setEnableSafeSearch(Boolean enableSafeSearch)

Whether to enable safe search.

Parameters:

enableSafeSearch - enableSafeSearch or null for none

getEnableSearchAsYouType

public Boolean getEnableSearchAsYouType()

Whether to enable search-as-you-type behavior for the search widget.

Returns:

value or null for none

setEnableSearchAsYouType

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettings setEnableSearchAsYouType(Boolean enableSearchAsYouType)

Whether to enable search-as-you-type behavior for the search widget.

Parameters:

enableSearchAsYouType - enableSearchAsYouType or null for none

getEnableVisualContentSummary

public Boolean getEnableVisualContentSummary()

If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.

Returns:

value or null for none

setEnableVisualContentSummary

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettings setEnableVisualContentSummary(Boolean enableVisualContentSummary)

If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.

Parameters:

enableVisualContentSummary - enableVisualContentSummary or null for none

getFeatures

public Map<String,String> getFeatures()

Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session- sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile- app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`

Returns:

value or null for none

setFeatures

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettings setFeatures(Map<String,String> features)

Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session- sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile- app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`

Parameters:

features - features or null for none

getGenerativeAnswerConfig

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig getGenerativeAnswerConfig()

Describes generative answer configuration.

Returns:

value or null for none

setGenerativeAnswerConfig

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettings setGenerativeAnswerConfig(GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig generativeAnswerConfig)

Describes generative answer configuration.

Parameters:

generativeAnswerConfig - generativeAnswerConfig or null for none

getInteractionType

public String getInteractionType()

Describes widget (or web app) interaction type

Returns:

value or null for none

setInteractionType

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettings setInteractionType(String interactionType)

Describes widget (or web app) interaction type

Parameters:

interactionType - interactionType or null for none

getModelConfigs

public Map<String,String> getModelConfigs()

Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.

Returns:

value or null for none

setModelConfigs

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettings setModelConfigs(Map<String,String> modelConfigs)

Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.

Parameters:

modelConfigs - modelConfigs or null for none

getResultDescriptionType

public String getResultDescriptionType()

Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.

Returns:

value or null for none

setResultDescriptionType

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettings setResultDescriptionType(String resultDescriptionType)

Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.

Parameters:

resultDescriptionType - resultDescriptionType or null for none

set

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettings set(String fieldName,
                                                              Object value)

Overrides:

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

clone

public GoogleCloudDiscoveryengineV1WidgetConfigUiSettings clone()

Overrides:

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