talk to your database
Project description
nldb
Natural Language Databasing. Talk to your data in English, via CLI, API or a simple web interface.
Installation
pip install nldb
An OpenAI API key should be available as the OPENAI_API_KEY
environment variable, e.g. using export OPENAI_API_KEY=sk-etc
or adding it to your project .env
file.
Preparing your database
NLDB can talk to SQLite and DuckDB databases. Call yours nldb.db
or specify the name with a DATABASE
environment variable.
You may need to simplify and denormalise your database for NLDB to work well. Your columns should have names whose meaning is obvious. While NLDB can join across tables, combining your data into a single table will reduce your prompt size and improve the accuracy of NLDB's query generation.
Initialise NLDB
nldb init
This creates three files: index.html
, Dockerfile
and prompt.txt
. You can ignore the first two for now.
Edit your prompt
Edit prompt.txt
, following the example and instructions in the generated file. You can test the effectiveness of your prompt by pasting it into ChatGPT, replacing %s
with some example questions.
Ask questions from the command line
nldb "What were the most watched videos by Japanese users in 2022?"
Start the API server
nldb serve
This starts an API server, on port 8080, with a single endpoint at /api/ask
. This expects a GET request with a q
parameter for the natural language query. It returns a JSON object containing the SQL statement, the result of executing the statement, a plain English answer and some timing and cost information.
There is a simple web interface to the API at /
. If you don't want this, just delete index.html
.
Adjust
Edit prompt.txt
to refine the quality of the generated queries, restarting the server to see changes. Edit index.html
or replace it with your own front-end.
Deploy
Generate instructions for Fly.io and Google Cloud Run
nldb deploy
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file nldb-0.4.0.tar.gz
.
File metadata
- Download URL: nldb-0.4.0.tar.gz
- Upload date:
- Size: 11.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.30.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc3a053aa32bfaf46cda9a1821305bafe06f92f936fa1c60e16063356889da10 |
|
MD5 | 2c0b06db575a156a4dcd1192b469c21f |
|
BLAKE2b-256 | 57d5830e5511d77d6f4aed90e2c2e388b0dabb893ffdba80477495727a3f60e5 |
Provenance
File details
Details for the file nldb-0.4.0-py2.py3-none-any.whl
.
File metadata
- Download URL: nldb-0.4.0-py2.py3-none-any.whl
- Upload date:
- Size: 10.9 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.30.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 053513d8cdb322f42834550992791561d5555c21aa2c0b543e983fb8b49ee01a |
|
MD5 | 83ed25dd02bc867eb1dce65f5310f189 |
|
BLAKE2b-256 | 6427f3b3fbcb9098716b9ac5c3ef1c27f94832fe50136cbaf3ef2786f9fd9382 |