radicalxdev / kai-ai-backend

This is the Kai Teaching Assistant ai repo.
MIT License
12 stars 46 forks source link

Epic 7.2 - Synthwave Sentinels - Extended File Support for Flashcard Generator (Dynamo) #61

Open AaronSosaRamos opened 6 days ago

AaronSosaRamos commented 6 days ago

Pull Request - Epic 7.2 - Extended File Support for Flashcard Generator for Dynamo

By: Synthwave Sentinels

Summary

Extended file support for flashcard generator for the following file types:

Changes

Testing

Each document loader was tested using pytest (Managing appropriate scenarios and edge cases).

Results

All document loaders are working appropriately with the optimal results.

Notes

For Google Docs, Slides, Sheets and PDF files:

How to Test

  1. Clone the repo in your local

  2. Create and activate virtual environment

  3. Use pip install -r requirements.txt to install required libraries.

  4. Create .env file with ENV_TYPE, GCP_PROJECT_ID and GOOGLE_API_KEY fields. Env type is dev, gcp_project_id is your project id from cloud console project, google_api_key is your api key from AI studio.

  5. Then type ./local-start.sh to start the application.

  6. Add sample requests and responses for each file type as mentioned above in screenshots and test it. (Thank you so much AI Avengers for providing your PR template)

References

Request Templates Docs