Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class AutomatedAgentConfig.
Defines the Automated Agent to connect to a conversation.
Generated from protobuf message google.cloud.dialogflow.v2.AutomatedAgentConfig
Namespace
Google \ Cloud \ Dialogflow \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ agent
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.
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.
getAgent
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
Type
Description
string
setAgent
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getSessionTtl
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.
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-04 UTC."],[],[],null,["# Google Cloud Dialogflow V2 Client - Class AutomatedAgentConfig (2.1.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.2 (latest)](/php/docs/reference/cloud-dialogflow/latest/V2.AutomatedAgentConfig)\n- [2.1.1](/php/docs/reference/cloud-dialogflow/2.1.1/V2.AutomatedAgentConfig)\n- [2.0.1](/php/docs/reference/cloud-dialogflow/2.0.1/V2.AutomatedAgentConfig)\n- [1.17.2](/php/docs/reference/cloud-dialogflow/1.17.2/V2.AutomatedAgentConfig)\n- [1.16.0](/php/docs/reference/cloud-dialogflow/1.16.0/V2.AutomatedAgentConfig)\n- [1.15.1](/php/docs/reference/cloud-dialogflow/1.15.1/V2.AutomatedAgentConfig)\n- [1.14.0](/php/docs/reference/cloud-dialogflow/1.14.0/V2.AutomatedAgentConfig)\n- [1.13.0](/php/docs/reference/cloud-dialogflow/1.13.0/V2.AutomatedAgentConfig)\n- [1.12.3](/php/docs/reference/cloud-dialogflow/1.12.3/V2.AutomatedAgentConfig)\n- [1.11.0](/php/docs/reference/cloud-dialogflow/1.11.0/V2.AutomatedAgentConfig)\n- [1.10.2](/php/docs/reference/cloud-dialogflow/1.10.2/V2.AutomatedAgentConfig)\n- [1.9.0](/php/docs/reference/cloud-dialogflow/1.9.0/V2.AutomatedAgentConfig)\n- [1.8.0](/php/docs/reference/cloud-dialogflow/1.8.0/V2.AutomatedAgentConfig)\n- [1.7.2](/php/docs/reference/cloud-dialogflow/1.7.2/V2.AutomatedAgentConfig)\n- [1.6.0](/php/docs/reference/cloud-dialogflow/1.6.0/V2.AutomatedAgentConfig)\n- [1.5.0](/php/docs/reference/cloud-dialogflow/1.5.0/V2.AutomatedAgentConfig)\n- [1.4.0](/php/docs/reference/cloud-dialogflow/1.4.0/V2.AutomatedAgentConfig)\n- [1.3.2](/php/docs/reference/cloud-dialogflow/1.3.2/V2.AutomatedAgentConfig)\n- [1.2.0](/php/docs/reference/cloud-dialogflow/1.2.0/V2.AutomatedAgentConfig)\n- [1.1.1](/php/docs/reference/cloud-dialogflow/1.1.1/V2.AutomatedAgentConfig)\n- [1.0.1](/php/docs/reference/cloud-dialogflow/1.0.1/V2.AutomatedAgentConfig) \nReference documentation and code samples for the Google Cloud Dialogflow V2 Client class AutomatedAgentConfig.\n\nDefines the Automated Agent to connect to a conversation.\n\nGenerated from protobuf message `google.cloud.dialogflow.v2.AutomatedAgentConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dialogflow \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getAgent\n\nRequired. ID of the Dialogflow agent environment to use.\n\nThis project needs to either be the same project as the conversation or you\nneed to grant `service-\u003cConversation Project\nNumber\u003e@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow API\nService Agent` role in this project.\n\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 specified, the default `draft` environment is used. Refer to [DetectIntentRequest](/dialogflow/docs/reference/rpc/google.cloud.dialogflow.v2#google.cloud.dialogflow.v2.DetectIntentRequest) for more details.\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 is used.\n\n### setAgent\n\nRequired. ID of the Dialogflow agent environment to use.\n\nThis project needs to either be the same project as the conversation or you\nneed to grant `service-\u003cConversation Project\nNumber\u003e@gcp-sa-dialogflow.iam.gserviceaccount.com` the `Dialogflow API\nService Agent` role in this project.\n\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 specified, the default `draft` environment is used. Refer to [DetectIntentRequest](/dialogflow/docs/reference/rpc/google.cloud.dialogflow.v2#google.cloud.dialogflow.v2.DetectIntentRequest) for more details.\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 is used.\n\n### getSessionTtl\n\nOptional. Configure lifetime of the Dialogflow session.\n\nBy default, a Dialogflow CX session remains active and its data is stored\nfor 30 minutes after the last request is sent for the session.\nThis value should be no longer than 1 day.\n\n### hasSessionTtl\n\n### clearSessionTtl\n\n### setSessionTtl\n\nOptional. Configure lifetime of the Dialogflow session.\n\nBy default, a Dialogflow CX session remains active and its data is stored\nfor 30 minutes after the last request is sent for the session.\nThis value should be no longer than 1 day."]]
