prsdm commited on
Commit
2477431
β€’
1 Parent(s): 0fefbe1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +7 -31
README.md CHANGED
@@ -1,31 +1,7 @@
1
- # Roman Empire Q&A Application
2
-
3
- https://weaviate-rag.streamlit.app/
4
-
5
- This project is a Retrieval-Augmented Generation (RAG) application designed to answer questions related to the Roman Empire. It leverages Weaviate for vector storage and retrieval, OpenAI for generating responses, FastAPI for the backend API, and Next.js for the frontend interface.
6
-
7
-
8
- ![RAG-Roman Empire Banner](public/images/workflow.jpg)
9
-
10
- ## Features
11
-
12
- - **Interactive Question-Answering**: Users can input questions about Roman history and culture and receive informative responses.
13
- - **Sample Questions**: The app provides a list of sample questions to guide users and demonstrate its capabilities.
14
- - **API Key Management**: Users can securely enter their OpenAI API key via a password input field in the sidebar.
15
- - **Built With**: The sidebar includes links to the technologies and frameworks used in building the app.
16
-
17
- ## Getting Started
18
-
19
- To run the app locally, follow these steps:
20
-
21
- 1. Clone this repository to your local machine.
22
- 2. Install the required dependencies by running `pip install -r requirements.txt`.
23
- 3. Create a `.env` file in the root directory of the project and add your Weaviate API key and cluster URL in the following format:
24
-
25
- ```
26
- WEAVIATE_API_KEY="your_api_key"
27
- WEAVIATE_CLUSTER="your_cluster_url"
28
- ```
29
-
30
- 4. Run the Streamlit app using the command `streamlit run app.py`.
31
- 5. Access the app in your web browser at `localhost:8501`.
 
1
+ ---
2
+ license: mit
3
+ sdk: streamlit
4
+ emoji: πŸš€
5
+ colorFrom: yellow
6
+ colorTo: yellow
7
+ ---