Deploy a Microsoft Bot Framework Endpoint

Description

This tutorial covers the necessary steps for creating and connecting a Microsoft Bot Framework Endpoint to Microsoft Bot Framework (Azure Bot Service). If you want more information about assigning a Flow to the Endpoint and setting up the Data Management see Endpoints.

๐Ÿ“˜

Whitelisting of URLs

The Microsoft Bot Framework Endpoint needs to make requests to the following domains. You can whitelist these in your proxy if necessary:

  • login.botframework.com/v1/.well-known/openidconfiguration
  • login.microsoftonline.com/botframework.com/oauth2/v2.0/token
  • *.botframework.com matching to the corresponding channel (e.g. msteams.botframework.com)

Setup Process

  1. Create a Microsoft Bot Framework in COGNIGY.AI
  2. Integrate the Microsoft Bot Framework Endpoint with your Bot Framework team
  3. Send messages to your Bot

1. Create a Microsoft Bot Framework Endpoint

Location: COGNIGY.AI

The first thing you need to do is to create a Microsoft Bot Framework Endpoint in COGNIGY.AI. In order to do this, navigate to your Project, click on the button in the lower left corner and create an Endpoint.

Creating a Microsoft Bot Framework EndpointCreating a Microsoft Bot Framework Endpoint

Creating a Microsoft Bot Framework Endpoint

After creating your Endpoint, you should be navigated to the Endpoint configuration of your Microsoft Bot Framework Endpoint. Here you need to set the Flow that the Endpoint should point to, and you can change the NLU Connector of the Endpoint.

A Created Bot Framework EndpointA Created Bot Framework Endpoint

A Created Bot Framework Endpoint

Now that you have created the Microsoft Bot Framework Endpoint, all that is left to do is to connect it to the Microsoft Bot Framework. The Microsoft Bot Framework Endpoint contains Microsoft Bot Framework Settings which are two settings we need in order to connect to the Endpoint of the Azure Bot Service. We will need:

  • The app ID of your bot in Azure Bot Service
  • A secret of your bot in Azure Bot Service

The next chapter will describe where you can find this setting in Microsoft Bot Framework.

2. Creating a bot in Azure Bot Service

Requirements
Endpoint URL

In order to create a bot in Azure Bot Service, log into the Azure portal and search for "Bot Service". Create a new bot and choose "Bot Channel Registration"

Creating a Bot Channel RegistrationCreating a Bot Channel Registration

Creating a Bot Channel Registration

Fill out the information on the next page depending on your preferred region, and put in the Endpoint URL you got in the last step as the Messaging endpoint

Adding the Endpoint URL to the botAdding the Endpoint URL to the bot

Adding the Endpoint URL to the bot

3. Connecting your Microsoft Bot Framework Endpoint to Azure Bot Service

COGNIGY.AI

Requirements
Endpoint URL
Bot in Azure Bot Service

To connect your Endpoint in COGNIGY.AI to the Azure Bot Service, we need the App ID and the App Password of the bot from Azure Bot Service. To get these, go to the Settings page of your bot in the Azure Bot Service Dashboard and find the Microsoft App ID of the bot. Copy the value and save it e.g. in a text editor. Afterwards, click on the link just above which says "Manage". This takes to you the App Registrations page for your bot where you can create a Client Secret. Create a secret and save it temporary e.g. in a text editor.

Client Secret for BotClient Secret for Bot

Client Secret for Bot

Now you have the App Id and the App Password (Client Secret) so you can open the Microsoft Bot Framework Endpoint in COGNIGY.AI and put in the values in the corresponding fields in the Bot Framework Settings Form.

Configuring the Endpoint with the app credentialsConfiguring the Endpoint with the app credentials

Configuring the Endpoint with the app credentials

You are now finished with connecting your Endpoint with Azure Bot Service! Link a channel to your bot in Azure Bot Service and talk to your Conversation AI in COGNIGY.AI


Did this page help you?