Google Cloud Dialogflow Cx V3 Client - Class KnowledgeConnectorSettings (0.3.4)

Version latest

• 0.3.4 (latest)
• 0.3.3
• 0.2.1
• 0.1.1

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class KnowledgeConnectorSettings.

The Knowledge Connector settings for this page or flow.

This includes information such as the attached Knowledge Bases, and the way to execute fulfillment.

Generated from protobuf message google.cloud.dialogflow.cx.v3.KnowledgeConnectorSettings

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ enabled	bool Whether Knowledge Connector is enabled or not.
↳ trigger_fulfillment	Google\Cloud\Dialogflow\Cx\V3\Fulfillment The fulfillment to be triggered. When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter $request.knowledge.answers (contains up to the 5 highest confidence answers) and $request.knowledge.questions (contains the corresponding questions) to construct the fulfillment.
↳ target_page	string The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.
↳ target_flow	string The target flow to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.
↳ data_store_connections	array<Google\Cloud\Dialogflow\Cx\V3\DataStoreConnection> Optional. List of related data store connections.

getEnabled

Whether Knowledge Connector is enabled or not.

Returns
Type	Description
bool

setEnabled

Whether Knowledge Connector is enabled or not.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getTriggerFulfillment

The fulfillment to be triggered.

When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter $request.knowledge.answers (contains up to the 5 highest confidence answers) and $request.knowledge.questions (contains the corresponding questions) to construct the fulfillment.

Returns
Type	Description
Google\Cloud\Dialogflow\Cx\V3\Fulfillment|null

hasTriggerFulfillment

clearTriggerFulfillment

setTriggerFulfillment

The fulfillment to be triggered.

When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter $request.knowledge.answers (contains up to the 5 highest confidence answers) and $request.knowledge.questions (contains the corresponding questions) to construct the fulfillment.

Parameter
Name	Description
var	Google\Cloud\Dialogflow\Cx\V3\Fulfillment

Returns
Type	Description
$this

getTargetPage

The target page to transition to.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

Returns
Type	Description
string

hasTargetPage

setTargetPage

The target page to transition to.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getTargetFlow

The target flow to transition to.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

Returns
Type	Description
string

hasTargetFlow

setTargetFlow

The target flow to transition to.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDataStoreConnections

Optional. List of related data store connections.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setDataStoreConnections

Optional. List of related data store connections.

Parameter
Name	Description
var	array<Google\Cloud\Dialogflow\Cx\V3\DataStoreConnection>

Returns
Type	Description
$this

getTarget

Returns
Type	Description
string