Update README.md
Browse files
README.md
CHANGED
|
@@ -1,45 +1,13 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
|
| 15 |
-
## Requirements
|
| 16 |
-
|
| 17 |
-
* LangChain library
|
| 18 |
-
* OpenAI API key
|
| 19 |
-
* Langgraph
|
| 20 |
-
* Python 3.x
|
| 21 |
-
* Gradio (for UI)
|
| 22 |
-
|
| 23 |
-
## Installation
|
| 24 |
-
|
| 25 |
-
1. Install the required libraries by running `pip install -r requirements.txt`
|
| 26 |
-
2. Run app.py and input the required Keys(OpenAI, Phoenix API Key)
|
| 27 |
-
|
| 28 |
-
## Usage
|
| 29 |
-
|
| 30 |
-
1. Run the `app.py` script to start the RAG agent
|
| 31 |
-
2. Interact with the agent by providing input and receiving responses
|
| 32 |
-
|
| 33 |
-
## Files
|
| 34 |
-
|
| 35 |
-
* `app.py`: The main script for starting the application, this will run the web server with default port(7860)
|
| 36 |
-
* `agent.py`: The main script for the RAG agent
|
| 37 |
-
* `tools.py`: Contains tools for web search and response analysis, create rag response
|
| 38 |
-
* `rag.py`: Contains functions for initializing and using the RAG vector store
|
| 39 |
-
* `requirements.txt`: Lists the required libraries for the project
|
| 40 |
-
|
| 41 |
-
## Notes
|
| 42 |
-
|
| 43 |
-
* All the Key's must be inputted from the UI application.
|
| 44 |
-
* RAG will be loaded with default url in the UI, You can update the url and initialize the project with your own data source.
|
| 45 |
-
* This application will support the HTML based sources.
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: Rag Agent
|
| 3 |
+
emoji: 🐠
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: indigo
|
| 6 |
+
sdk: gradio
|
| 7 |
+
sdk_version: 5.20.0
|
| 8 |
+
app_file: app.py
|
| 9 |
+
pinned: false
|
| 10 |
+
license: cc-by-nd-4.0
|
| 11 |
+
---
|
| 12 |
+
|
| 13 |
+
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|