Class: Google::Cloud::Dialogflow::CX::V3::KnowledgeConnectorSettings

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/cx/v3/page.rb

Overview

The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment.

Instance Attribute Summary collapse

Instance Attribute Details

#data_store_connections ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnection>

Returns Optional. List of related data store connections.

Returns:



563
564
565
566
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 563

class KnowledgeConnectorSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#enabled ⇒ ::Boolean

Returns Whether Knowledge Connector is enabled or not.

Returns:

  • (::Boolean) —

    Whether Knowledge Connector is enabled or not.



563
564
565
566
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 563

class KnowledgeConnectorSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#target_flow ⇒ ::String

Returns The target flow to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

Note: The following fields are mutually exclusive: target_flow, target_page. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

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

    Note: The following fields are mutually exclusive: target_flow, target_page. If a field in that set is populated, all other fields in the set will automatically be cleared.



563
564
565
566
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 563

class KnowledgeConnectorSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#target_page ⇒ ::String

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

Note: The following fields are mutually exclusive: target_page, target_flow. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

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

    Note: The following fields are mutually exclusive: target_page, target_flow. If a field in that set is populated, all other fields in the set will automatically be cleared.



563
564
565
566
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 563

class KnowledgeConnectorSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#trigger_fulfillment ⇒ ::Google::Cloud::Dialogflow::CX::V3::Fulfillment

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



563
564
565
566
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 563

class KnowledgeConnectorSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end