Google Cloud Ces V1 Client - Class ToolCall (0.2.0)

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

Request for the client or the agent to execute the specified tool.

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

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.

↳ id
string

Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse .

↳ display_name
string

Output only. Display name of the tool.

↳ 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.

Returns
Type
Description
ToolsetTool |null

hasToolsetTool

setToolsetTool

Optional. The toolset tool to execute.

Parameter
Name
Description
Returns
Type
Description
$this

getId

Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse .

Returns
Type
Description
string

setId

Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDisplayName

Output only. Display name of the tool.

Returns
Type
Description
string

setDisplayName

Output only. Display name of the tool.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getArgs

Optional. The input parameters and values for the tool in JSON object format.

Returns
Type
Description

hasArgs

clearArgs

setArgs

Optional. The input parameters and values for the tool in JSON object format.

Parameter
Name
Description
Returns
Type
Description
$this

getToolIdentifier

Returns
Type
Description
string
Create a Mobile Website
View Site in Mobile | Classic
Share by: