directus-extension-copilot

A Directus extension that provides an Insights panel and API endpoint allowing you to chat with your data using OpenAI.

Requirements

• Directus 10.6.0
• An OpenAI account with access to gpt-3.5-turbo-0613

Details

• This extension allows users to quickly find out useful information about their data using a chat interface. For example:
  • How many customers do I have?
  • How many sales did I have last month?
  • List all of my customer's emails in the state of Texas.
  • What is my top selling product this week?
• I used langchain.js (a modified version) to access the OpenAI API.
  • A local copy resides in packages folder and can be built using pnpm build:langchain.
• I built a bundle extension that provides an Insight panel (named 'Copilot') and an API endpoint (POST /copilot/ask).
• If given longer, I would make many improvements:
  • Store the chat history so it remains when the user navigates away from their dashboard.
  • Ask the AI for richer data (like tables, markdown, etc.) that could be displayed in a companion side drawer alongside the chat.
  • Enhance its capabilities by building an "Agent" that could plan multiple API calls instead of relying on a one-shot API call.
  • Would allow the AI to explore more endpoints, and possibly even perform POST and PATCH operations!
  • Support Llama and other LLMs, especially self-hosted ones.
  • Allow users to fine-tune the LLM parameters, like temperature and which model.
  • Remove the dependency on langchain in favor of something simpler, more lightweight.
  • Smooth out the build process.

Demo Video

demo.mp4

Screenshots

Build

Building this extension is a bit wonky because of issues I had with langchain.js. I made some hacks, and copied the package locally to reference as a local package. To build this extension:

pnpm build:langchain
pnpm i
pnpm build

To spare you any trouble, I included the dist folder so you can skip having to build the extension yourself.

Installation

The easiest way to install this extension is to clone it directly into your Directus project's extensions path. Directus should then load it as a bundle extension.

Configuration

Provide your OpenAI API key either by setting OPENAI_API_KEY in your Directus configuration (e.g. your .env), or by pasting your key into the field when configuring the Copilot panel on your Insights dashboard.

Collaborators

• programmarchy