Welcome to the testing framework repository! This project is a comprehensive testing solution built on top of the RAGAS framework, utilizing FastAPI for the server-side and Streamlit for the client-side interface.
Before proceeding with the installation, ensure you have Python installed on your system. Follow these steps to set up the testing framework:
-
Install all dependencies listed in the
requirements.txtfile:pip install -r requirements.txt
Follow these steps to set up and run the testing framework:
Run the server-side code using the following command:
uvicorn main:app --reloadThis command starts the FastAPI server, allowing the client-side to interact with it.
Run the client-side code using the following command:
streamlit run class.pyThis command launches the Streamlit application, providing a user-friendly interface for interacting with the testing framework.
If you prefer to use the APIs separately, follow the input format mentioned in the models.py file.
Before running the commands mentioned above, ensure that you have set up your OpenAI API key as an environmental variable. This key is necessary for accessing the OpenAI API functionalities within the framework.