Reference documentation and code samples for the Google Cloud Ces V1 Client class AgentTool.
Represents a tool that allows the agent to call another agent.
Generated from protobuf message google.cloud.ces.v1.AgentTool
Namespace
Google \ Cloud \ Ces \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The name of the agent tool. |
↳ description |
string
Optional. Description of the tool's purpose. |
↳ root_agent |
string
Optional. The resource name of the root agent that is the entry point of the tool. Format: |
getName
Required. The name of the agent tool.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The name of the agent tool.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Description of the tool's purpose.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Description of the tool's purpose.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRootAgent
Optional. The resource name of the root agent that is the entry point of
the tool. Format: projects/{project}/locations/{location}/agents/{agent}
| Returns | |
|---|---|
| Type | Description |
string |
|
setRootAgent
Optional. The resource name of the root agent that is the entry point of
the tool. Format: projects/{project}/locations/{location}/agents/{agent}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|