Dialogflow

Turn your exisiting Dialogflow project into Virbe.

Import Google Dialogflow ES chatbot

If you want to use Dialogflow ES chatbot as Conversational AI for your Virbe you need to create or use an existing GCP service account and import the access credentials into your Virbe Dashboard.

Check your Dialogflow project ID

Head out to Dialogflow ES console and check your Agent settings.

Copy your Project ID from the "General" tab and head on to our Virbe Dashboard (e.g. https://being-name-your-organization.virbe.app/dashboard/conversation-engine/edit) then paste your Project ID into the Virbe Dashboard.

Come back to your Dialogflow console and this time click on the Project ID to navigate into Google Cloud Console. Head on to the next section Generate a GCP Service Account Key (JSON)

Generate a GCP Service Account Key (JSON)

Once you're logged into Google Cloud Platform, head out to the Service accounts section.

Create a new Service Account with permission to Dialogflow integration or use an existing one defined in your Dialogflow project. Having done that, click on the "Manage Keys" in drop-down menu to the right. Then use the key in the Virbe Dashboard.

Use an existing key or create a new JSON key and save it on your computer (NOTE. You can invalidate an old Key at any time and import a new one into the Virbe dashboard).

Open the JSON Key on your computer in any editor you like (e.g. Notepad or IDE) and copy-paste the contents into the Virbe Dashboard.

Do not worry, this content is stored only in your dedicated cloud container. Only people you authorize will have access to its content. At any point, you can invalidate it into the Google Cloud Console.

Once you do the above please use the built-in web widget to test your configuration. If you've done everything right you should see and hear the response. If you haven't, your Virbe will let you know that something went wrong.

For any issues with the above sections please refer to the original Dialogflow setup documentation or contact our support through our Discord or email: hello@virbe.ai

(Advanced) Virbe Behaviours and UI components

If you want to add Behaviours to your Virbe (e.g. gestures and emotions) or custom UI, you can do so by adding a Custom Payload to your Virbe's responses.

If you add or reorder the Custom Payload, so it's returned before the text, then it will be played at the beginning of your Virbe's Speech. If you add it after, then Behaviours and UI components will be displayed after the Virbe stops speaking the text.

Here's the sample JSON, which works with our Web, Unity, and Unreal integrations.

{
  "payload": "virbe",
  "action": "shop_item",
  "data": {
    "behaviours": [
      {
        "type": "gesture",
        "duration": 2000,
        "name": "you"
      }
    ],
    "ui": [
      {
        "type": "button",
        "title": "Yes",
        "payload": "Yes"
      },
      {
        "type": "button",
        "title": "No",
        "payload": "No"
      },
      {
        "type": "card",
        "title": "Jacket",
        "image": "https://virbe-shop-demo-bucket.s3.eu-central-1.amazonaws.com/hitoshi-namura-kRO6Uxe0ZFI-unsplash-1603121847489.jpg",
        "price": "100$",
        "payload": "/addtobasket"
      }
    ]
  }
}

If you add this, it will enable your Virbe to do the following:

  • play "you" animation, so your Virbe will point to the user

  • display two quick reply buttons: "Yes" and "No"

  • display a rich card with a title, price, and an image

Virbe Behaviours and UI components in Custom Payload

To learn how to use Custom payload to customize Virbe plugins check out the general section on Virbe Behaviours and UI Components

(Sample) Try out Dialogflow Virbe Sample Project

Coming soon

Last updated