Google Cloud Discovery Engine V1beta Client - Class ChatEngineConfig (0.11.3)

Version latest

• 1.3.1 (latest)
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.11.3
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Configurations for a Chat Engine.

Generated from protobuf message google.cloud.discoveryengine.v1beta.Engine.ChatEngineConfig

Namespace

Google \ Cloud \ DiscoveryEngine \ V1beta \ Engine

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ agent_creation_config	Google\Cloud\DiscoveryEngine\V1beta\Engine\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.

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.

Returns
Type	Description
Google\Cloud\DiscoveryEngine\V1beta\Engine\ChatEngineConfig\AgentCreationConfig|null

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.

Parameter
Name	Description
var	Google\Cloud\DiscoveryEngine\V1beta\Engine\ChatEngineConfig\AgentCreationConfig

Returns
Type	Description
$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.

Returns
Type	Description
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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this