simpleGpyT 0.1.5

A simplified object-oriented interface for OpenAI's chat completion API.

💬 SimpleGPyT 💬

A simplified object-oriented interface for OpenAI's chat completion API.

Installation

Ensure you have Python 3.10 or newer. Python 3.7.1 and up should work as well, but these are untested.
To install the package, run:

pip install simpleGPyT

To use the package, import it at the top of the file.

from simpleGPyT import Conversation

Usage

Creating a chat

This library relies on a valid OpenAI API key. To create a chat, just call the constructor with your API key as the api_key parameter.

chat = Conversation("sk-...")

Chatting to your assistant

You converse with your assistant via the say() method.

chat = Conversation("sk-...")
response = chat.say("hello")
print(response)

You can also see the last response you received from your assistant with last_response().
Here is an equivalent of the above code using the last_response method

chat = Conversation("sk-...")
chat.say("hello")
print(chat.last_response())

Settings

You can add settings to your assistant by putting a list of settings as the settings argument in the constructor.

s = ["Keep answers concise", "Speak like a pirate", "Have opinions on topics"]
chat = Conversation("sk-...", settings=s)

Settings can also be removed, added and cleared after construction.

s = ["Keep answers concise", "Speak like a pirate", "Have opinions on topics"]
chat = Conversation("sk-...", settings=s)
print(chat.get_settings())

chat.pop_setting()
print(chat.get_settings())

chat.clear_settings()
print(chat.get_settings())

Viewing and resetting your chat

Messages can be viewed and reset during the chat, leaving settings intact

s = ["Keep answers concise", "Speak like a pirate", "Have opinions on topics"]
chat = Conversation("sk-...", settings=s)

chat.say("hello")
chat.say("write me a poem")

chat.clear_messages()
print(chat.get_messages())
print(chat.get_settings())

The entire chat (settings included) can also be reset.

s = ["Keep answers concise", "Speak like a pirate", "Have opinions on topics"]
chat = Conversation("sk-...", settings=s)

chat.say("hello")
chat.say("write me a poem")

chat.reset()
print(chat.get_messages())
print(chat.get_settings())