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

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

Overview

Settings for knowledge connector. These parameters are used for LLM prompt like "You are . You are a helpful and verbose at , . Your task is to help humans on ".

Instance Attribute Summary collapse

Instance Attribute Details

#agent ⇒ ::String

Returns Name of the virtual agent. Used for LLM prompt. Can be left empty.

Returns:

  • (::String) —

    Name of the virtual agent. Used for LLM prompt. Can be left empty.



104
105
106
107
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/generative_settings.rb', line 104

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

#agent_identity ⇒ ::String

Returns Identity of the agent, e.g. "virtual agent", "AI assistant".

Returns:

  • (::String) —

    Identity of the agent, e.g. "virtual agent", "AI assistant".



104
105
106
107
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/generative_settings.rb', line 104

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

#agent_scope ⇒ ::String

Returns Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner".

Returns:

  • (::String) —

    Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner".



104
105
106
107
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/generative_settings.rb', line 104

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

#business ⇒ ::String

Returns Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.

Returns:

  • (::String) —

    Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.



104
105
106
107
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/generative_settings.rb', line 104

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

#business_description ⇒ ::String

Returns Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans".

Returns:

  • (::String) —

    Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans".



104
105
106
107
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/generative_settings.rb', line 104

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

#disable_data_store_fallback ⇒ ::Boolean

Returns Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer). Per default the feature is enabled.

Returns:

  • (::Boolean) —

    Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer). Per default the feature is enabled.



104
105
106
107
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/generative_settings.rb', line 104

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