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.



2864
2865
2866
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2864

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) 


2839
2840
2841
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2839

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) 


2844
2845
2846
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2844

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) 


2850
2851
2852
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2850

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) 


2856
2857
2858
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2856

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) 


2862
2863
2864
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2862

def business_description
  @business_description
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2869
2870
2871
2872
2873
2874
2875
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2869

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)
end