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 usingEngineService.GetEngineorEngineService.ListEnginesAPI 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 provideagent_creation_configto 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 thedialogflow_agent_to_linkare one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved usingEngineService.GetEngineorEngineService.ListEnginesAPI after engine creation. UseChatEngineMetadata.dialogflow_agentfor 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 theallow_cross_regionare one-time consumed by and passed toEngineService.CreateEngine. It means they cannot be retrieved usingEngineService.GetEngineorEngineService.ListEnginesAPI 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 usingEngineService.GetEngineorEngineService.ListEnginesAPI after engine creation.
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 usingEngineService.GetEngineorEngineService.ListEnginesAPI after engine creation.
The resource name of an exist Dialogflow agent to link to this Chat
Engine. Customers can either provideagent_creation_configto 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 thedialogflow_agent_to_linkare one-time consumed by and
passed to Dialogflow service. It means they cannot be retrieved usingEngineService.GetEngineorEngineService.ListEnginesAPI after engine creation. UseChatEngineMetadata.dialogflow_agentfor 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 provideagent_creation_configto 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 thedialogflow_agent_to_linkare one-time consumed by and
passed to Dialogflow service. It means they cannot be retrieved usingEngineService.GetEngineorEngineService.ListEnginesAPI after engine creation. UseChatEngineMetadata.dialogflow_agentfor actual agent association after Engine is created.
Parameter
Name
Description
var
string
Returns
Type
Description
$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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Discovery Engine V1 Client - Class ChatEngineConfig (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.Engine.ChatEngineConfig)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.Engine.ChatEngineConfig)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.Engine.ChatEngineConfig)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.Engine.ChatEngineConfig)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.Engine.ChatEngineConfig)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.Engine.ChatEngineConfig)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.Engine.ChatEngineConfig)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.Engine.ChatEngineConfig)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.Engine.ChatEngineConfig)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.Engine.ChatEngineConfig)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.Engine.ChatEngineConfig)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.Engine.ChatEngineConfig)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.Engine.ChatEngineConfig)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.Engine.ChatEngineConfig)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.Engine.ChatEngineConfig)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.Engine.ChatEngineConfig)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.Engine.ChatEngineConfig) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ChatEngineConfig.\n\nConfigurations for a Chat Engine.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.Engine.ChatEngineConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1 \\\\ Engine\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getAgentCreationConfig\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](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__getEngine__)\nor\n[EngineService.ListEngines](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__listEngines__)\nAPI after engine creation.\n\n### hasAgentCreationConfig\n\n### clearAgentCreationConfig\n\n### setAgentCreationConfig\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](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__getEngine__)\nor\n[EngineService.ListEngines](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__listEngines__)\nAPI after engine creation.\n\n### getDialogflowAgentToLink\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`.\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](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__getEngine__)\nor\n[EngineService.ListEngines](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__listEngines__)\nAPI after engine creation. Use\n[ChatEngineMetadata.dialogflow_agent](/php/docs/reference/cloud-discoveryengine/latest/V1.Engine.ChatEngineMetadata#_Google_Cloud_DiscoveryEngine_V1_Engine_ChatEngineMetadata__getDialogflowAgent__)\nfor actual agent association after Engine is created.\n\n### setDialogflowAgentToLink\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`.\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](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__getEngine__)\nor\n[EngineService.ListEngines](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__listEngines__)\nAPI after engine creation. Use\n[ChatEngineMetadata.dialogflow_agent](/php/docs/reference/cloud-discoveryengine/latest/V1.Engine.ChatEngineMetadata#_Google_Cloud_DiscoveryEngine_V1_Engine_ChatEngineMetadata__getDialogflowAgent__)\nfor actual agent association after Engine is created.\n\n### getAllowCrossRegion\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](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__createEngine__).\nIt means they cannot be retrieved using\n[EngineService.GetEngine](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__getEngine__)\nor\n[EngineService.ListEngines](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__listEngines__)\nAPI after engine creation.\n\n### setAllowCrossRegion\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](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__createEngine__).\nIt means they cannot be retrieved using\n[EngineService.GetEngine](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__getEngine__)\nor\n[EngineService.ListEngines](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.EngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_EngineServiceClient__listEngines__)\nAPI after engine creation."]]
