ed-chatbot

Service created on Microsoft Azure on region canadacentral-01

• https://ed-chatbot-ekbfcvcae3epdrgr.canadacentral-01.azurewebsites.net/

Chatbot is to be deployed as subject tutors

To install dependencies use pip install -r requirements.txt

To run the project locally use uvicorn main:app --reload

To check the fastapi performace use ngrok ngrok http 8000

Use flask to run project python app.py

Chatbot Deployment Guide

This README provides a step-by-step guide on how to host and deploy your chatbot on Microsoft Teams and Google Chat.

Table of Contents

• Prerequisites
• Hosting on Microsoft Teams
  • Step 1: Create a Microsoft Teams App
  • Step 2: Register Your Bot with Azure Bot Service
  • Step 3: Set Up Your Bot's Endpoint
  • Step 4: Test Your Bot in Microsoft Teams
• Hosting on Google Chat
  • Step 1: Create a Google Cloud Project
  • Step 2: Enable Google Chat API
  • Step 3: Deploy Your Bot
  • Step 4: Test Your Bot in Google Chat
• Conclusion

Prerequisites

• An active account with Microsoft Azure.
• An active Google Cloud account.
• Basic understanding of how to work with APIs and webhooks.
• Your chatbot code deployed and accessible over the internet (e.g., using services like Heroku, AWS, or ngrok for local testing).

Hosting on Microsoft Teams

Step 1: Create a Microsoft Teams App

1. Go to the Microsoft Teams Developer Portal and sign in.
2. Click on Apps and select Create a new app.
3. Fill in the app details (name, description, icons).
4. Add Bot as a capability and configure your bot settings.

Step 2: Register Your Bot with Azure Bot Service

1. Visit the Azure Portal.
2. Search for Bot Services and create a new bot registration.
3. Enter your bot’s name, messaging endpoint, and select the appropriate pricing tier.
4. Save the App ID and generate a password (client secret) for authentication.

Step 3: Set Up Your Bot's Endpoint

1. Ensure your bot's server is deployed and accessible.
2. Update the messaging endpoint in Azure Bot Service with your bot’s URL (e.g., https://<your_ngrok_subdomain>.ngrok.io/chat).

Step 4: Test Your Bot in Microsoft Teams

1. Use the App Studio in Microsoft Teams to add your bot to a team or a chat.
2. Send messages to your bot and check its responses.
3. Monitor logs in your bot’s server for any errors.

Hosting on Google Chat

Step 1: Create a Google Cloud Project

1. Go to the Google Cloud Console.
2. Click on Select a Project and then New Project.
3. Name your project and enable billing.

Step 2: Enable Google Chat API

1. In your Google Cloud project, navigate to APIs & Services > Library.
2. Search for Google Chat API and enable it for your project.

Step 3: Deploy Your Bot

1. Navigate to APIs & Services > Credentials.
2. Create credentials for a Service Account and generate a private key (JSON format).
3. Use Google Cloud Functions or App Engine to deploy your chatbot code. Ensure that the webhook endpoint is properly set.

Step 4: Test Your Bot in Google Chat

1. Go to Google Chat and invite your bot to a chat room or start a direct message with it.
2. Test the bot by sending messages and verifying its responses.
3. Check your server logs for any issues.

Conclusion

You have successfully hosted your chatbot on both Microsoft Teams and Google Chat. Make sure to continuously monitor and improve your bot based on user feedback. For further enhancements, explore additional capabilities provided by both platforms.