Google Cloud Ces V1 Client - Class ExecuteToolRequest (0.2.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client class ExecuteToolRequest.

Request message for ToolService.ExecuteTool.

Generated from protobuf message google.cloud.ces.v1.ExecuteToolRequest

Namespace

Google \ Cloud \ Ces \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ tool`	`string` Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
`↳ toolset_tool`	`ToolsetTool` Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.
`↳ variables`	`Google\Protobuf\Struct` Optional. The variables that are available for the tool execution.
`↳ context`	`Google\Protobuf\Struct` Optional. The [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment for details) to be passed to the Python tool.
`↳ parent`	`string` Required. The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}`
`↳ args`	`Google\Protobuf\Struct` Optional. The input parameters and values for the tool in JSON object format.

getTool

Optional. The name of the tool to execute.

Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

Returns
Type	Description
`string`

hasTool

setTool

Optional. The name of the tool to execute.

Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getToolsetTool

Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

Returns
Type	Description
`ToolsetTool\|null`

hasToolsetTool

setToolsetTool

Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

Parameter
Name	Description
`var`	`ToolsetTool`

Returns
Type	Description
`$this`

getVariables

Optional. The variables that are available for the tool execution.

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

hasVariables

setVariables

Optional. The variables that are available for the tool execution.

Parameter
Name	Description
`var`	`Google\Protobuf\Struct`

Returns
Type	Description
`$this`

getContext

Optional. The [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment for details) to be passed to the Python tool.

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

hasContext

setContext