Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3GenerativeSettingsKnowledgeConnectorSettings
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3GenerativeSettingsKnowledgeConnectorSettings
- 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
-
#agent ⇒ String
Name of the virtual agent.
-
#agent_identity ⇒ String
Identity of the agent, e.g.
-
#agent_scope ⇒ String
Agent scope, e.g.
-
#business ⇒ String
Name of the company, organization or other entity that the agent represents.
-
#business_description ⇒ String
Company description, used for LLM prompt, e.g.
-
#disable_data_store_fallback ⇒ Boolean
(also: #disable_data_store_fallback?)
Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer).
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3GenerativeSettingsKnowledgeConnectorSettings
constructor
A new instance of GoogleCloudDialogflowCxV3GenerativeSettingsKnowledgeConnectorSettings.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3GenerativeSettingsKnowledgeConnectorSettings
Returns a new instance of GoogleCloudDialogflowCxV3GenerativeSettingsKnowledgeConnectorSettings.
3207 3208 3209 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3207 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
3175 3176 3177 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3175 def agent @agent end |
#agent_identity ⇒ String
Identity of the agent, e.g. "virtual agent", "AI assistant".
Corresponds to the JSON property agentIdentity
3180 3181 3182 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3180 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
3186 3187 3188 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3186 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
3192 3193 3194 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3192 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
3198 3199 3200 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3198 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
3204 3205 3206 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3204 def disable_data_store_fallback @disable_data_store_fallback end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3212 3213 3214 3215 3216 3217 3218 3219 |
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3212 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 |