Skip to content
This repository has been archived by the owner on Apr 6, 2021. It is now read-only.

Latest commit

 

History

History
241 lines (162 loc) · 7.1 KB

README.md

File metadata and controls

241 lines (162 loc) · 7.1 KB

Ada

Ada is an OpenSource project by the Microsoft Innovation Center designed to demonstrate how users can interact in a human way with machines. This is a Windows 10 application that uses the Vision API's of the Microsoft Cognitive Services to recognize, understand and talk to our visitors.

https://www.microsoft.com/cognitive-services/en-us/apis

Have fun !

Deployment

Microsoft Cognitive Services

The first step to deploy the web application is to subscribe to Microsoft Cognitive Services Face, Emotion and ComputerVision apis and get keys.(https://www.microsoft.com/cognitive-services/en-us/)

On Microsoft Cognitive Face web console (https://goo.gl/afkZ6R), create a new persons group with a generated guid as group id.

Web application + SQL Database

The next step is to deploy WebApp + SQL services and make this configuration :

In web application → Application Settings → App settings, the value of this keys must be set :

  • OxfordFaceApiKey : The key of the Microsoft Cognitive Face api
  • OxfordEmotionApiKey : The key of the Microsoft Cognitive Emotion api
  • OxfordPersonGroupId : The id of person group created on Microsoft Cognitive Face api
  • Host : the full address of the website (ex : http://mywebsite.azurewebsites.net)

Warning : The keys are case sensitive !

In the Connection strings section, set the connection string to sql database with DefaultConnection as key.

A little more configuration

The default roles and users are created while the first migration of database. To edit them before publish the first time, go to Migrations → Configuration.cs → Seed method.

Warning : Don't forget to adapt credentials of client application if you edit the martineobot user on server

It's possible to personalize the destination of temporary uploaded files and person's picture location in the Global.cs file.

ApplicationInsight

To use ApplicationInsight, right clic on project → ApplicationInsight → configure → follow the wizard.

Publication on azure

To deploy the application on azure :

Right clic on project → publish In the wizard, select the azure resource, select database and check pre-compile and migration checkbox. Publish.

Warning : Sometime the seed method doesn't run and you need to do it manually. You just need to make a migration for that.

Application UWP

To use the UWP application you need to add a class named : AppConfig.cs directly in the UWP project.

The class is used for the URL and the login to the web application.

And you need to add the secret key for the DirectLine from the botFramework website.

The class must be like :

using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace AdaW10
{
    public static class AppConfig
    {
#if DEBUG
        public static readonly string WebUri = "";      // WebApp URL for Test
#else
        public static readonly string WebUri = "";      // WebApp URL fro Prod
#endif
        public static readonly string UserName = "";    // Use to get the API token
        public static readonly string Password = "";
    
    public static readonly string DirectLine = "";
    }
}

Bot

Step 1

The first step to deploy the bot is to import the 2 different Luis in your Luis account (they are in the folder Luis).

And deploy the 2 Luis in azure :

And you need to make a QnA Maker and get keys. (https://qnamaker.ai/)

Step 2

Now you need to deploy the bot on azure. For that you need to create a new web app and publish the bot on this web app.

Step 3

You need to register your bot on the bot framework website : https://dev.botframework.com.

Step 4

-After that you need to add a file AppSettings.config.

<?xml version="1.0"?>

<appSettings>
  
	<!-- Keys for BotFramework -->  
	<add key="BotId" value="" />
	<add key="MicrosoftAppId" value="" />  
	<add key="MicrosoftAppPassword" value="" />

	<!-- Keys for LUIS Ada-->
 	<add key="ModelId" value=""/>  
	<add key="SubscriptionKey" value=""/> 

   <!-- Keys for LUIS trivial-->
   <add key="ModelIdTrivial" value=""/>  
	<add key="SubscriptionKeyTrivial" value=""/>
   
	<!-- URI for bot -->
 	<add key="WebAppUrl" value="" /> <!--Use for the picture-->
 	<add key="Username" value =""/>
 	<add key="Password" value =""/>
   
   <!-- Key for Computer Vision-->
 	<add key="VisionApiKey" value="" />
 	<add key="FaceApiKey" value="" />

 	<!-- Key for qna Maker FAQ-->
 	<add key="QnASubscriptionKey" value="" />
 	<add key="QnAKnowledgebaseId" value="" />
   
   <!-- Key for DirectLine-->
 	<add key="DirectLineKey" value="6uKJqzI_1zs.cwA.wXA.5rIOFgP9EsTrV8PTnWbF2Rfs7w5uNVGRwCiizuT7ux4" />
  
	<add key="FaceBook" value="" /> <!--Link to the Facebook page-->
	<add key="Youtube" value="" /> <!--Link to the youtube page-->  
	<add key="Meetup" value="" /> <!--Link to the meetup page-->
	<add key="Linkedin" value="" /> <!--Link to the linkedin page-->
	<add key="Twitter" value/> <!--Link to the twitter page-->
	<add key="Site" value="" /> <!--Link to the website-->   
</appSettings>

Step 5

If you want to use the bot on facebook messenger or an other application allow by the bot framework. You just need to login to the bot framework's website and follow the different step to add the bot in the application.

Persistent menu on Facebook

On Facebook you can have a persistent menu and a button start for your bot.

First : the start button

For this button you need to send a post request to Facebook (you can do it with postman).

You can find your Access Token on your facebook developer account. The page ID is in your parameter in the facebook page of your app.

https://graph.facebook.com/v2.6/YOUR_PAGE_ID/thread_settings?access_token=PAGE_ACCESS_TOKEN


{
 "setting_type":"call_to_actions",
 "thread_state":"new_thread",
 "call_to_actions":[
   {
     "payload":"Bonjour"
   }
 ]
}

Second : the persistent menu

It's the same but the body of the request is different.

https://graph.facebook.com/v2.6/YOUR_APP_ID/thread_settings?access_token=PAGE_ACCESS_TOKEN

{
   "setting_type" : "call_to_actions",
  "thread_state" : "existing_thread",
 "locale":"default",
 "composer_input_disabled":false,
 "call_to_actions":[
    {
      "title":"Que fait Ada?",
      "type":"postback",
      "payload":"Tu sais faire quoi?"
    },
     {
      "title":"Evénements MIC",
      "type":"postback",
      "payload":"On fait un truc?"
    },
    {
      "title":"Informations",
      "type":"postback",
      "payload":"help"
    }
  ]
}