Conversational-Chatbot-using-Langchain

About The Project

In a world where conversational interfaces play a crucial role, this chatbot stands out by providing natural and engaging interactions. Users can ask questions, seek assistance, or simply engage in a friendly conversation, and the chatbot responds with contextually relevant and human-like answers. This project brings together the seamless interactivity of Streamlit and the advanced language capabilities of OpenAI's GPT-3 to create a user-friendly and intelligent chatbot.

Built With

• Langchain
• Openai
• HuggingFace Hub
• Streamlit

Getting Started

This will help you understand how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation Steps

Option 1: Installation from GitHub

Follow these steps to install and set up the project directly from the GitHub repository:

1. Clone the Repository

   • Open your terminal or command prompt.
   • Navigate to the directory where you want to install the project.
   • Run the following command to clone the GitHub repository:

     git clone https://github.com/KalyanMurapaka45/Conversational-Chatbot-using-Langchain.git
     

2. Create a Virtual Environment (Optional but recommended)

   • It's a good practice to create a virtual environment to manage project dependencies. Run the following command:

     conda create -p <Environment_Name> python==<python version> -y
     

3. Activate the Virtual Environment (Optional)

   • Activate the virtual environment based on your operating system:

     conda activate <Environment_Name>/
     

4. Install Dependencies

   • Navigate to the project directory:

     cd [project_directory]
     

   • Run the following command to install project dependencies:

     pip install -r requirements.txt
     

5. Run the Project

   • Start the project by running the appropriate command.

     python app.py
     

6. Access the Project

   • Open a web browser or the appropriate client to access the project.

Usage and Instructions

• Enter Your Message: Use the provided input field to type your message or query.
• Submit: Click the "Submit" button to send your message to the chatbot.
• Receive Responses: Watch as the chatbot generates responses based on the input, creating a dynamic and engaging conversation.

API Key Usage

This project utilizes the OpenAI GPT-3 API for generating responses. To run the chatbot with the API, you'll need to obtain an API key from OpenAI. Follow the steps below to set up your API key:

Obtaining an OpenAI API Key

• Sign Up on OpenAI Platform:

  • If you don't have an account, sign up on the OpenAI platform.

• Create a New API Key:

  • Once logged in, navigate to the API section or dashboard.
  • Create a new API key by following the on-screen instructions.

• Copy Your API Key:

  • After creating the API key, copy it from the OpenAI platform.

Adding API Key to the Project

• Create a .env File:

  • In the project's root directory, create a file named .env.

• Add API Key to .env:

  • Open the .env file in a text editor.
  • Add the following line, replacing your-api-key with the actual API key:

  • OPENAI_API_KEY=your-api-key

  • Save the file.

Using the API Key in the Project

The project automatically reads the API key from the .env file using the python-dotenv library. Once the key is added to the .env file, the chatbot will use it to interact with the OpenAI GPT-3 API.

Note: Ensure the .env file is kept secure and not shared publicly, as it contains sensitive information.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch
3. Commit your Changes
4. Push to the Branch
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Hema Kalyan Murapaka - @kalyanmurapaka274@gmail.com

Acknowledgements

We'd like to extend our gratitude to all individuals and organizations who have played a role in the development and success of this project. Your support, whether through contributions, inspiration, or encouragement, has been invaluable. Thank you for being a part of our journey.