Google Cloud Discovery Engine V1 Client - Class ChatEngineConfig (1.10.1)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ChatEngineConfig.

Configurations for a Chat Engine.

Generated from protobuf messagegoogle.cloud.discoveryengine.v1.Engine.ChatEngineConfig

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ Engine

Methods

__construct

Constructor.

Parameters
Name	Description
`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 usingEngineService.GetEngine orEngineService.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 usingEngineService.GetEngine orEngineService.ListEngines API after engine creation. UseChatEngineMetadata.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 toEngineService.CreateEngine. It means they cannot be retrieved usingEngineService.GetEngine orEngineService.ListEngines API after engine creation.

getAgentCreationConfig

The configurationt generate the Dialogflow agent that is associated tothis Engine.

Note that these configurations are one-time consumed byand passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngineorEngineService.ListEnginesAPI after engine creation.

Returns
Type	Description
`ChatEngineConfig\AgentCreationConfig\|null`

hasAgentCreationConfig

clearAgentCreationConfig

setAgentCreationConfig

The configurationt generate the Dialogflow agent that is associated tothis Engine.

Note that these configurations are one-time consumed byand passed to Dialogflow service. It means they cannot be retrieved usingEngineService.GetEngineorEngineService.ListEnginesAPI after engine creation.

Parameter
Name	Description
`var`	`ChatEngineConfig\AgentCreationConfig`

Returns
Type	Description
`$this`

getDialogflowAgentToLink

The resource name of an exist Dialogflow agent to link to this ChatEngine. Customers can either provideagent_creation_config to createagent or provide an agent name that links the agent with the Chat engine.

Format:projects/<Project ID>/locations/<Location ID>/agents/<AgentID>.Note that thedialogflow_agent_to_link are one-time consumed by andpassed 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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAllowCrossRegion

Optional. If the flag set to true, we allow the agent and engine are indifferent locations, otherwise the agent and engine are required to be inthe same location. The flag is set to false by default.

Note that theallow_cross_region are one-time consumed by andpassed toEngineService.CreateEngine.It means they cannot be retrieved usingEngineService.GetEngineorEngineService.ListEnginesAPI after engine creation.

Returns
Type	Description
`bool`

setAllowCrossRegion