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.
data
array
Optional. Data for populating the Message object.
↳ agent_creation_config
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 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.
↳ allow_cross_region
bool
Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the allow_cross_region
are one-time consumed by and passed to EngineService.CreateEngine
. It means they cannot be retrieved using EngineService.GetEngine
or EngineService.ListEngines
API after engine creation.
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.
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.
$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.
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.
var
string
$this
getAllowCrossRegion
Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default.
Note that the allow_cross_region
are one-time consumed by and
passed to EngineService.CreateEngine
.
It means they cannot be retrieved using EngineService.GetEngine
or EngineService.ListEngines
API after engine creation.
bool
setAllowCrossRegion
Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default.
Note that the allow_cross_region
are one-time consumed by and
passed to EngineService.CreateEngine
.
It means they cannot be retrieved using EngineService.GetEngine
or EngineService.ListEngines
API after engine creation.
var
bool
$this