Dialogflow V1 to V2 Migration Guide

❗️

Dialogflow is shutting down the Dialogflow V1 API on October 23, 2019

If you do not take action, bots using these features will not function as expected.

Impact

Meya bots that use these features are impacted by this change:

• the api.ai NLU provider
• the api_ai trigger
• the meya.api_ai component

Action required

At a high level, the following actions are necessary (detailed instructions can be found below):

• Convert the Dialogflow V1 agent to a V2 agent from your Dialogflow console.
• Add the Dialogflow V2 integration to any bots that require Dialogflow.
• In CMS spaces that use the api.ai NLU provider, use the dialogflow provider instead.
• Replace all api_ai triggers with dialogflow triggers.
• Replace all meya.api_ai components with meya.dialogflow components.

📘

If you have any questions regarding these changes, please do not hesitate to reach out to us via your dedicated Slack channel or at [email protected].

Convert your V1 agent to a V2 agent

Before executing these steps, it is highly recommended that you review this Dialogflow documentation to see if there are any additional nuances you need to consider prior to migrating your agent to V2: https://dialogflow.com/docs/reference/v1-v2-migration-guide

1. After reviewing the above documentation, go to your Dialogflow agent’s settings (click the gear icon)
2. In the API Version section, select V2 API.
3. Acknowledge the pop-up.
4. Click Save.

Add the Dialogflow V2 integration to your bot

For each bot that uses Dialogflow in any way, you will need to add the Dialogflow integration. Complete the Dialogflow integration setup instructions found here: Dialogflow V2 Integration Setup Instructions

Switch NLU providers

1. For each bot, go to the Bot CMS tab and review each space to see if it uses the api.ai NLU provider (look for spaces that have inputs).
2. Click the edit icon next to the NLU provider (the pencil icon).
3. From the drop-down, choose dialogflow and paste the project_id which can be found on the agent’s settings page in your Dialogflow console.
4. Click Save.

Replace api_ai triggers

1. For every flow that uses an api_ai trigger, open the trigger settings by clicking the pencil icon to the right of the trigger in Bot Studio.
2. From the drop-down, select dialogflow.
3. Paste the project_id which can be found on the agent’s settings page in your Dialogflow console.
4. Fill in other fields as necessary.
5. Click Save.

Replace meya.api_ai components

1. For every flow that uses the meya.api_ai component, make the following edits:

where <YOUR_PROJECT_ID> is your agent’s project_id found on the agent’s settings page in your Dialogflow console.
2. Save the flow.

👍

Done!

Your bot is now compatible with the Dialogflow V2 API.

🚧

Test your changes

For each bot to which you made these changes, it is highly recommended that, at a minimum, you test the impacted flows to ensure they are working as expected.

The cms_nlu trigger, meya.cms_text, and meya.input_cms components

If you are using the cms_nlu trigger, the meya.cms_text component, or the meya.input_cms component, they may remain as is. Switching to the dialogflow NLU provider will ensure that these features continue to work.

Troubleshooting and support

Before contacting support, please review the above instructions and ensure they were completed accurately, as there are quite a few steps to take.

If you are certain you completed the above steps properly, but your bot is no longer working as expected, feel free to reach out to us via your dedicated Slack channel, or at [email protected]. We’ll be happy to assist.