Class: Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig

Inherits:

Object

Object
Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/discoveryengine/v1/engine.rb

Overview

Configurations for a Chat Engine.

Defined Under Namespace

Classes: AgentCreationConfig

Instance Attribute Summary collapse

#agent_creation_config ⇒ ::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig
The configurationt generate the Dialogflow agent that is associated to this Engine.
#dialogflow_agent_to_link ⇒ ::String
The resource name of an exist Dialogflow agent to link to this Chat Engine.

Instance Attribute Details

#agent_creation_config ⇒ `::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig`

Returns The configurationt generate the Dialogflow agent that is associated to this Engine.

Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.

Returns:

(::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig) —
The configurationt generate the Dialogflow agent that is associated to this Engine.

Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.

# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 152

class ChatEngineConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for generating a Dialogflow agent.
  #
  # Note that these configurations are one-time consumed by
  # and passed to Dialogflow service. It means they cannot be retrieved using
  # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
  # or
  # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
  # API after engine creation.
  # @!attribute [rw] business
  #   @return [::String]
  #     Name of the company, organization or other entity that the agent
  #     represents. Used for knowledge connector LLM prompt and for knowledge
  #     search.
  # @!attribute [rw] default_language_code
  #   @return [::String]
  #     Required. The default language of the agent as a language tag.
  #     See [Language
  #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
  #     for a list of the currently supported language codes.
  # @!attribute [rw] time_zone
  #   @return [::String]
  #     Required. The time zone of the agent from the [time zone
  #     database](https://www.iana.org/time-zones), e.g., America/New_York,
  #     Europe/Paris.
  # @!attribute [rw] location
  #   @return [::String]
  #     Agent location for Agent creation, supported values: global/us/eu.
  #     If not provided, us Engine will create Agent using us-central-1 by
  #     default; eu Engine will create Agent using eu-west-1 by default.
  class AgentCreationConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#dialogflow_agent_to_link ⇒ `::String`

Returns The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide agent_creation_config to create agent or provide an agent name that links the agent with the Chat engine.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Note that the dialogflow_agent_to_link are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.