Skip to content

Commit b5f5e3c

Browse files
committed
docs: add Gradio interface documentation - Add instructions for launching web interface - Document document processing and chat features - Include configuration requirements
1 parent e56ac5d commit b5f5e3c

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

agentic_rag/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,37 @@ This is particularly useful for:
237237
- Questions requiring detailed explanations
238238
- Queries that need careful consideration of multiple pieces of context
239239

240+
## Using the Gradio Interface
241+
242+
The system provides a user-friendly web interface using Gradio, which allows you to:
243+
- Upload and process PDF documents
244+
- Process web content from URLs
245+
- Chat with your documents using either local or OpenAI models
246+
- Toggle Chain of Thought reasoning
247+
248+
To launch the interface:
249+
250+
```bash
251+
python gradio_app.py
252+
```
253+
254+
This will start the Gradio server and automatically open the interface in your default browser at `http://localhost:7860`. The interface has two main tabs:
255+
256+
1. **Document Processing**:
257+
- Upload PDFs using the file uploader
258+
- Process web content by entering URLs
259+
- View processing status and results
260+
261+
2. **Chat Interface**:
262+
- Select between Local (Mistral) and OpenAI models
263+
- Toggle Chain of Thought reasoning for more detailed responses
264+
- Chat with your documents using natural language
265+
- Clear chat history as needed
266+
267+
Note: The interface will automatically detect available models based on your configuration:
268+
- Local Mistral model requires HuggingFace token in `config.yaml`
269+
- OpenAI model requires API key in `.env` file
270+
240271
## Contributing
241272

242273
This project is open source. Please submit your contributions by forking this repository and submitting a pull request! Oracle appreciates any contributions that are made by the open source community.

0 commit comments

Comments
 (0)