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.
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.
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis document provides reference documentation for the \u003ccode\u003eEngine.Types.ChatEngineConfig\u003c/code\u003e class within the Google Cloud Discovery Engine v1 API.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of this class is 1.6.0, with older versions ranging down to 1.0.0-beta06 also available.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eEngine.Types.ChatEngineConfig\u003c/code\u003e class is designed for configurations related to a Chat Engine, handling settings for linking or creating Dialogflow agents.\u003c/p\u003e\n"],["\u003cp\u003eIt implements several interfaces, including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, and inherits members from \u003ccode\u003eobject\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe class includes properties such as \u003ccode\u003eAgentCreationConfig\u003c/code\u003e for generating a Dialogflow agent and \u003ccode\u003eDialogflowAgentToLink\u003c/code\u003e for linking to an existing one.\u003c/p\u003e\n"]]],[],null,["# Discovery Engine v1 API - Class Engine.Types.ChatEngineConfig (1.9.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.9.0 (latest)](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Engine.Types.ChatEngineConfig)\n- [1.8.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.8.0/Google.Cloud.DiscoveryEngine.V1.Engine.Types.ChatEngineConfig)\n- [1.7.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.7.0/Google.Cloud.DiscoveryEngine.V1.Engine.Types.ChatEngineConfig)\n- [1.6.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.6.0/Google.Cloud.DiscoveryEngine.V1.Engine.Types.ChatEngineConfig)\n- [1.5.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.5.0/Google.Cloud.DiscoveryEngine.V1.Engine.Types.ChatEngineConfig)\n- [1.4.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.4.0/Google.Cloud.DiscoveryEngine.V1.Engine.Types.ChatEngineConfig)\n- [1.3.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.3.0/Google.Cloud.DiscoveryEngine.V1.Engine.Types.ChatEngineConfig)\n- [1.2.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.2.0/Google.Cloud.DiscoveryEngine.V1.Engine.Types.ChatEngineConfig)\n- [1.1.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.1.0/Google.Cloud.DiscoveryEngine.V1.Engine.Types.ChatEngineConfig)\n- [1.0.0-beta06](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.0.0-beta06/Google.Cloud.DiscoveryEngine.V1.Engine.Types.ChatEngineConfig) \n\n public sealed class Engine.Types.ChatEngineConfig : IMessage\u003cEngine.Types.ChatEngineConfig\u003e, IEquatable\u003cEngine.Types.ChatEngineConfig\u003e, IDeepCloneable\u003cEngine.Types.ChatEngineConfig\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Discovery Engine v1 API class Engine.Types.ChatEngineConfig.\n\nConfigurations for a Chat Engine. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e Engine.Types.ChatEngineConfig \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[Engine](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Engine)[Types](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Engine.Types)[ChatEngineConfig](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Engine.Types.ChatEngineConfig), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[Engine](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Engine)[Types](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Engine.Types)[ChatEngineConfig](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Engine.Types.ChatEngineConfig), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[Engine](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Engine)[Types](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Engine.Types)[ChatEngineConfig](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Engine.Types.ChatEngineConfig), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.DiscoveryEngine.V1](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.DiscoveryEngine.V1.dll\n\nConstructors\n------------\n\n### ChatEngineConfig()\n\n public ChatEngineConfig()\n\n### ChatEngineConfig(ChatEngineConfig)\n\n public ChatEngineConfig(Engine.Types.ChatEngineConfig other)\n\nProperties\n----------\n\n### AgentCreationConfig\n\n public Engine.Types.ChatEngineConfig.Types.AgentCreationConfig AgentCreationConfig { get; set; }\n\nThe configurationt generate the Dialogflow agent that is associated to\nthis Engine.\n\nNote that these configurations are one-time consumed by\nand passed to Dialogflow service. It means they cannot be retrieved using\n\\[EngineService.GetEngine\\]\\[google.cloud.discoveryengine.v1.EngineService.GetEngine\\]\nor\n\\[EngineService.ListEngines\\]\\[google.cloud.discoveryengine.v1.EngineService.ListEngines\\]\nAPI after engine creation.\n\n### AllowCrossRegion\n\n public bool AllowCrossRegion { get; set; }\n\nOptional. If the flag set to true, we allow the agent and engine are in\ndifferent locations, otherwise the agent and engine are required to be in\nthe same location. The flag is set to false by default.\n\nNote that the `allow_cross_region` are one-time consumed by and\npassed to\n\\[EngineService.CreateEngine\\]\\[google.cloud.discoveryengine.v1.EngineService.CreateEngine\\].\nIt means they cannot be retrieved using\n\\[EngineService.GetEngine\\]\\[google.cloud.discoveryengine.v1.EngineService.GetEngine\\]\nor\n\\[EngineService.ListEngines\\]\\[google.cloud.discoveryengine.v1.EngineService.ListEngines\\]\nAPI after engine creation.\n\n### DialogflowAgentToLink\n\n public string DialogflowAgentToLink { get; set; }\n\nThe resource name of an exist Dialogflow agent to link to this Chat\nEngine. Customers can either provide `agent_creation_config` to create\nagent or provide an agent name that links the agent with the Chat engine.\n\nFormat: `projects/\u003cProject ID\u003e/locations/\u003cLocation ID\u003e/agents/\u003cAgent\nID\u003e`.\n\nNote that the `dialogflow_agent_to_link` are one-time consumed by and\npassed to Dialogflow service. It means they cannot be retrieved using\n\\[EngineService.GetEngine\\]\\[google.cloud.discoveryengine.v1.EngineService.GetEngine\\]\nor\n\\[EngineService.ListEngines\\]\\[google.cloud.discoveryengine.v1.EngineService.ListEngines\\]\nAPI after engine creation. Use\n\\[ChatEngineMetadata.dialogflow_agent\\]\\[google.cloud.discoveryengine.v1.Engine.ChatEngineMetadata.dialogflow_agent\\]\nfor actual agent association after Engine is created."]]
