GPTSOA

A ChatGPT TypeScript Plugin Framework with automatic OpenAPI based on lukeautry/tsoa

⭐ Please leave a star if you like it!

🐦 Follow me on twitter for more updates castignolimarco

Install

Just run

yarn install

Configuration

You need to learn how ChatGPT plugins works in general by reading the ChatGPT plugin documentation here

Plugin files

Do not edit

public/ai-plugin.json: The file is automatically generated, do not edit this file
public/openapi.yaml: The file is automatically generated, do not edit this file

Edit

public/logo.png: Just a simple logo for your plugin
./ai-plugin.json: You can edit the information in this file but not the field description_for_model
./description_for_model.md: You can use this md file to describe your plugin to ChatGPT, every functionality must be clear for ChatGPT

Getting Started

Basically through the use of decorators and typescript analysis tsoa automatically generate an openAPI file for you. But you need to follow the tsoa's opinioned code structure.

Just read lukeautry/tsoa documentation, there is a simple example in src/controllers/ExampleTestController.ts.

Running

Simply run yarn start

Installing the plugin on ChatGPT

Check your account settings in https://chat.openai.com/ there should be a Beta Feature tab, open it and activate Plugins.
Click on GPT-4, select plugins. In the plugin selector, select Plugin Store`
In the modal click on Develop your own plugin paste your host and port for example

localhost:3333

Follow the instructions

Test it

Prompt:

Call the test plugin by passing my name: "Marco"

Host problem (Only if you need a different port/host)

If you need to run the plugin on a different host you need to make a few manual fix.

Change the host in src/server.ts
Edit the tsoa.json: change the "host": "localhost:3333",
Edit fixHost.yaml, keep the / at the end, this file is used to exactly fix the trailing /.
Remember to update it also in ai-plugin.json

marcocastignoli / GPTSOA