Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::GenerativeSettings::KnowledgeConnectorSettings (v0.24.2)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::GenerativeSettings::KnowledgeConnectorSettings.

Settings for knowledge connector. These parameters are used for LLM prompt like "You are

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#agent

def agent() -> ::String
Returns
  • (::String) — Name of the virtual agent. Used for LLM prompt. Can be left empty.

#agent=

def agent=(value) -> ::String
Parameter
  • value (::String) — Name of the virtual agent. Used for LLM prompt. Can be left empty.
Returns
  • (::String) — Name of the virtual agent. Used for LLM prompt. Can be left empty.

#agent_identity

def agent_identity() -> ::String
Returns
  • (::String) — Identity of the agent, e.g. "virtual agent", "AI assistant".

#agent_identity=

def agent_identity=(value) -> ::String
Parameter
  • value (::String) — Identity of the agent, e.g. "virtual agent", "AI assistant".
Returns
  • (::String) — Identity of the agent, e.g. "virtual agent", "AI assistant".

#agent_scope

def agent_scope() -> ::String
Returns
  • (::String) — Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner".

#agent_scope=

def agent_scope=(value) -> ::String
Parameter
  • value (::String) — Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner".
Returns
  • (::String) — Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner".

#business

def business() -> ::String
Returns
  • (::String) — Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.

#business=

def business=(value) -> ::String
Parameter
  • value (::String) — Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
Returns
  • (::String) — Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.

#business_description

def business_description() -> ::String
Returns
  • (::String) — Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans".

#business_description=

def business_description=(value) -> ::String
Parameter
  • value (::String) — Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans".
Returns
  • (::String) — Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans".