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.



3202
3203
3204
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3202

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) 


3177
3178
3179
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3177

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) 


3182
3183
3184
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3182

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) 


3188
3189
3190
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3188

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) 


3194
3195
3196
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3194

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) 


3200
3201
3202
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3200

def business_description
  @business_description
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3207
3208
3209
3210
3211
3212
3213
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3207

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