behzadanksu / unhhandbookbot-v3

💬 OpenAI Assistants API chat UI 🛠️ It works easily by setting the ASSISTANT ID 📁 Supports file upload and file download 🪟 Support to Azure OpenAI

gpt-assistants-api-ui

• 💬 OpenAI Assistants API chat UI
• 🛠️ It works easily by setting the ASSISTANT ID
• 📁 Supports file upload and file download
• 🪟 Support to Azure OpenAI

🌟 Quick Start

1. 👤 Create an assistant on the OpenAI site (Get assistant ID)

2. 🔑 Get the API key from OpenAI

3. ⬇️ Clone the repository

   $ git clone https://github.com/ryo-ma/gpt-assistants-api-ui.git

4. 📦 Install dependencies

   $ poetry install

5. 🔑 Set environment variables

   OPENAI_API_KEY="sk-xxx"
   ASSISTANT_ID="asst_xxx"
   
   ASSISTANT_TITLE="Assistants API UI"
   ENABLED_FILE_UPLOAD_MESSAGE="Upload a file" # Leave empty to disable

   If you use azure instead, set AZURE_OPENAI_ENDPOINT and AZURE_OPENAI_KEY

6. 🏃‍️ Run the app

   $ poetry shell
   $ streamlit run app.py

🐳 Run the app using Docker

1. 👤 Create an assistant on the OpenAI site (Get assistant ID)

2. 🔑 Get the API key from OpenAI

3. ⬇️ Clone the repository

   $ git clone https://github.com/ryo-ma/gpt-assistants-api-ui.git

4. 🔑 Set environment variables

   Create a .env file.

   OPENAI_API_KEY="sk-xxx"
   ASSISTANT_ID="asst_xxx"
   
   ASSISTANT_TITLE="Assistants API UI"
   ENABLED_FILE_UPLOAD_MESSAGE="Upload a file" # Leave empty to disable

   If you use azure instead, set AZURE_OPENAI_ENDPOINT and AZURE_OPENAI_KEY

5. 💽 Build image

   $ docker compose build

6. 🏃‍️ Run the app

   $ docker compose up

Access to http://localhost:8501.

🌐 Deploy to Streamlit Cloud

You can fork this repository and deploy the app to https://share.streamlit.io/. No need to run the app on your local machine.

Don't forget to choose 3.10 as the Python version and set environment variables in the "Advanced settings" during deployment.