Skip to content

Latest commit

 

History

History
63 lines (48 loc) · 3.37 KB

README.md

File metadata and controls

63 lines (48 loc) · 3.37 KB
Raw

Lumiere

Overview

Lumiere is a Streamlit-based web application that provides users with an interactive chatbot experience. The chatbot, powered by various GPT models from OpenAI, can assist users in multiple ways including answering questions, generating search queries, and providing code and document functionalities.

Features

  • Interactive Chatbot: Engage with a chatbot that can answer questions, generate search queries, and provide information.
  • File Upload: Upload and process files (text and images) for the chatbot to analyze and provide insights.
  • Web Search Integration: Utilize web search to get the most current information.
  • User Authentication: Includes user login and signup functionality.
  • Session Management: Maintains and tracks user conversations for continuity.

Installation

To run this project locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/ZazaCat/lumiere.git
cd lumiere

  2. Install the required packages:

    pip install -r requirements.txt

  3. Run the Streamlit application:

    streamlit run site.py

Usage

  • Open the URL provided by Streamlit in your browser.
  • Sign up or log in to start a conversation with the chatbot.
  • Upload files or images to interact with and get insights from the chatbot.
  • Toggle settings for model selection and web search options.

License

This project is licensed under the MIT License:

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Disclaimer

NOTICE: This code is provided "as is" without any warranties or guarantees of any kind. The authors take no responsibility for any misuse or damage caused by this code. You are solely responsible for ensuring that your use of the code complies with all applicable laws and regulations.

Code of Conduct

By contributing to this project, you agree to abide by the following Code of Conduct:

  1. Respect all users and contributors.
  2. Do not use this code for illegal or unethical purposes.
  3. Report any security vulnerabilities to the repository owner.

Contributions

We welcome contributions to this project. Please make sure to follow our Code of Conduct and security guidelines. Submit your contributions via pull requests and include a detailed explanation of your changes.

Contact

For any questions or concerns regarding this project, please contact [email protected]