ELTE Student Chatbot 🚀
This project builds a chatbot to empower ELTE students with self-service information access. Trained on official documents (rules, scholarships etc.), the chatbot leverages GPT technology to answer frequently asked questions, alleviating pressure on the student coordinator and improving student experience.
Before you dive in, ensure you have these tools installed:
- Visual Studio Code
- Teams Toolkit
- Node.js
- Microsoft Teams
- Web browser (Microsoft Edge or Google Chrome)
- Clone the Project: Clone the project repository using Git.
- Open the Teams Chatbot Folder: Within VS Code, open only the
teams_chatbotfolder. Not the full project. - Sign in to Teams Toolkit: Locate the Teams Toolkit extension in the VS Code left sidebar and sign in to your Microsoft 365 account (no developer sandbox required).
- Install Dependencies: Open the integrated terminal in VS Code, navigate to the project directory using
cd /path/to/project(replace with your actual path) and runnpm ito install dependencies. - Run Locally: Go to "Development" in Teams Toolkit and select "Preview Your Teams App" to launch the app for testing in a browser or testing tool.
- Deploy to Teams (Optional): For direct use in Teams, create a deployable package. Navigate to "Utility" in Teams Toolkit and select "Zip Teams App Package." Choose the
manifest.jsonfile and ensure "local environment" is selected. This creates a zip file. Within Teams desktop app, access the left-side app bar. Click on "Apps" followed by "Manage your apps." Select "Upload an app" and then "Upload a custom app." Finally, choose the downloaded zip package (located at/path/to/project/teams_chatbot/appPackage/build/appPackage.local.zip) to deploy the chatbot to your Teams environment.
The description is not complete yet. Detailed instructions for running the backend are forthcoming. In the meantime, explore the Teams app functionality!
- install requirements
- download model from hugging face
- move to models folder
- setup chroma db