Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class CompanionAgent.
Companion agent.
Generated from protobuf message google.cloud.dialogflow.v2.CompanionAgent
Namespace
Google \ Cloud \ Dialogflow \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The unique identifier of the companion agent. Format: |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Creation time of this companion agent. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Update time of this companion agent. |
↳ toolset_tools |
array<ToolsetTool>
Optional. List of CES toolset specs that the companion agent can choose from. |
↳ ces_tool_specs |
array<CesToolSpec>
Optional. List of CES tool specs that the companion agent can choose from. |
↳ display_name |
string
Optional. Display name for the companion agent. Character limit is 63. |
↳ description |
string
Optional. Description for the companion agent. |
↳ skill_configs |
array<CompanionAgent\SkillConfig>
Optional. List of skill configs for the companion agent. Allows at most one instance of each SkillConfig type. |
getName
Identifier. The unique identifier of the companion agent.
Format:
projects/{project}/locations/{location}/companionAgents/{companion_agent}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The unique identifier of the companion agent.
Format:
projects/{project}/locations/{location}/companionAgents/{companion_agent}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Creation time of this companion agent.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Creation time of this companion agent.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Update time of this companion agent.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Update time of this companion agent.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getToolsetTools
Optional. List of CES toolset specs that the companion agent can choose from.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<ToolsetTool> |
|
setToolsetTools
Optional. List of CES toolset specs that the companion agent can choose from.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ToolsetTool>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCesToolSpecs
Optional. List of CES tool specs that the companion agent can choose from.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<CesToolSpec> |
|
setCesToolSpecs
Optional. List of CES tool specs that the companion agent can choose from.
| Parameter | |
|---|---|
| Name | Description |
var |
array<CesToolSpec>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Optional. Display name for the companion agent.
Character limit is 63.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. Display name for the companion agent.
Character limit is 63.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Description for the companion agent.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Description for the companion agent.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSkillConfigs
Optional. List of skill configs for the companion agent.
Allows at most one instance of each SkillConfig type.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<CompanionAgent\SkillConfig> |
|
setSkillConfigs
Optional. List of skill configs for the companion agent.
Allows at most one instance of each SkillConfig type.
| Parameter | |
|---|---|
| Name | Description |
var |
array<CompanionAgent\SkillConfig>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|