vasu018 / chatgpt_plugins

Code for the article showing how to use the function call feature of OpenAI's chat APIs to create ChatGPT plugins

Creating ChatGPT Plugins using the Function Call Feature

The introduction of the function call features in the chat completions API of OpenAI opens up the possibilities of implmenting plugins similar to the plugins supported in ChatGPT. However, OpenAI documentation does not show how this can be done. I took the opportunity to try to do this myself by building a chat application powered by GPT and then using the function call feature to design and implment plugins.

Write-Ups

• This repo contains code for a tutorial on building ChatGPT like plugins using the newly introduced function call feature. In this tutorial we build a Flask-based chat application using the ChatGPT APIs and then proceed to implement a web browsing and Python code interpreter plugin.

• A follow-up article on the topic of some gotchas you can run into when using function calls in your code and how to solve them gracefully without hacks in your code

Structure of a Plugin

Creating a plugin in this system requires doing two things.

• Extend the PluginInterface class, which defines the API that a plugin should follow
• Implement the 4 API methods expected by a plugin. These are:
  • get_name: Returns the name of the plugin
  • get_description: Provides a description of what the plugin does
  • get_parameters: Gives a JSON specification of the parameters of the plugin.
  • execute: This is the meat of the plugin, where it receives the parameters as declared by it in the get_parameters method and it executes its function.

Implemented Plugins

• Web search plugin
• Python code interpreter plugin
• Web scraper plugin

Setup Requirements for Running This Locally

Install following Python packages in a virtual environment:

pip install openai --upgrade
pip install flask requests python-dotenv

Create an OpenAI API Key

• Create an OpenAI account and generate a key from their accounts page: https://platform.openai.com/account/api-keys
• Put the generated API key in the .env file in the root directory of your project as follows:

OPEN_AI_KEY="<your api key here>"

Create Brave Search API Key

This is required for the web search/browser plugin. For this, you need to create an account with Brave at: https://brave.com/search/api/. Next, you need to create an API key from Brave. You can select the Free plan to start with. The free plan allows 2000 requests per month. Once you have generated the key, put this also in the .env file as shown below:

BRAVE_API_KEY="<your Brave API key>"

Generating a key for Flask

Flask also needs a secret key in order to create a user session. You can use something like uuid to generate the key. For example:

import uuid
print(str(uuid.uuid4()))

Put the generated value from the above code in the .env, as shown below:

CHAT_APP_SECRET_KEY="<your secret key>"

Running the Application

Use the following command to run the application:

flask --app run.py run

Demo

Following is the web search plugin in action: