Google Cloud Dialogflow Cx V3 Client - Class ToolCallResult (0.10.1)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class ToolCallResult.

The result of calling a tool's action that has been executed by the client.

Generated from protobuf message google.cloud.dialogflow.cx.v3.ToolCallResult

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ tool`	`string` Required. The tool associated with this call. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`.
`↳ action`	`string` Required. The name of the tool's action associated with this call.
`↳ error`	`ToolCallResult\Error` The tool call's error.
`↳ output_parameters`	`Google\Protobuf\Struct` The tool call's output parameters.

getTool

Required. The tool associated with this call. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.

Returns
Type	Description
`string`

setTool

Required. The tool associated with this call. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAction

Required. The name of the tool's action associated with this call.

Returns
Type	Description
`string`

setAction

Required. The name of the tool's action associated with this call.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getError

The tool call's error.

Returns
Type	Description
`ToolCallResult\Error\|null`

hasError

setError