pyrobbot 0.1.0

A simple UI & terminal chatbot that uses the OpenAI API.

pyRobBot

A simple chatbot that uses the OpenAI API to get responses from GPT LLMs via OpenAI API. Written in Python with a Web UI made with Streamlit. Can also be used directly from the terminal.

See also the online documentation.

Features

• Web UI
  • Add/remove conversations dynamically
• Fully configurable
  • Support for multiple GPT LLMs
  • Control over the parameters passed to the OpenAI API, with (hopefully) sensible defaults
  • Ability o modify the chat parameters in the same conversation
  • Each conversation has its own parameters
• Autosave and retrieve chat history
• Chat context handling using embeddings
• Kepp track of estimated token usage and associated API call costs
• Terminal UI

System Requirements

• Python >= 3.9
• A valid OpenAI API key
  • Set in the Web UI or through the environment variable OPENAI_API_KEY

Installation

Using pip

pip install pyrobbot

From source

pip install git+https://github.com/paulovcmedeiros/pyRobBot.git

Basic Usage

Upon succesfull installation, you should be able to run

rob [opts] SUBCOMMAND [subcommand_opts]

where [opts] and [subcommand_opts] denote optional command line arguments that apply, respectively, to rob in general and to SUBCOMMAND specifically.

Please run rob -h for information about the supported subcommands and general rob options. For info about specific subcommands and the options that apply to them only, please run rob SUBCOMMAND -h (note that the -h goes after the subcommand in this case).

Using the Web UI

rob

Running on the Terminal

rob .

Disclaimers

This project's main purpose is to serve as a learning exercise for me (the author) and to serve as tool for and experimenting with OpenAI API and GPT LLMs. It does not aim to be the best or more robust OpenAI-powered chatbot out there.

Having said this, this project does aim to have a friendly user interface and to be easy to use and configure. So, please feel free to open an issue or submit a pull request if you find a bug or have a suggestion.

Last but not least: this project is not affiliated with OpenAI in any way.