Google Cloud Ces V1 Client - Class WidgetTool (0.1.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.

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