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 \ V1Methods
__construct
Constructor.
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
↳ 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}
string
hasTool
setTool
Optional. The name of the tool to execute.
Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
var
string
$this
getToolsetTool
Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.
hasToolsetTool
setToolsetTool
Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.
$this
getVariables
Optional. The variables that are available for the tool execution.
hasVariables
setVariables
Optional. The variables that are available for the tool execution.
$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.
hasContext
setContext
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.
$this
getParent
Required. The resource name of the app which the tool/toolset belongs to.
Format: projects/{project}/locations/{location}/apps/{app}
string
setParent
Required. The resource name of the app which the tool/toolset belongs to.
Format: projects/{project}/locations/{location}/apps/{app}
var
string
$this
getArgs
Optional. The input parameters and values for the tool in JSON object format.
hasArgs
clearArgs
setArgs
Optional. The input parameters and values for the tool in JSON object format.
$this
getToolIdentifier
string
getToolExecutionContext
string
