Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::KnowledgeConnectorSettings (v1.2.0)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#data_store_connections

def data_store_connections() -> ::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnection>

Returns

(::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnection>) — Optional. List of related data store connections.

#data_store_connections=

def data_store_connections=(value) -> ::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnection>

Parameter

value (::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnection>) — Optional. List of related data store connections.

Returns

(::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnection>) — Optional. List of related data store connections.

#enabled

def enabled() -> ::Boolean

Returns

(::Boolean) — Whether Knowledge Connector is enabled or not.

#enabled=

def enabled=(value) -> ::Boolean

Parameter

value (::Boolean) — Whether Knowledge Connector is enabled or not.

Returns

(::Boolean) — Whether Knowledge Connector is enabled or not.

#target_flow

def target_flow() -> ::String

Returns

(::String) — The target flow to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

#target_flow=

def target_flow=(value) -> ::String

Parameter

value (::String) — The target flow to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

Returns

(::String) — The target flow to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

#target_page

def target_page() -> ::String

Returns

(::String) — The target page to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

#target_page=

def target_page=(value) -> ::String

Parameter

value (::String) — The target page to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

Returns

(::String) — The target page to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

#trigger_fulfillment

def trigger_fulfillment() -> ::Google::Cloud::Dialogflow::CX::V3::Fulfillment

Returns

(::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.

#trigger_fulfillment=

def trigger_fulfillment=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Fulfillment

Parameter

value (::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.

Returns

(::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.