Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class ToolUse.
Stores metadata of the invocation of an action supported by a tool.
Generated from protobuf message google.cloud.dialogflow.cx.v3.ToolUse
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ tool |
string
Required. The tool that should be used. Format: |
↳ display_name |
string
Output only. The display name of the tool. |
↳ action |
string
Optional. Name of the action to be called during the tool use. |
↳ input_action_parameters |
Google\Protobuf\Struct
Optional. A list of input parameters for the action. |
↳ output_action_parameters |
Google\Protobuf\Struct
Optional. A list of output parameters generated by the action. |
getTool
Required. The tool that should be
used. Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTool
Required. The tool that should be
used. Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Output only. The display name of the tool.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Output only. The display name of the tool.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAction
Optional. Name of the action to be called during the tool use.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAction
Optional. Name of the action to be called during the tool use.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInputActionParameters
Optional. A list of input parameters for the action.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null |
|
hasInputActionParameters
clearInputActionParameters
setInputActionParameters
Optional. A list of input parameters for the action.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOutputActionParameters
Optional. A list of output parameters generated by the action.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null |
|
hasOutputActionParameters
clearOutputActionParameters
setOutputActionParameters
Optional. A list of output parameters generated by the action.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this |
|