Google Cloud Ces V1 Client - Class WidgetTool (0.2.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parameters`	`Schema` Optional. The input parameters of the widget tool.
`↳ 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`	`Google\Protobuf\Struct` Optional. Configuration for rendering the widget.
`↳ 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.

Returns
Type	Description
`Schema\|null`

hasParameters

setParameters

Optional. The input parameters of the widget tool.

Parameter
Name	Description
`var`	`Schema`

Returns
Type	Description
`$this`

getName

Required. The display name of the widget tool.

Returns
Type	Description
`string`

setName

Required. The display name of the widget tool.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

Optional. The description of the widget tool.

Returns
Type	Description
`string`

setDescription

Optional. The description of the widget tool.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getWidgetType

Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.

Returns
Type	Description
`int`	Enum of type WidgetType.

setWidgetType

Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.

Parameter
Name	Description
`var`	`int` Enum of type WidgetType.

Returns
Type	Description
`$this`

getUiConfig

Optional. Configuration for rendering the widget.

Returns
Type	Description
`Google\Protobuf\Struct\|null`

hasUiConfig

clearUiConfig

setUiConfig