Google Cloud Ces V1 Client - Class ExecuteToolResponse (0.3.0)

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

Response message for ToolService.ExecuteTool.

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

Namespace

Google \ Cloud \ Ces \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ tool`	`string` The name of the tool that got executed. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
`↳ toolset_tool`	`ToolsetTool` The toolset tool that got executed.
`↳ response`	`Google\Protobuf\Struct` The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.
`↳ variables`	`Google\Protobuf\Struct` The variable values at the end of the tool execution.
`↳ citations`	`Citations` Citations that provide the source information for the tool's execution.
`↳ google_search_suggestions`	`GoogleSearchSuggestions` The suggestions returned from Google Search as a result of invoking the Google Search Tool during the tool execution.

getTool

The name of the tool that got executed.

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

Returns
Type	Description
`string`

hasTool

setTool

The name of the tool that got executed.

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getToolsetTool

The toolset tool that got executed.

Returns
Type	Description
`ToolsetTool\|null`

hasToolsetTool

setToolsetTool

The toolset tool that got executed.

Parameter
Name	Description
`var`	`ToolsetTool`

Returns
Type	Description
`$this`

getResponse

The tool execution result in JSON object format.

Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.

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

hasResponse

clearResponse

setResponse

The tool execution result in JSON object format.

Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.

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

Returns
Type	Description
`$this`

getVariables

The variable values at the end of the tool execution.

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

hasVariables

clearVariables

setVariables