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.



3832
3833
3834
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3832

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

Instance Attribute Details

#agentString

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

Returns:

  • (String)


3800
3801
3802
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3800

def agent
  @agent
end

#agent_identityString

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

Returns:

  • (String)


3805
3806
3807
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3805

def agent_identity
  @agent_identity
end

#agent_scopeString

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)


3811
3812
3813
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3811

def agent_scope
  @agent_scope
end

#businessString

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)


3817
3818
3819
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3817

def business
  @business
end

#business_descriptionString

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

Returns:

  • (String)


3823
3824
3825
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3823

def business_description
  @business_description
end

#disable_data_store_fallbackBoolean 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)


3829
3830
3831
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3829

def disable_data_store_fallback
  @disable_data_store_fallback
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3837
3838
3839
3840
3841
3842
3843
3844
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 3837

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