Usage#

Installation#

pip install ipython-gpt

Then in your notebook or ipython shell:

%load_ext ipython_gpt

Setup#

You must first generate an API key at OpenAI (https://platform.openai.com/account/api-keys) and set is an environment variable OPENAI_API_KEY. You can do it by modifying your .bashrc/.zshrc or starting jupyter with it:

OPENAI_API_KEY=[YOUR-KEY] jupyter lab

OPENAI_API_KEY=[YOUR-KEY] ipython

There are a few other ways to set the API KEY, but the envvar is the recommended one.

ChatGPT API#

The command %%chat interfaces with ChatGPT. It accepts multiple parameters (see Usage). Here’s an example:

%%chat --max-tokens=25

What's the purpose of life?
...
>>> CHAT RESPONSE

Important by default, the %%chat command preserves the conversation to give the Agent some context, in the same way that ChatGPT works. You can “reset” its status passing the flag --reset-conversation.

%%chat --reset-conversation

How can I avoid pandas using scientific notation in outputs, and do it globally?
...
...
>>> CHAT RESPONSE

Agent’s role (system message) and other chat parameters#

By default, the Chat is started with the role: “You’re a python data science coding assistant”. You can change that by passing something different in your first %%chat:

%%chat --system-message="You're a R Data Science assistant"

Your message...

Once the conversation has started, you can’t change the original message, as the context is preserved. To do so, you must reset the conversation:

%%chat --system-message="You're a R Data Science assistant" --reset-conversation

Your message...

Setting global config#

You can change the defaults using the %chat_config line magic:

%chat_config --system-message="You're an R data scientist coding assistant specialized in visualizations" --model "other model" --reset-conversation

Invoke it without parameters to see the defaults set:

%chat_config
...

>>>
##### Conf set

* **Default model**: gpt-3.5-turbo
* **Default system message**: You're a python data science coding assistant
* **Chat history length**: 0

Other methods#

Display available models#

%chat_models [--all-models]

%chat_models

Available models#

  • gpt-3.5-turbo-0301

  • gpt-3.5-turbo

Display usage and accepted parameters#

%reload_ext ipython_gpt
%chat_help
...


usage: ipykernel_launcher.py [-h] [--openai-api-key OPENAI_API_KEY]
                             [--reset-conversation]
                             [--system-message SYSTEM_MESSAGE]
                             [--no-system-message] [--model MODEL]
                             [--temperature TEMPERATURE]
                             [--max-tokens MAX_TOKENS] [--all-models]

Alternative authentication#

Aside from setting the environment variable, you can also set OPENAI_API_KEY as a global variable in your notebook, or pass it directly as a parameter in any method --openai-api-key=YOUR-KEY.

These alternative methods are NOT recommended, as you might leak your API Key in the notebooks’ history, stored in .ipynb_checkpoints.