Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3GenerativeSettingsKnowledgeConnectorSettings

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/representations.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 Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3GenerativeSettingsKnowledgeConnectorSettings

Returns a new instance of GoogleCloudDialogflowCxV3GenerativeSettingsKnowledgeConnectorSettings.



3724
3725
3726
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3724

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#agent ⇒ String

Name of the virtual agent. Used for LLM prompt. Can be left empty. Corresponds to the JSON property agent

Returns:

  • (String) 


3692
3693
3694
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3692

def agent
  @agent
end

#agent_identity ⇒ String

Identity of the agent, e.g. "virtual agent", "AI assistant". Corresponds to the JSON property agentIdentity

Returns:

  • (String) 


3697
3698
3699
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3697

def agent_identity
  @agent_identity
end

#agent_scope ⇒ String

Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner". Corresponds to the JSON property agentScope

Returns:

  • (String) 


3703
3704
3705
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3703

def agent_scope
  @agent_scope
end

#business ⇒ String

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

Returns:

  • (String) 


3709
3710
3711
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3709

def business
  @business
end

#business_description ⇒ String

Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans". Corresponds to the JSON property businessDescription

Returns:

  • (String) 


3715
3716
3717
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3715

def business_description
  @business_description
end

#disable_data_store_fallback ⇒ Boolean Also known as: disable_data_store_fallback?

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. Corresponds to the JSON property disableDataStoreFallback

Returns:

  • (Boolean) 


3721
3722
3723
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3721

def disable_data_store_fallback
  @disable_data_store_fallback
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3729
3730
3731
3732
3733
3734
3735
3736
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3729

def update!(**args)
  @agent = args[:agent] if args.key?(:agent)
  @agent_identity = args[:agent_identity] if args.key?(:agent_identity)
  @agent_scope = args[:agent_scope] if args.key?(:agent_scope)
  @business = args[:business] if args.key?(:business)
  @business_description = args[:business_description] if args.key?(:business_description)
  @disable_data_store_fallback = args[:disable_data_store_fallback] if args.key?(:disable_data_store_fallback)
end