ChatPDF LangChain HR App

Overview

The ChatPDF LangChain HR App is a language model-powered chatbot designed for Human Resources professionals. It allows you to upload a candidate's resume in PDF format and ask questions about the candidate's qualifications. The app leverages LangChain for text processing and the OpenAI API for question answering.

Getting Started

Follow these steps to set up and use the app:

1. Clone the project repository to your local machine:

   git clone https://github.com/yourusername/chatpdf-langchain-hr-app.git
   cd chatpdf-langchain-hr-app
   

2. Install the required dependencies using Poetry:

poetry install

2. Create a virtual environment and activate it:

poetry shell

3. Create a file named .env in the project directory to store your OpenAI API key. Add your OpenAI API key to this file:

OPENAI_API_KEY=your_api_key_here

4. Run the app:

streamlit run src/app.py

5. Access the app in your web browser by following the URL displayed in your terminal.

Deploying Docker Image to DockerHub

You have the option to deploy the Docker image of this application to your own DockerHub using GitHub Actions. This allows you to automate the build and deployment process whenever changes are made to the repository.

Prerequisites

Before deploying the Docker image, ensure you have the following:

• A DockerHub account
• A GitHub repository with this project
• DockerHub username and password (or access token) for authentication
• A DockerHub repository

Step-by-Step Guide

Follow these steps to set up automated deployment to DockerHub:

1. Create DockerHub Credentials:

   • Log in to your DockerHub account.
   • Generate an access token or remember your DockerHub username and password. You'll need these to securely authenticate with DockerHub.

2. Configure GitHub Secrets:

   • Go to your GitHub repository and click on "Settings" -> "Secrets".
   • Create two secrets:
     • DOCKER_USERNAME: Set this to your DockerHub username.
     • DOCKER_PASSWORD: Set this to your DockerHub password or access token.

Usage

1. Upload a candidate's resume in PDF format.
2. In the text input field, ask questions about the candidate's qualifications in English.
3. The app will process the resume, answer your questions, and display the HR evaluation.

Why This Project?

• Efficient Candidate Evaluation: HR professionals can quickly evaluate candidates' qualifications by asking specific questions about their resumes, saving time in the hiring process.

• Language Model-Powered: The app leverages OpenAI's language model and LangChain for advanced text processing, making it highly accurate in understanding and answering questions.

• User-Friendly: The interface is designed to be user-friendly, allowing HR professionals to upload resumes and ask questions with ease.

• Customization: You can further customize the app's appearance and functionality according to your HR team's needs.

Give it a try and make your candidate evaluation process more efficient and data-driven!

License

This project is licensed under the MIT License

Made with ❤️ by Pedro Alves