Welcome to rememo
, a Streamlit-based demo project that showcases the capabilities of the newly released beta API from OpenAI, known as assistant
. rememo
stands for "Remember Memo" and is designed to act as your personal assistant for querying documents.
DEMO: https://rememo.streamlit.app/
- Document Upload: Easily upload your documents to the assistant.
- Question-Based Queries: After uploading the document, you can ask specific questions and the assistant will provide answers based on the content of the document.
- Streamlit Integration: A user-friendly web interface powered by Streamlit to interact with the assistant seamlessly.
To get started with rememo
, you'll need to have Python installed along with the necessary dependencies.
Ensure you have the following installed:
- Python 3.6+
- pip
- Streamlit
First, clone the repository to your local machine:
git clone https://github.com/so2liu/rememo.git
cd rememo
Then, install the required dependencies:
pip install -r requirements.txt
To run the application, simply execute the following command:
streamlit run main.py
Once the Streamlit server is up, it will provide you with a local URL that you can open in your web browser to interact with rememo
.
After launching the Streamlit application, follow these steps:
- Upload a Document: Click on the upload area or drag and drop your document file.
- Ask a Question: Type in your question regarding the content of the uploaded document.
- Get Answers: Submit your question and wait for the assistant to retrieve the information from the document.
Contributions to rememo
are welcome! If you have suggestions or improvements, feel free to fork the repository and submit a pull request.
Distributed under the MIT License. See LICENSE
for more information.
- OpenAI team for providing the powerful
assistant
API. - The Streamlit community for their easy-to-use web application framework.
Thank you for trying out rememo
. Explore the possibilities with your documents and enhance your productivity!