metadata

title: 'ReferenceBot: KnowledgeGPT + Azure OpenAI = <3'
colorFrom: indigo
colorTo: indigo
sdk: docker
app_port: 8501
emoji: 💬
pinned: false
license: mit
app_file: knowledge_gpt/main.py

ReferenceBot

Continuous integration

Build Type	Status
HF Deploy
File size check
Formatting check

Installation

Follow the instructions below to run the Streamlit server locally.

Prerequisites

Make sure you have Python ≥3.10 installed.

Steps

These instructions were tested on macOS 13.6 Ventura with ARM CPU and Python 3.10.11.

Clone the repository:

git clone https://github.com/andreped/ReferenceBot
cd ReferenceBot

Setup virtual environment and install dependencies:

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Create the secrets file at .streamlit/secrets.toml and fill in the relevant info:

OPENAI_API_KEY = "<insert OpenAI API key>"
CHATGPT_MODEL = "<insert model name>"
OPENAI_API_BASE = "https://<insert-openai-service-name>.openai.azure.com"
OPENAI_API_VERSION = "<insert version>"
ENGINE = "<insert deployment model name>"
ENGINE_EMBEDDING = "<insert deployment embedding name>"

Run the Streamlit server

streamlit run knowledge_gpt/main.py

Build with Docker

Run the following commands to build and run the Docker image.

docker build -t reference-bot .
docker run -p 8501:8501 reference-bot

Open http://localhost:8501 in your browser to access the app.

Demo

A live demonstration is hosted at Hugging Face! Click the 🤗 badge above.

Acknowledgements

We have built on-top of KnowledgeGPT to enable the tool be be used with Azure OpenAI Services. Thus, all credit should go towards the original developers.

License

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