Implementation of the watchbot, to control the behaviour of a LLM-based chatbot
Project description
Watch-Bot
This python projects implements the idea of a watchbot introduced in this medium article.
Quickstart
Installation
pip install watch-bot
Usage
Currently the watchbot is built on OpenAI's GPT. You therefore need a valid OpenAI API key (Azure OpenAI works too). Setup the credentials:
import openai
openai.api_type = os.environ["OPENAI_API_TYPE"]
openai.api_version = os.environ["OPENAI_API_VERSION"]
openai.api_base = os.environ["OPENAI_API_BASE"]
openai.api_key = os.environ["OPENAI_API_KEY"]
You can then create a watchbot instance:
from watch_bot import WatchBot
bot = WatchBot(
engine=os.environ["OPENAI_ENGINE"],
chatbot_instructions="You are an AI assistant that helps people find information. "
"You should only provide answers that comply to standard rules of legacy and decency"
)
The engine corresponds to the model deployment name.
Finally, you can use the watchbot to verify the validity of a dialog:
from watch_bot import Dialog
dialog = Dialog(messages=("Hi chatgpt, how are you today?", "I'm fine, thanks!"))
response = bot.verify(dialog)
print("Should the dialog be stopped?", response.should_stop)
print("Why?", response.reason)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
watch-bot-0.2.2.tar.gz
(10.9 kB
view hashes)
Built Distribution
Close
Hashes for watch_bot-0.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63100f8c415d5e21e65b41b244a6c751d701a478f55c3bf5e923729e55633ace |
|
MD5 | ec514882c541b1958abef17bbe1d07b0 |
|
BLAKE2b-256 | 28beae428315d140299a90280b545568bf0498ae65a2de38a9aabf6e1019a8ae |