https://github.com/zeropaper/dupachain
A supabase + langchain R.A.G. stack scratchpad
https://github.com/zeropaper/dupachain
langchain-js openai-api rag socket-io supabase
Last synced: 4 months ago
JSON representation
A supabase + langchain R.A.G. stack scratchpad
- Host: GitHub
- URL: https://github.com/zeropaper/dupachain
- Owner: zeropaper
- Created: 2023-11-29T18:42:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-09T18:10:27.000Z (over 2 years ago)
- Last Synced: 2024-04-14T09:11:37.871Z (about 2 years ago)
- Topics: langchain-js, openai-api, rag, socket-io, supabase
- Language: TypeScript
- Homepage:
- Size: 3.99 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Supabase - LangChain playground
This is a playground for [supabase](https://supabase.com)d
[LangChain](https://js.langchain.com/docs/get_started/introduction) project.
Its aim is to provide some structure and a starting point for the project by putting together
a stack of open-source tools that can help developing LangChain chains, tools and apps.
It considers the usual deterministic approach of engineering and tries to provide a set of tools
that allow assessing the quality of the chain and its tools.
One of the goals is to provide a lightweight Web Socket server that can handle chats with an AI based agent.
The other goal is to provide a way to evaluate the quality of the AI agent and the chain with variety of settings
and spot weaknesses in development stages.
[](https://supabase.com)
## Work in progress
This is an early stage prototype and there are a lot of things that are not yet ideal.
### TODOs
The code contains a lot of `TODO`s that need attention.
### Bigger changes
- figure a way to render the "eval" results in a more readable way
- deeper integration with langfuse (user feedback / scores) and supabase (langchain caching / memory)
- add options to the eval files to allow for more flexibility
- re-organize code scaffolding to allow better sharing of types
## Prerequisites
### Node
- `node`: install using [NVM](https://github.com/nvm-sh/nvm/blob/master/README.md#installing-and-updating)
(`nvm install 20 && nvm use 20`)
- `pnpm`: is the package manager that is used in this project, install with `npm i -g pnpm`
### Supabase
In order to run supabase locally, you also need to ensure
[their prerequisites are met](https://github.com/supabase/supabase/blob/master/DEVELOPERS.md#local-development).
### Langfuse
Is used log LLM and chat model calls. You can run it locally or use their hosted version.
The integration is done through the
[`langfuse-langchain` package](https://langfuse.com/docs/langchain/typescript).
## Setup
1. `pnpm i` to install the dependencies
1. `pnpm sb:start` to start the Supabase DB
1. `pnpm sb:db:reset` this will:
1. import the base SQL files from [`./supbabase/migrations`](./supbabase/migrations)
1. import the [`./supbabase/seed.sql`](./supbabase/seed.sql)
1. generate the TypeScript types based on the DB schema
(and put them in the [`@local/supabase-types`](./packages/supabase-types))
1. Enable the "realtime" feature on the `chat_messages` table (see below)
1. `pnpm dev` will run the ["gateway" app](./apps/gateway) in "dev" mode
**Notes:**
- Everytime you use the `pnpm sb:db:reset` script, you will need to enable the "realtime"
feature of the `chat_messages` table
### Environment variables
You will need to create a `.env` in the root directory and should look like:
```txt
OPENAI_API_KEY=
# get the values from running `npm supabase status`
SUPABASE_URL=
SUPABASE_ANON_KEY=
SUPABASE_SERVICE_ROLE_KEY=
LANGFUSE_BASE_URL=http://localhost:8000
LANGFUSE_PUBLIC_KEY=
LANGFUSE_SECRET_KEY=
CORS_ORIGINS=http://localhost:3030,http://localhost:5173
```
**Note:** if you are using the `.env` with Docker (see below), you will need to
ensure that the values are NOT quoted.
## Structure
### Gateway app
The "server" part of the project and the stuff you may want to make public
is in the ["gateway" app](./apps/gateway) directory.
It is made of a very simple [ExpressJS](https://expressjs.com/) server that
utilizes [supabase-js](https://www.npmjs.com/package/@supabase/supabase-js)
and [socket.io](https://www.npmjs.com/package/socket.io) to provide an
API for realtime communication.
The most interesting bits are probably located in the
[`answerUser.ts`](./apps/gateway/src/chats/answerUser.ts) file and the
[POST `/api/documents` handler](./apps/gateway/src/createAPIRouter.ts).
The "ingestion" of the content is done by sending "POST" requests to the
`/api/documents` endpoint. The body of the request should be a JSON object with
the following structure:
```json
{
"content": "The content of the document",
"reference": "A unique identifier for the document",
"metadata": { "whatever": "you want" },
"format": "html" // or "markdown"
}
```
### Local chat
You can chat locally with the "gateway" app by running the
the `dev` npm script of the `@local/ui` package with `pnpm -C packages/ui dev`
(if you are in the root directory).
You will also need to run the `pnpm -C dev` script in the "gateway" app.
### Evaluations
In order to evaluate the quality of a chat agent, you can run
[default.evalsconfig.yml file](./apps/gateway/default.evalsconfig.yml) in the app directory.
You can run the script with `pnpm eval`.
## Docker
### Build
```sh
DOCKER_BUILDKIT=1 docker build . --target gateway --tag gateway:latest
```
### Run
```sh
docker run -it \
-p 3050:3040 \
--env-file .env \
-e SUPABASE_URL="http://host.docker.internal:54321" \
docker.io/library/gateway:latest
```
http://localhost:3050