Creating the README.md file with the provided content

Streamlit Chatbot

This project is a simple chatbot built using Streamlit, integrated with OpenAI's API and Google's Gemini AI. The chatbot allows users to interact with AI models to get responses based on user input.

Installation

Follow these steps to set up the project on your local machine.

Prerequisites

• Python 3.7 or higher
• pip (Python package installer)

Steps

1. Clone the Repository:

   git clone https://github.com/farout101/ChatBot_with_Streamlit.git
   cd ChatBot_with_Streamlit

2. Create a Virtual Environment (optional but recommended):

   python -m venv chatbot-env
   source chatbot-env/bin/activate  # On Windows, use `chatbot-env\\Scripts\\activate`

3. Install the Required Packages:

   pip install -r requirements.txt

Configuration

Before running the chatbot, you need to configure your API keys. The chatbot can use either OpenAI's API or Google's Gemini AI, depending on your preference.

• Caution: the OpenAI API key is not included in the repository for security reasons.

Code Structure

Chatbot_With_Streamlit/
│
├── .gitignore
├── botv1.py
├── botv2.py
├── env.py # not included in the repository (This file will contain the required API keys)
├── FoodSuggestion.py
├── model_test.py
├── notes.ipynb
├── README.md
├── requirements.txt
│
├── saves/ # not included in the repository 
│ ├── client_secret_1.json
│ ├── client_secret_2.json
│ ├── client_secret_web.json
│ └── GoogleAuthentication.txt
│
└── pycache/

# (saves) folder will contain the secret clients from Google OAuth for the FoodSuggestion models.

Option 1: OpenAI API Key

1. Set Up Environment Variables:

   Create an env.py file in the project directory and add your OpenAI API key to it:

   import os
   
   os.environ['OPENAI_API_KEY'] = 'your-openai-api-key'

   Alternatively, you can set the environment variable directly in your shell:

   export OPENAI_API_KEY='your-openai-api-key'

Option 2: Google Gemini AI API Key

1. Set Up Environment Variables:

   Similarly, create an env.py file in the project directory and add your Gemini AI API key:

   import os
   
   os.environ['GEMINI_AI_API_KEY'] = 'your-gemini-api-key'

   Or set the environment variable directly in your shell:

   export GEMINI_AI_API_KEY='your-gemini-api-key'

FoodSuggestion models

The food suggestion models need to setup the google OAuth to run it on your local machine. The required informations are in the notes.ipynb file.

Running the Chatbot

1. Start the Streamlit Application:

   streamlit run <app_name>.py

   This will start a local server and open the Streamlit app in your default web browser.

2. Using the Chatbot:

   • Once the app is running, you can enter your queries in the text box provided, and the chatbot will respond based on the selected AI model.
   • If you've set up predefined prompts or custom instructions, you can select or modify these before sending your query.

Additional Features

• Predefined Prompts: You can add predefined prompts that users can select from a dropdown menu. This is useful for common questions or specific instructions.

• Custom Instructions: Add custom instructions that the AI model will consider while generating responses. This can help guide the model's tone or response style.

• Error Handling: The application includes user-friendly error messages to guide you in case of issues such as API connection failures or invalid inputs.

Troubleshooting

• If you encounter any issues with API keys, ensure they are correctly set in the environment variables and that they are valid.
• If the application fails to start, make sure that all dependencies are properly installed by running pip install -r requirements.txt again.

Contributing

Feel free to submit issues or pull requests if you have improvements or bug fixes.