A simple Python package for creating and interacting with GPT-based chatbots
Project description
gptbots
A simple Python package for creating and interacting with GPT-based chatbots
Preliminaries
Make sure your OpenAI API key is setup (see OpenAI's Quickstart tutorial).
Usage
To create a chatbot:
bot = gptbots.Chatbot()
creates a chatbot instance with default attributesbot = gptbots.Chatbot(model, temperature, custom_instructions, chatbot_name)
creates a chatbot instance with custom attributes
To chat:
bot.chat(prompt)
prints chatbot response to string prompt
See more methods below.
Attributes
model
: default is "gpt-3.5-turbo-1106"; see OpenAI's documentation on models for valid model namestemperature
: default is 0.7; ranges from 0.0 to 1.0; higher generally means more creativecustom_instructions
: default is "You are a helpful assistant."chatbot_name
: default is "Assistant"context
: contains custom instructions, user messages, and chatbot responses
Methods
chat(prompt)
prints chatbot response to string promptchat_image(prompt, url)
prints chatbot response to string prompt + image URL when using "gpt-4-vision-preview" (aka GPT-4 Turbo with vision)save(file_path)
saves chat history and settings to preferred fileload(file_path)
loads chat history and settings from preferred fileprint_messages()
prints context without custom instructions in a prettier formatprint_context()
prints context in a prettier format
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
gptbots-0.1.14.tar.gz
(3.6 kB
view hashes)