Skip to content

Commit adc0b6e

Browse files
committed
Fix gradio deployment
1 parent df49854 commit adc0b6e

File tree

1 file changed

+49
-15
lines changed

1 file changed

+49
-15
lines changed

README.md

Lines changed: 49 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,63 @@
11
---
22
title: HiringHelp-Chatbot
3-
emoji: 👨‍💼
4-
colorFrom: blue
5-
colorTo: indigo
6-
sdk: gradio
7-
sdk_version: "5.22.0"
83
app_file: app.py
9-
pinned: false
4+
sdk: gradio
5+
sdk_version: 5.22.0
106
---
117

128

139
# HiringHelp Chatbot
1410

15-
[![Open in Spaces](https://huggingface.co/datasets/huggingface/badges/resolve/main/open-in-hf-spaces-sm.svg)](https://huggingface.co/spaces/natgluons/hiringhelp-chatbot)
16-
17-
A Gradio-based chatbot that helps with hiring-related questions by analyzing candidate information and providing intelligent responses.
11+
A chatbot that helps with hiring-related questions using RAG (Retrieval-Augmented Generation) with Gradio interface.
1812

1913
## Features
2014

21-
- Interactive chat interface built with Gradio
22-
- RAG (Retrieval-Augmented Generation) based responses
23-
- Support for PDF, TXT, and CSV document formats
24-
- Example questions for easy interaction
25-
- Source attribution for responses
26-
- Modern and responsive UI
15+
- Interactive chat interface using Gradio
16+
- RAG system for retrieving relevant information from candidate documents
17+
- Support for multiple document formats (PDF, TXT, CSV)
18+
- Conversation memory to maintain context
19+
- Real-time responses using OpenRouter API
20+
21+
## Setup
22+
23+
1. Clone the repository
24+
2. Install dependencies:
25+
```bash
26+
pip install -r requirements.txt
27+
```
28+
3. Create a `.env` file with your OpenRouter API key:
29+
```
30+
OPENROUTER_API_KEY=your_api_key_here
31+
```
32+
4. Place your candidate documents in the `knowledge_sources` directory
33+
5. Run the application:
34+
```bash
35+
python app.py
36+
```
37+
38+
## Usage
39+
40+
1. Start the application
41+
2. Ask questions about candidates or hiring-related topics
42+
3. The chatbot will retrieve relevant information from the documents and provide answers
43+
44+
## Project Structure
45+
46+
- `app.py`: Main application file
47+
- `requirements.txt`: Python dependencies
48+
- `knowledge_sources/`: Directory containing candidate documents
49+
- `.env`: Environment variables (API keys)
50+
51+
## Dependencies
52+
53+
- gradio
54+
- openai
55+
- python-dotenv
56+
- PyPDF2
57+
- pandas
58+
- langchain
59+
- faiss-cpu
60+
- requests
2761

2862
## Local Development
2963

0 commit comments

Comments
 (0)