Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ChatEngineConfig.
Configurations for a Chat Engine.
Generated from protobuf message google.cloud.discoveryengine.v1.Engine.ChatEngineConfig
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ EngineMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ agent_creation_config |
Google\Cloud\DiscoveryEngine\V1\Engine\ChatEngineConfig\AgentCreationConfig
The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. |
↳ dialogflow_agent_to_link |
string
The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide |
getAgentCreationConfig
The configurationt generate the Dialogflow agent that is associated to this Engine.
Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1\Engine\ChatEngineConfig\AgentCreationConfig|null |
hasAgentCreationConfig
clearAgentCreationConfig
setAgentCreationConfig
The configurationt generate the Dialogflow agent that is associated to this Engine.
Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\Engine\ChatEngineConfig\AgentCreationConfig
|
Returns | |
---|---|
Type | Description |
$this |
getDialogflowAgentToLink
The resource name of an exist Dialogflow agent to link to this Chat
Engine. Customers can either provide agent_creation_config
to create
agent or provide an agent name that links the agent with the Chat engine.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>
.
Note that the dialogflow_agent_to_link
are one-time consumed by and
passed to Dialogflow service. It means they cannot be retrieved using
EngineService.GetEngine
or
EngineService.ListEngines
API after engine creation. Use
ChatEngineMetadata.dialogflow_agent
for actual agent association after Engine is created.
Returns | |
---|---|
Type | Description |
string |
setDialogflowAgentToLink
The resource name of an exist Dialogflow agent to link to this Chat
Engine. Customers can either provide agent_creation_config
to create
agent or provide an agent name that links the agent with the Chat engine.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>
.
Note that the dialogflow_agent_to_link
are one-time consumed by and
passed to Dialogflow service. It means they cannot be retrieved using
EngineService.GetEngine
or
EngineService.ListEngines
API after engine creation. Use
ChatEngineMetadata.dialogflow_agent
for actual agent association after Engine is created.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |