Chainlit datalayer

PostgresSQL data layer for Chainlit apps

• Schema description is in prisma/schema.prisma
• Option to upload elements to cloud storage

Works with chainlit >= 2.0.0.

Demo app

Here is an example on how to set up the data layer with a basic example in demo_app/:

demo_app.mp4

Try it locally

Install dependencies

# For the database.
pip install asyncpg

# For cloud providers
pip install boto3                       # AWS S3
pip install azure-storage-blob aiohttp  # Azure
pip install google-cloud-storage        # Google Cloud

Copy environment variables:

cp .env.example .env

If you want to test Azure Blob Storage locally, uncomment the corresponding section in compose.yaml and run python init_azure_storage.py to initialize the container. You will have to temporarily change the AzureBlobStorageClient class in chainlit repository to use the http protocol and an adjusted blob endpoint (without the typical Microsoft extension).

Run services

Run:

docker compose up -d

Two services are now up:

• a fresh (empty) PostgreSQL
• a 'fake' S3 bucket - to simulate storage for elements

We now "imprint" our Prisma schema to the fresh PostgreSQL:

npx prisma migrate deploy

To view your data, use npx prisma studio.

Now, all tables are created and welcoming chat data!

Use from Chainlit

Add the following environment variables in .env:

# To link to the PostgreSQL instance.
DATABASE_URL=postgresql://root:root@localhost:5432/postgres

Upon running chainlit run app.py, Chainlit attempts to connect to the specified database and keeps track of threads, users, steps, elements, feedback.

Remember to activate user authentication: https://docs.chainlit.io/authentication/overview

Elements -- that is files attached in the chat -- are written to a cloud storage. Locally, we have a fake S3 running up, which you can connect to with the following .env configuration:

# S3 configuration.
BUCKET_NAME=my-bucket
APP_AWS_ACCESS_KEY=random-key
APP_AWS_SECRET_KEY=random-key
APP_AWS_REGION=eu-central-1
DEV_AWS_ENDPOINT=http://localhost:4566

# Azure Blob Storage configuration.
BUCKET_NAME=my-container
APP_AZURE_STORAGE_ACCOUNT=devstoreaccount1
APP_AZURE_STORAGE_ACCESS_KEY=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==
APP_AZURE_STORAGE_CONNECTION_STRING=DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://localhost:10000/devstoreaccount1;QueueEndpoint=http://localhost:10001/devstoreaccount1;TableEndpoint=http://localhost:10002/devstoreaccount1
DEV_AZURE_BLOB_ENDPOINT=http://localhost:10000/devstoreaccount1

Re-launch your Chainlit app and add files to your chat. Then browse to http://localhost:4566/my-bucket to list your attachments.

Deploy in production

In production, deploy a production database -- please use robust passwords -- and point to an actual cloud provider.

Chainlit supports the three major cloud providers, see below for .env example configurations.

AWS S3

BUCKET_NAME=my-bucket
APP_AWS_ACCESS_KEY=random-key
APP_AWS_SECRET_KEY=random-key
APP_AWS_REGION=eu-central-1

Google Cloud Storage (GCS)

With Google Cloud, the following environment variables are necessary to connect:

• BUCKET_NAME: GCS bucket name
• APP_GCS_PROJECT_ID: project ID (not the project number)
• APP_GCS_CLIENT_EMAIL: email of the service account with adequate permissions
• APP_GCS_PRIVATE_KEY: secret key to authenticate

Create your service account from "IAM & Admin" > "Service Accounts". You can go with Storage Object Viewer and Creator/Admin. Key for the service account can be created from the "Keys" tab on the service account details page.

Here's an example of what your configuration could look like:

BUCKET_NAME=my-test-bucket
APP_GCS_PROJECT_ID=chat-project-123456
APP_GCS_CLIENT_EMAIL=chat-project-bucket@chat-project-123456.iam.gserviceaccount.com
APP_GCS_PRIVATE_KEY=ABC...123...XYZ

Azure Blob Storage

BUCKET_NAME= # should be the container name in Azure terminology.
APP_AZURE_STORAGE_ACCOUNT=dev-store-account-xyz
APP_AZURE_STORAGE_ACCESS_KEY=F9xkw3NOs...