Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig.
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
EngineService.GetEngine
or
EngineService.ListEngines
API after engine creation.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#business
defbusiness()->::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=
defbusiness=(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.
#default_language_code
defdefault_language_code()->::String
Returns
(::String) — Required. The default language of the agent as a language tag.
See Language
Support
for a list of the currently supported language codes.
#default_language_code=
defdefault_language_code=(value)->::String
Parameter
value (::String) — Required. The default language of the agent as a language tag.
See Language
Support
for a list of the currently supported language codes.
Returns
(::String) — Required. The default language of the agent as a language tag.
See Language
Support
for a list of the currently supported language codes.
#location
deflocation()->::String
Returns
(::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.
#location=
deflocation=(value)->::String
Parameter
value (::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.
Returns
(::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.
#time_zone
deftime_zone()->::String
Returns
(::String) — Required. The time zone of the agent from the time zone
database, e.g., America/New_York,
Europe/Paris.
#time_zone=
deftime_zone=(value)->::String
Parameter
value (::String) — Required. The time zone of the agent from the time zone
database, e.g., America/New_York,
Europe/Paris.
Returns
(::String) — Required. The time zone of the agent from the time zone
database, e.g., America/New_York,
Europe/Paris.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig (v0.21.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.21.0 (latest)](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Engine-ChatEngineConfig-AgentCreationConfig)\n- [0.20.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.20.1/Google-Cloud-DiscoveryEngine-V1beta-Engine-ChatEngineConfig-AgentCreationConfig)\n- [0.19.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.19.1/Google-Cloud-DiscoveryEngine-V1beta-Engine-ChatEngineConfig-AgentCreationConfig)\n- [0.18.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.18.0/Google-Cloud-DiscoveryEngine-V1beta-Engine-ChatEngineConfig-AgentCreationConfig)\n- [0.17.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.17.0/Google-Cloud-DiscoveryEngine-V1beta-Engine-ChatEngineConfig-AgentCreationConfig)\n- [0.16.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.16.0/Google-Cloud-DiscoveryEngine-V1beta-Engine-ChatEngineConfig-AgentCreationConfig)\n- [0.15.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.15.0/Google-Cloud-DiscoveryEngine-V1beta-Engine-ChatEngineConfig-AgentCreationConfig)\n- [0.14.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.14.2/Google-Cloud-DiscoveryEngine-V1beta-Engine-ChatEngineConfig-AgentCreationConfig)\n- [0.13.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.13.0/Google-Cloud-DiscoveryEngine-V1beta-Engine-ChatEngineConfig-AgentCreationConfig)\n- [0.12.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.12.0/Google-Cloud-DiscoveryEngine-V1beta-Engine-ChatEngineConfig-AgentCreationConfig)\n- [0.11.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.11.0/Google-Cloud-DiscoveryEngine-V1beta-Engine-ChatEngineConfig-AgentCreationConfig)\n- [0.10.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.10.0/Google-Cloud-DiscoveryEngine-V1beta-Engine-ChatEngineConfig-AgentCreationConfig)\n- [0.9.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.9.0/Google-Cloud-DiscoveryEngine-V1beta-Engine-ChatEngineConfig-AgentCreationConfig)\n- [0.8.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.8.0/Google-Cloud-DiscoveryEngine-V1beta-Engine-ChatEngineConfig-AgentCreationConfig)\n- [0.7.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.7.2/Google-Cloud-DiscoveryEngine-V1beta-Engine-ChatEngineConfig-AgentCreationConfig)\n- [0.6.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.6.0/Google-Cloud-DiscoveryEngine-V1beta-Engine-ChatEngineConfig-AgentCreationConfig)\n- [0.5.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.5.0/Google-Cloud-DiscoveryEngine-V1beta-Engine-ChatEngineConfig-AgentCreationConfig)\n- [0.4.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.4.0/Google-Cloud-DiscoveryEngine-V1beta-Engine-ChatEngineConfig-AgentCreationConfig)\n- [0.3.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.3.0/Google-Cloud-DiscoveryEngine-V1beta-Engine-ChatEngineConfig-AgentCreationConfig)\n- [0.2.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.2.1/Google-Cloud-DiscoveryEngine-V1beta-Engine-ChatEngineConfig-AgentCreationConfig)\n- [0.1.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.1.0/Google-Cloud-DiscoveryEngine-V1beta-Engine-ChatEngineConfig-AgentCreationConfig) \nReference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig.\n\nConfigurations for generating a Dialogflow agent.\n\n\n\u003cbr /\u003e\n\nNote that these configurations are one-time consumed by\nand passed to Dialogflow service. It means they cannot be retrieved using\n[EngineService.GetEngine](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-EngineService-Client#Google__Cloud__DiscoveryEngine__V1beta__EngineService__Client_get_engine_instance_ \"Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine (method)\")\nor\n[EngineService.ListEngines](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-EngineService-Client#Google__Cloud__DiscoveryEngine__V1beta__EngineService__Client_list_engines_instance_ \"Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines (method)\")\nAPI after engine creation. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #business\n\n def business() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.\n\n### #business=\n\n def business=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. \n**Returns**\n\n- (::String) --- Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.\n\n### #default_language_code\n\n def default_language_code() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The default language of the agent as a language tag. See [Language\n Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.\n\n### #default_language_code=\n\n def default_language_code=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The default language of the agent as a language tag. See [Language\nSupport](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. \n**Returns**\n\n- (::String) --- Required. The default language of the agent as a language tag. See [Language\n Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.\n\n### #location\n\n def location() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #location=\n\n def location=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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. \n**Returns**\n\n- (::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.\n\n### #time_zone\n\n def time_zone() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The time zone of the agent from the [time zone\n database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.\n\n### #time_zone=\n\n def time_zone=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The time zone of the agent from the [time zone\ndatabase](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. \n**Returns**\n\n- (::String) --- Required. The time zone of the agent from the [time zone\n database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris."]]