Study Assistant is a smart assistant that helps students with their studies. It can answer questions about any subject, provide information about school or college events, and even help students find scholarships and internships.
Study Assistant uses its own searching, indexing, and crawling capabilities to keep its information up to date. This means that students can always be sure that they are getting the most accurate and up-to-date information possible.
The repository contains the backend service code.
- Install Docker for your platform first, make sure you have Docker Compose as well
- Clone this repository gitlab.akvelon.net/sdc/summer-internship-ai-chat-platform/study-assistant
- Create a file in the root of the repository named
.envwith the following content:
openai_key=sk-...
Replace sk-... with valid OpenAI API key
- Run
docker-compose upin the root of the repositoty. - You should see something like:
Attaching to study-assistant-study-assistant-1
study-assistant-study-assistant-1 | INFO: Started server process [1]
study-assistant-study-assistant-1 | INFO: Waiting for application startup.
study-assistant-study-assistant-1 | INFO: Application startup complete.
study-assistant-study-assistant-1 | INFO: Uvicorn running on http://0.0.0.0:8080 (Press CTRL+C to quit)
Now you should be able to acess API docs by visiting http://localhost:8080/docs
- Artem Halushka
- Braxton Diaz
- Eugene Olonov
- Kirill Ustinov
- Lyubomyr Kryshtanovskyi
MIT