Discovery Engine v1 API - Class Engine.Types.ChatEngineConfig (1.7.0) 

public sealed class Engine.Types.ChatEngineConfig : IMessage<Engine.Types.ChatEngineConfig>, IEquatable<Engine.Types.ChatEngineConfig>, IDeepCloneable<Engine.Types.ChatEngineConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class Engine.Types.ChatEngineConfig.

Configurations for a Chat Engine.

Inheritance

object > Engine.Types.ChatEngineConfig

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

ChatEngineConfig()

public ChatEngineConfig()

ChatEngineConfig(ChatEngineConfig)

public ChatEngineConfig(Engine.Types.ChatEngineConfig other)
Parameter
Name Description
other EngineTypesChatEngineConfig

Properties

AgentCreationConfig

public Engine.Types.ChatEngineConfig.Types.AgentCreationConfig AgentCreationConfig { get; set; }

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][google.cloud.discoveryengine.v1.EngineService.GetEngine] or [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines] API after engine creation.

Property Value
Type Description
EngineTypesChatEngineConfigTypesAgentCreationConfig

AllowCrossRegion

public bool AllowCrossRegion { get; set; }

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][google.cloud.discoveryengine.v1.EngineService.CreateEngine]. It means they cannot be retrieved using [EngineService.GetEngine][google.cloud.discoveryengine.v1.EngineService.GetEngine] or [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines] API after engine creation.

Property Value
Type Description
bool 
public string DialogflowAgentToLink { get; set; }

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][google.cloud.discoveryengine.v1.EngineService.GetEngine] or [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines] API after engine creation. Use [ChatEngineMetadata.dialogflow_agent][google.cloud.discoveryengine.v1.Engine.ChatEngineMetadata.dialogflow_agent] for actual agent association after Engine is created.

Property Value
Type Description
string