AI Swarm - Driver OpenAI

This is a driver for the AI Swarm that uses the OpenAI API to provide a LLM for the AI Swarm. It handles all communication with any agents running in the swarm using the OpenAI API. The driver does not run on its own, it must be used with the Orchestrator.

If you're looking for an easy way to get started with the AI Swarm, check out the Conductor project.

Configuration

There are a few configuration options available, the most important one being the api key. You will need to use your own key and can either set it explicitly in the config file or use an environment variable instead.

This is the default configuration:

{
  "apiKey": process.env.OPENAI_API_KEY,
  "model": "gpt-4-0125-preview",
  "keepAssistant": false,
  "keepThread": false
}

• apiKey - Your OpenAI API key. You can get one by signing up at OpenAI. You can also set this as an environment variable using OPENAI_API_KEY as name.
• model - The model to use for the AI. You can find a list of available models here.
• keepAssistant - The application will try to clean up after itself by deleting the assistant and thread after the conversation is done. If you want to keep the assistant for debugging purposes, you can set this to true.
• keepThread - The application will try to clean up after itself by deleting the thread after the conversation is done. If you want to keep the thread for debugging purposes, you can set this to true.

Note that killing the app will prevent the cleanup from happening, so you may end up with a lot of unused assistants and threads if you don't clean up manually.

Project setup for development

npm install

Recommended Setup for development with other plugins

You will need to link the plugin to the other plugins you want to use. So that you can make changes and see them immediately without having to publish the plugin to npm.

For this I recommend you create a new folder for the AI Swarm and clone all the plugins you want to use into it. Then link them together.

Each plugin has link script defined in the package.json file if there are dependencies on other packages. You can run it with npm run link to link your code directly when you make changes.

This project does not have any dependencies on other plugins, so you don't need to link anything.