Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vercel-labs/natural-language-postgres
https://github.com/vercel-labs/natural-language-postgres
Last synced: 17 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/vercel-labs/natural-language-postgres
- Owner: vercel-labs
- Created: 2024-10-08T20:51:58.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-06T10:38:06.000Z (about 1 month ago)
- Last Synced: 2024-11-06T11:36:35.295Z (about 1 month ago)
- Language: TypeScript
- Homepage: https://natural-language-postgres.vercel.app
- Size: 576 KB
- Stars: 92
- Watchers: 1
- Forks: 20
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Natural Language PostgreSQL
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fnatural-language-postgres&env=OPENAI_API_KEY&envDescription=Learn%20more%20about%20how%20to%20get%20the%20API%20Keys%20for%20the%20application&envLink=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fnatural-language-postgres%2Fblob%2Fmain%2F.env.example&demo-title=Natural%20Language%20Postgres&demo-description=Query%20PostgreSQL%20database%20using%20natural%20language%20and%20visualize%20results%20with%20Next.js%20and%20AI%20SDK.&demo-url=https%3A%2F%2Fnatural-language-postgres.vercel.app&stores=%5B%7B%22type%22%3A%22postgres%22%7D%5D)
This project is a Next.js application that allows users to query a PostgreSQL database using natural language and visualize the results. It's powered by the AI SDK by Vercel and uses OpenAI's GPT-4o model to translate natural language queries into SQL.
## Features
- Natural Language to SQL: Users can input queries in plain English, which are then converted to SQL using AI.
- Data Visualization: Results are displayed in both table and chart formats, with the chart type automatically selected based on the data.
- Query Explanation: Users can view the full SQL query and get an AI-generated explanation of each part of the query.## Technology Stack
- Next.js for the frontend and API routes
- AI SDK by Vercel for AI integration
- OpenAI's GPT-4o for natural language processing
- PostgreSQL for data storage
- Vercel Postgres for database hosting
- Framer Motion for animations
- ShadowUI for UI components
- Tailwind CSS for styling
- Recharts for data visualization## How It Works
1. The user enters a natural language query about unicorn companies.
2. The application uses GPT-4 to generate an appropriate SQL query.
3. The SQL query is executed against the PostgreSQL database.
4. Results are displayed in a table format.
5. An AI-generated chart configuration is created based on the data.
6. The results are visualized using the generated chart configuration.
7. Users can toggle between table and chart views.
8. Users can request an explanation of the SQL query, which is also generated by AI.## Data
The database contains information about unicorn companies, including:
- Company name
- Valuation
- Date joined (unicorn status)
- Country
- City
- Industry
- Select investorsThis data is based on CB Insights' list of unicorn companies.
## Getting Started
To get the project up and running, follow these steps:
1. Install dependencies:
```bash
pnpm install
```2. Copy the example environment file:
```bash
cp .env.example .env
```3. Add your OpenAI API key and PostgreSQL connection string to the `.env` file:
```
OPENAI_API_KEY=your_api_key_here
POSTGRES_URL="..."
POSTGRES_PRISMA_URL="..."
POSTGRES_URL_NO_SSL="..."
POSTGRES_URL_NON_POOLING="..."
POSTGRES_USER="..."
POSTGRES_HOST="..."
POSTGRES_PASSWORD="..."
POSTGRES_DATABASE="..."
```
4. Download the dataset:
- Go to https://www.cbinsights.com/research-unicorn-companies
- Download the unicorn companies dataset
- Save the file as `unicorns.csv` in the root of your project5. Seed the database:
```bash
pnpm run seed
```6. Start the development server:
```bash
pnpm run dev
```Your project should now be running on [http://localhost:3000](http://localhost:3000).
## Deployment
The project is set up for easy deployment on Vercel. Use the "Deploy with Vercel" button in the repository to create your own instance of the application.
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fnatural-language-postgres&env=OPENAI_API_KEY&envDescription=Learn%20more%20about%20how%20to%20get%20the%20API%20Keys%20for%20the%20application&envLink=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fnatural-language-postgres%2Fblob%2Fmain%2F.env.example&demo-title=Natural%20Language%20Postgres&demo-description=Query%20PostgreSQL%20database%20using%20natural%20language%20and%20visualize%20results%20with%20Next.js%20and%20AI%20SDK.&demo-url=https%3A%2F%2Fnatural-language-postgres.vercel.app&stores=%5B%7B%22type%22%3A%22postgres%22%7D%5D)
## Learn More
To learn more about the technologies used in this project, check out the following resources:
- [Next.js Documentation](https://nextjs.org/docs)
- [AI SDK](https://sdk.vercel.ai/docs)
- [OpenAI](https://openai.com/)
- [Vercel Postgres powered by Neon](https://vercel.com/docs/storage/vercel-postgres)
- [Framer Motion](https://www.framer.com/motion/)
- [ShadcnUI](https://ui.shadcn.com/)
- [Tailwind CSS](https://tailwindcss.com/docs)
- [Recharts](https://recharts.org/en-US/)