Skip to content

Commit 81bf52f

Browse files
authored
Update README.md
1 parent 8901d2c commit 81bf52f

File tree

1 file changed

+46
-23
lines changed

1 file changed

+46
-23
lines changed

README.md

Lines changed: 46 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# HiringHelp Chatbot
1+
# 👔 HiringHelp Chatbot
22

3-
A chatbot that helps with hiring-related questions using RAG (Retrieval-Augmented Generation) with LangChain.
3+
### A chatbot that helps you find the most fitting candidate for the role! Made using **RAG (Retrieval-Augmented Generation)** with **LangChain**.
4+
5+
![image](https://github.com/user-attachments/assets/afbcd76a-d26f-40af-9081-3fe4e7e041ca)
46

57
## How It Works
68
HiringHelp uses LangChain's RAG implementation to provide accurate, document-grounded responses. The process involves:
@@ -21,12 +23,49 @@ HiringHelp uses LangChain's RAG implementation to provide accurate, document-gro
2123
- Vector similarity search for accurate retrieval
2224
- Environment variable configuration
2325

24-
## Deployment Options
25-
1. **Vercel Deployment**: [Live Demo](https://hiring-help-chatbot.vercel.app/)
26-
2. **Hugging Face Spaces**: [Interactive Demo](https://huggingface.co/spaces/natgluons/HiringHelp-Chatbot)
27-
3. **Local Development**: See [docs branch](https://github.com/natgluons/hiringhelp-chatbot/tree/docs) for setup instructions
26+
## Usage Examples
27+
```
28+
"List all the available candidates"
29+
"Tell me about a candidate named [Name]"
30+
"Which candidate is best for [Role] role?"
31+
```
32+
33+
## Demo Snapshots
34+
A demo version is available with sample candidate data for testing purposes.
35+
36+
### ❔ Ask about a specific candidate
37+
<img src="https://github.com/user-attachments/assets/25ca5927-b981-49b4-8c74-9859ad0fc5cf" width="800px">
38+
39+
### 🏆 Or ask who's best for the role
40+
<img src="https://github.com/user-attachments/assets/9bba78b9-a027-4d8c-b553-688a5850d680" width="800px">
41+
42+
## 👀 Preview all candidate's resume!
43+
<img src="https://github.com/user-attachments/assets/5762a3f8-3df3-4ca1-8151-7fe8b97206cd" width="800px">
44+
45+
## Rate Limits
46+
- 10 requests per minute
47+
- 100 requests per day
48+
49+
## Deployment
50+
1. **Hugging Face Spaces**: [Interactive Demo](https://huggingface.co/spaces/natgluons/HiringHelp-Chatbot) - active
51+
52+
<img src="https://github.com/user-attachments/assets/25a08529-317d-491b-a376-fec7f224c365" width="800px">
53+
54+
2. **Vercel Deployment**: [Live Demo](https://hiring-help-chatbot.vercel.app/) - inactive API [Preview Only]
2855

29-
## Requirements
56+
<img src="https://github.com/user-attachments/assets/c1a43285-bbec-457a-ab24-ba6cdb0a0bde" width="800px">
57+
58+
3. **Local Development**: See below for setup instructions & local-docs branch for complete script.
59+
60+
---
61+
*
62+
Interested in building your own chatbot? Follow this setup instructions below! (◕‿◕)
63+
*
64+
---
65+
66+
# Local Development Setup
67+
68+
### Requirements
3069
```
3170
Flask==2.0.3
3271
Werkzeug==2.0.3
@@ -47,8 +86,6 @@ aiohttp==3.9.1
4786
beautifulsoup4==4.12.2
4887
```
4988

50-
## Local Development Setup
51-
5289
1. Clone the repository:
5390
```bash
5491
git clone https://github.com/natgluons/HiringHelp-Chatbot.git
@@ -102,17 +139,3 @@ HiringHelp-Chatbot/
102139
├── requirements.txt # Python dependencies
103140
└── .env # Environment variables
104141
```
105-
106-
## Usage Examples
107-
```
108-
"List all the available candidates"
109-
"Tell me about a candidate named [Name]"
110-
"Which candidate is best for [Role] role?"
111-
```
112-
113-
## Rate Limits
114-
- 10 requests per minute
115-
- 100 requests per day
116-
117-
## Demo
118-
A demo version is available with sample candidate data for testing purposes.

0 commit comments

Comments
 (0)