Reference documentation and code samples for the Google Cloud Ces V1 Client class WidgetTool.
Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent.
Generated from protobuf message google.cloud.ces.v1.WidgetTool
Namespace
Google \ Cloud \ Ces \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parameters
↳ name
string
Required. The display name of the widget tool.
↳ description
string
Optional. The description of the widget tool.
↳ widget_type
int
Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.
↳ ui_config
↳ data_mapping
WidgetTool\DataMapping
Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters.
getParameters
Optional. The input parameters of the widget tool.
hasParameters
setParameters
Optional. The input parameters of the widget tool.
$this
getName
Required. The display name of the widget tool.
string
setName
Required. The display name of the widget tool.
var
string
$this
getDescription
Optional. The description of the widget tool.
string
setDescription
Optional. The description of the widget tool.
var
string
$this
getWidgetType
Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.
setWidgetType
Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.
$this
getUiConfig
Optional. Configuration for rendering the widget.
hasUiConfig
clearUiConfig
setUiConfig
Optional. Configuration for rendering the widget.
$this
getDataMapping
Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters.
hasDataMapping
clearDataMapping
setDataMapping
Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters.
$this
getInput
string
