/RoastOrToastChatBot

Primary LanguageC#

Roast or Toast ChatBot

A ChatBot Integrating LUIS Machine-Learning to Insult or Compliment a User Based on their typed Utterance, 1/28/21

By Eric Endsley, Joe Nero, Eric Stratton, and Austin Schrader

Table of Contents generated with DocToc

🔥 Description 🥂

This is a ChatBot developed using the Microsoft Bot Framework & integrating LUIS machine-learning to determine whether a user will recieve a roast (insult) or a toast (compliment) from the bot. The roasts and toasts themselves are generated by querying one of two APIs which can be found in the technologies section. The bot uses LUIS language interpretation to ascertain whether A. A user has explicitly requested a roast or toast or B. A user is being hostile or friendly to the bot. A user who requests a roast or toast will recieve one, while a hostile or friendly user will receive a roast or toast respectively.

👀 Visit The Bot's Live Page

As an alternative to running the bot locally and sending it utterances in the emulator, you may visit the bot's live page at the following link :

Roast or Toast Bot's Live Page

🔧 Setup: Follow these instructions to download the software packages needed to run the bot locally.

Install .NET Core

  1. This program is written in C# and requires the .NET Core to run locally. For PC users click this link and follow the installation instructions. For Mac users click this link and follow the installation instructions.

  2. Install dotnet script by entering the following command in your terminal: "dotnet tool install -g dotnet-script"

  3. Install the Microsoft Bot Framework Emulator at This Link. Ensure that you download version 4.3.0 or greater.

Follow these instructions to clone & run the application locally using terminal commands.

  1. Enter the following command into your terminal program to clone the repo into a directory of your choice :

       git clone https://github.com/joey3001/RoastOrToastChatBot.git

  2. Run a bash terminal inside the directory /RoastOrToastBot in the newly cloned respository.

  3. In the terminal, type the command "dotnet run".

Test the Bot Using Bot Framework Emulator

  1. Open the Bot FrameWork Emulator Program. If you haven't installed it, you can do so at this link.

  2. Select "Open Bot" on the home page of the emulator.

  3. Enter "http://localhost:3978/api/messages" for the Bot URL and press "Connect."

  4. Enjoy chatting with your bot!

🛠️ Technologies Used

  • LUIS.ai Machine Learning
  • Microsoft Bot Framework
  • Microsoft Azure
  • Microsoft Teams
  • Newtonsoft Json.Net
  • REST APIs
  • C# V7.3
  • .NET Core V2.2
  • dotnet script REPL
  • VSCode
  • Git
  • Github
  • Git Bash

🐛 Known Bugs

There are no known bugs at this time.

📫 Contact Information

To ask questions or report a bug, contact :

📘 Legal

MIT License

Copyright (c) 2021 Joseph Nero, Eric Endsley, Eric Stratton, Austin Schrader.

📖 Further Reading