Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::AutomatedAgentConfig.
Defines the Automated Agent to connect to a conversation.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#agent
defagent()->::String
Returns
(::String) —
Required. ID of the Dialogflow agent environment to use.
This project needs to either be the same project as the conversation or you
need to grant service-<Conversation Project
Number>@gcp-sa-dialogflow.iam.gserviceaccount.com the Dialogflow API
Service Agent role in this project.
For ES agents, use format: projects/<Project ID>/locations/<Location
ID>/agent/environments/<Environment ID or '-'>. If environment is not
specified, the default draft environment is used. Refer to
DetectIntentRequest
for more details.
For CX agents, use format projects/<Project ID>/locations/<Location
ID>/agents/<Agent ID>/environments/<Environment ID
or '-'>. If environment is not specified, the default draft environment
is used.
#agent=
defagent=(value)->::String
Parameter
value (::String) —
Required. ID of the Dialogflow agent environment to use.
This project needs to either be the same project as the conversation or you
need to grant service-<Conversation Project
Number>@gcp-sa-dialogflow.iam.gserviceaccount.com the Dialogflow API
Service Agent role in this project.
For ES agents, use format: projects/<Project ID>/locations/<Location
ID>/agent/environments/<Environment ID or '-'>. If environment is not
specified, the default draft environment is used. Refer to
DetectIntentRequest
for more details.
For CX agents, use format projects/<Project ID>/locations/<Location
ID>/agents/<Agent ID>/environments/<Environment ID
or '-'>. If environment is not specified, the default draft environment
is used.
Returns
(::String) —
Required. ID of the Dialogflow agent environment to use.
This project needs to either be the same project as the conversation or you
need to grant service-<Conversation Project
Number>@gcp-sa-dialogflow.iam.gserviceaccount.com the Dialogflow API
Service Agent role in this project.
For ES agents, use format: projects/<Project ID>/locations/<Location
ID>/agent/environments/<Environment ID or '-'>. If environment is not
specified, the default draft environment is used. Refer to
DetectIntentRequest
for more details.
For CX agents, use format projects/<Project ID>/locations/<Location
ID>/agents/<Agent ID>/environments/<Environment ID
or '-'>. If environment is not specified, the default draft environment
is used.
#session_ttl
defsession_ttl()->::Google::Protobuf::Duration
Returns
(::Google::Protobuf::Duration) — Optional. Configure lifetime of the Dialogflow session.
By default, a Dialogflow CX session remains active and its data is stored
for 30 minutes after the last request is sent for the session.
This value should be no longer than 1 day.
value (::Google::Protobuf::Duration) — Optional. Configure lifetime of the Dialogflow session.
By default, a Dialogflow CX session remains active and its data is stored
for 30 minutes after the last request is sent for the session.
This value should be no longer than 1 day.
Returns
(::Google::Protobuf::Duration) — Optional. Configure lifetime of the Dialogflow session.
By default, a Dialogflow CX session remains active and its data is stored
for 30 minutes after the last request is sent for the session.
This value should be no longer than 1 day.
[[["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-09 UTC."],[],[],null,["# Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::AutomatedAgentConfig (v1.10.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.10.1 (latest)](/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [1.10.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.10.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [1.9.1](/ruby/docs/reference/google-cloud-dialogflow-v2/1.9.1/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [1.8.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.8.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [1.7.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.7.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [1.6.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.6.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [1.5.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.5.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [1.4.1](/ruby/docs/reference/google-cloud-dialogflow-v2/1.4.1/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [1.3.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.3.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [1.2.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.2.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [1.1.1](/ruby/docs/reference/google-cloud-dialogflow-v2/1.1.1/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [1.0.0](/ruby/docs/reference/google-cloud-dialogflow-v2/1.0.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.34.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.34.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.33.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.33.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.32.2](/ruby/docs/reference/google-cloud-dialogflow-v2/0.32.2/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.31.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.31.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.30.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.30.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.29.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.29.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.28.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.28.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.27.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.27.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.26.2](/ruby/docs/reference/google-cloud-dialogflow-v2/0.26.2/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.25.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.25.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.24.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.24.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.23.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.23.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.22.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.22.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.21.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.21.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.20.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.20.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.19.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.19.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.18.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.18.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.17.1](/ruby/docs/reference/google-cloud-dialogflow-v2/0.17.1/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.16.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.16.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.15.2](/ruby/docs/reference/google-cloud-dialogflow-v2/0.15.2/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.14.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.14.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.13.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.13.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig)\n- [0.12.0](/ruby/docs/reference/google-cloud-dialogflow-v2/0.12.0/Google-Cloud-Dialogflow-V2-AutomatedAgentConfig) \nReference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::AutomatedAgentConfig.\n\nDefines the Automated Agent to connect to a conversation. \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### #agent\n\n def agent() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. ID of the Dialogflow agent environment to use.\n\n This project needs to either be the same project as the conversation or you\n need to grant `service-\u003cConversation Project\n Number\u003e@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow API\n Service Agent` role in this project.\n - For ES agents, use format: `projects/\u003cProject ID\u003e/locations/\u003cLocation\n ID\u003e/agent/environments/\u003cEnvironment ID or '-'\u003e`. If environment is not\n specified, the default `draft` environment is used. Refer to\n [DetectIntentRequest](/dialogflow/docs/reference/rpc/google.cloud.dialogflow.v2#google.cloud.dialogflow.v2.DetectIntentRequest)\n for more details.\n\n - For CX agents, use format `projects/\u003cProject ID\u003e/locations/\u003cLocation\n ID\u003e/agents/\u003cAgent ID\u003e/environments/\u003cEnvironment ID\n or '-'\u003e`. If environment is not specified, the default `draft` environment\n is used.\n\n### #agent=\n\n def agent=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) ---\n\n Required. ID of the Dialogflow agent environment to use.\n\n This project needs to either be the same project as the conversation or you\n need to grant `service-\u003cConversation Project\n Number\u003e@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow API\n Service Agent` role in this project.\n - For ES agents, use format: `projects/\u003cProject ID\u003e/locations/\u003cLocation\n ID\u003e/agent/environments/\u003cEnvironment ID or '-'\u003e`. If environment is not\n specified, the default `draft` environment is used. Refer to\n [DetectIntentRequest](/dialogflow/docs/reference/rpc/google.cloud.dialogflow.v2#google.cloud.dialogflow.v2.DetectIntentRequest)\n for more details.\n\n - For CX agents, use format `projects/\u003cProject ID\u003e/locations/\u003cLocation\n ID\u003e/agents/\u003cAgent ID\u003e/environments/\u003cEnvironment ID\n or '-'\u003e`. If environment is not specified, the default `draft` environment\n is used.\n\n**Returns**\n\n- (::String) --- Required. ID of the Dialogflow agent environment to use.\n\n This project needs to either be the same project as the conversation or you\n need to grant `service-\u003cConversation Project\n Number\u003e@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow API\n Service Agent` role in this project.\n - For ES agents, use format: `projects/\u003cProject ID\u003e/locations/\u003cLocation\n ID\u003e/agent/environments/\u003cEnvironment ID or '-'\u003e`. If environment is not\n specified, the default `draft` environment is used. Refer to\n [DetectIntentRequest](/dialogflow/docs/reference/rpc/google.cloud.dialogflow.v2#google.cloud.dialogflow.v2.DetectIntentRequest)\n for more details.\n\n - For CX agents, use format `projects/\u003cProject ID\u003e/locations/\u003cLocation\n ID\u003e/agents/\u003cAgent ID\u003e/environments/\u003cEnvironment ID\n or '-'\u003e`. If environment is not specified, the default `draft` environment\n is used.\n\n### #session_ttl\n\n def session_ttl() -\u003e ::Google::Protobuf::Duration\n\n**Returns**\n\n- ([::Google::Protobuf::Duration](./Google-Protobuf-Duration)) --- Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow CX session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.\n\n### #session_ttl=\n\n def session_ttl=(value) -\u003e ::Google::Protobuf::Duration\n\n**Parameter**\n\n- **value** ([::Google::Protobuf::Duration](./Google-Protobuf-Duration)) --- Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow CX session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day. \n**Returns**\n\n- ([::Google::Protobuf::Duration](./Google-Protobuf-Duration)) --- Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow CX session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day."]]