See the supported connectors for Application Integration.

Build conversational agents with Application Integration

Application Integration now simplifies the creation of conversational experiences by directly integrating with Conversational Agents (Dialogflow CX). This feature lets you to build intelligent chatbots and tools that enhance user interactions and automate tasks, directly from your integration workflows using API triggers.

What is a conversational agent?

A Conversational Agents (Dialogflow CX) conversational agent is a virtual agent that communicates in natural language conversations with users. It analyzes user input, interprets intent, and provides appropriate responses, enabling interactive and personalized conversational experiences. These agents are designed to handle conversations across various channels, such as websites, mobile apps, and messaging platforms.

What is a conversational agent tool?

In Conversational Agents (Dialogflow CX), a tool represents a specific functionality or service that the conversational agent can access. Tools are defined within playbooks and allow the agent to perform actions like retrieving data, executing APIs, or interacting with external systems. Application Integration generates these tools based on your integration's API triggers, making it easy to connect your integration logic to your conversational flows.

Before you begin

Ensure the following before creating a conversational agent tool using Application Integration:

Assign the following IAM roles to your principal:
- Service Account Admin (roles/iam.serviceAccountAdmin)
- Service Usage Admin (roles/serviceusage.serviceUsageAdmin)
- Dialogflow Console Agent Editor (roles/dialogflow.consoleAgentEditor)
For information on granting roles to principals, see Grant or revoke a single role.

IAM roles required for service accounts

The following IAM roles are required for the service accounts used to create a conversational agent tool:

Service account	Description	Required roles
Service account	Service account used to create the conversational agent tool.	Application Integration Invoker (`roles/integrations.integrationInvoker`)
Dialogflow service agent (`service-{$PROJECT_ID}@gcp-sa-dialogflow.iam.gserviceaccount.com`)	Service account used by Conversational Agents (Dialogflow CX) to access the integration.	Service Account Token Creator (`roles/iam.serviceAccountTokenCreator`)

Create a new conversational agent tool

To create a new conversational agent tool using Application Integration, perform the following steps:

In the Google Cloud console, go to the Application Integration page.
Go to Application Integration
In the navigation menu, click Integrations.
The Integrations page appears listing all the integrations available in the Google Cloud project.
Select an existing integration or click Create integration to create a new one.
If you are creating a new integration:
1. Enter a name and description in the Create Integration pane.
2. Select a region for the integration.
  Note: The Regions dropdown only lists the regions provisioned in your Google Cloud project. To provision a new region, Click Enable Region. See Enable new region for more information.
3. Select a service account for the integration. You can change or update the service account details of an integration any time from the Integration summary pane in the integration toolbar.
  Note: The option to select a service account is displayed only if you have enabled integration governance for the selected region.
4. Click Create.
  This opens the integration in the integration editor.
Select an existing integration. This opens the integration in the integration editor.
Ensure that the selected integration is configured with one or more API triggers.
Publish the integration version.
In the designer toolbar, click (Actions menu) and select Create Conversational Agent Tool.
Application Integration verifies that the required APIs are enabled. If not, you are prompted to enable them.
In the Create Conversational Agent Tool pane, provide the following inputs:
1. API Triggers: All the API triggers from your integration are selected by default. You can optionally deselect any API triggers that you don't want to include in the tool.
2. Type: Select Create new Conversational Agent and enter the following details:
  1. Region: Select the region for the agent.
  2. Agent name: Enter a name for the agent.
  3. Tool name: Enter a name for the tool.
3. Service account: Choose a service account with the necessary roles and permissions for the agent's resource access. If missing, you will be prompted to Grant them.
Click View spec to review the generated specification for the selected triggers. You can optionally edit the specification before saving.
Click Save.
A message appears indicating that the tool is created successfully. Click View to open the agent in the Conversational Agents (Dialogflow CX) console.
In the Conversational Agents (Dialogflow CX) console, go to Playbooks, click the playbook for the created agent, and add instructions to the playbook to use the tool. For more information, see Playbook tools.

Create a converstational agent tool using an existing agent

To create a conversational agent tool using an existing agent, perform the following steps:

In the Google Cloud console, go to the Application Integration page.
Go to Application Integration
In the navigation menu, click Integrations.
The Integrations page appears listing all the integrations available in the Google Cloud project.
Select an existing integration or click Create integration to create a new one.
If you are creating a new integration:
1. Enter a name and description in the Create Integration pane.
2. Select a region for the integration.
  Note: The Regions dropdown only lists the regions provisioned in your Google Cloud project. To provision a new region, Click Enable Region. See Enable new region for more information.
3. Select a service account for the integration. You can change or update the service account details of an integration any time from the Integration summary pane in the integration toolbar.
  Note: The option to select a service account is displayed only if you have enabled integration governance for the selected region.
4. Click Create.
  This opens the integration in the integration editor.
Select an existing integration. This opens the integration in the integration editor.
Ensure that the selected integration is configured with one or more API triggers.
Publish the integration version.
In the designer toolbar, click (Actions menu) and select Create Conversational Agent Tool.
Application Integration verifies that the required APIs are enabled. If not, you are prompted to enable them.
In the Create Conversational Agent Tool pane, provide the following inputs:
1. API Triggers: All the API triggers from your integration are selected by default. You can optionally deselect any API triggers that you don't want to include in the tool.
2. Type: Select Choose existing Conversational Agent and do the following:
  1. Conversational Agent: A list of available agents in your project appears. Select the agent you want to use.
  2. Tool: Select either Create new Tool or Choose existing Tool.
    If you select Create new Tool, enter a name for the tool.
    
    If you select Choose existing Tool, a list of available tools in the selected agent appears. Select the tool you want to use.
3. Service account: Choose a service account with the necessary roles and permissions for the agent's resource access. If missing, you will be prompted to Grant them.
Click View spec to review the generated specification for the selected triggers. You can optionally edit the specification before saving.
Click Save.
A message appears indicating that the tool is created successfully. Click View to open the agent in the Conversational Agents (Dialogflow CX) console.
In the Conversational Agents (Dialogflow CX) console, go to Playbooks, click the playbook for the created agent, and add instructions to the playbook to use the tool. For more information, see Playbook tools.

Considerations

The following considerations apply when using conversational agent tools:

Conversational agent tools can only be created for published integrations with API triggers.
Review and test your agent in the Conversational Agents (Dialogflow CX) console after creation.