https://github.com/programmarchy/directus-extension-copilot

A Directus extension that provides an Insights panel and API endpoint allowing you to chat with your data using OpenAI.
https://github.com/programmarchy/directus-extension-copilot

directus directus-ai-hackathon

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/programmarchy/directus-extension-copilot
• Owner: programmarchy
• License: apache-2.0
• Created: 2023-08-31T20:03:47.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-01T02:00:22.000Z (over 1 year ago)
• Last Synced: 2024-04-07T08:52:08.259Z (9 months ago)
• Topics: directus, directus-ai-hackathon
• Language: TypeScript
• Homepage:
• Size: 12.8 MB
• Stars: 66
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-directus - Directus Copilot - A bundle including a panel to ask data-aware questions in a chat interface. (Extensions / Community)

README

        
# 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](https://js.langchain.com) (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

https://github.com/programmarchy/directus-extension-copilot/assets/622192/312a6b30-063f-4d16-84f3-0d7989a4680c

## Screenshots







## Build

Building this extension is a bit wonky because of issues I had with langchain.js. I made [some hacks](https://github.com/programmarchy/langchainjs/commit/5259940ea9e2f23d6761f21f912d46dfe640bf5e), 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](https://github.com/programmarchy)