Google Cloud Discovery Engine V1 Client - Class AssistantSettings (1.17.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class AssistantSettings.

Describes the assistant settings of the widget.

Generated from protobuf message google.cloud.discoveryengine.v1.WidgetConfig.AssistantSettings

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ WidgetConfig

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ web_grounding_type int

Optional. The type of web grounding to use.

↳ default_web_grounding_toggle_off bool

Output only. This field controls the default web grounding toggle for end users if web_grounding_type is set to WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. By default, this field is set to false. If web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.

↳ disable_location_context bool

Optional. Output only. Whether to disable user location context.

getWebGroundingType

Optional. The type of web grounding to use.

Returns
Type Description
int Enum of type WebGroundingType.

setWebGroundingType

Optional. The type of web grounding to use.

Parameter
Name Description
var int

Enum of type WebGroundingType.

Returns
Type Description
$this

getDefaultWebGroundingToggleOff

Output only. This field controls the default web grounding toggle for end users if web_grounding_type is set to WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH.

By default, this field is set to false. If web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.

Returns
Type Description
bool

setDefaultWebGroundingToggleOff

Output only. This field controls the default web grounding toggle for end users if web_grounding_type is set to WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH.

By default, this field is set to false. If web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.

Parameter
Name Description
var bool
Returns
Type Description
$this

getDisableLocationContext

Optional. Output only. Whether to disable user location context.

Returns
Type Description
bool

setDisableLocationContext

Optional. Output only. Whether to disable user location context.

Parameter
Name Description
var bool
Returns
Type Description
$this