https://github.com/caesarHQ/textSQL

https://github.com/caesarHQ/textSQL

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/caesarHQ/textSQL
• Owner: caesarHQ
• License: mit
• Created: 2023-02-28T01:03:37.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-20T18:17:35.000Z (about 1 year ago)
• Last Synced: 2024-10-29T17:55:58.601Z (15 days ago)
• Language: JavaScript
• Homepage: https://censusgpt.com
• Size: 5.93 MB
• Stars: 1,548
• Watchers: 23
• Forks: 157
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: license.md

Awesome Lists containing this project

README

        
## 🚨 Check out the latest project from the creators of textSQL: [Julius.ai](https://julius.ai?utm_source=github&utm_campaign=textSQL) 🚨

###

# Natural Language → SQL

### 

:bridge_at_night: Demo on San Francisco City Data: [SanFranciscoGPT.com](http://sanfranciscogpt.com)

:us: Demo on US Census Data: [CensusGPT.com](https://censusgpt.com)



 SanFranciscoGPT •

   CensusGPT •

  Join the Discord Server





   

   

   

   

   



Welcome to textSQL, a project which uses LLMs to democratize access to data analysis. Example use cases of textSQL are San Francisco GPT and CensusGPT — natural language interfaces to public data (SF city data and US census data), enabling anyone to analyze and gain insights from the data.



## :thinking: How it works:

With CensusGPT, you can ask any question related to census data in natural language. 

These natural language questions get converted to SQL using GPT-3.5 and are then used to query the census database.

Here are some examples:

* [🔍 Five cities with a population over 100,000 and lowest crime](https://censusgpt.com/?s=five%20cities%20with%20a%20population%20over%20100%2C000%20and%20lowest%20crime)

* [🔍 10 highest income areas in california](https://censusgpt.com/?s=10%20highest%20income%20areas%20in%20california)

Here is a similar example from sfGPT:

* [🔍 Which four neighborhoods had the most crime in San Francisco in 2021?](https://censusgpt.com/sf?s=Which+four+neighborhoods+had+the+most+crime+in+San+Francisco+in+2021%3F)

#### Diagram:

![TextSQL diagram](https://raw.githubusercontent.com/zafileo23/textSQL/zafileo23-patch-2/TextSQL.svg)

## :world_map: Roadmap:

We're splitting the roadmap for this project broadly into two categories:

### 1. Visualizations: 

Currently, textSQL only supports visualizing zip codes and cities on an interactive map and bar chart using [Mapbox](https://www.mapbox.com/) + [Plotly](https://plotly.com/). But data can be visualized in other interesting ways such as Heatmaps and Pie charts. Not every kind of data can be (or should be) visualized on a map. For example, a query like _"What percent of total crime in San Francisco is burglary vs in New York City"_ is perfect for visualizing as a stacked bar chart, but really hard to visualize on map.

Bar Chart:



[coming soon] Heatmap: 



[coming soon] Visualization-GPT: A way to use natural language to create and iterate on data visualizations in natural language through a text-to-vega engine.

### 2. 🔌 Text-to-SQL BYOD (Bring Your Own Data) [here](https://github.com/caesarHQ/textSQL/tree/main/byod)

You can now connect your own database & datasets to textSQL and self-host the service. Our vision is to continue to modularize and improve this process.

#### Use cases

- Public-facing interactive interfaces for data. Democratizing public data

- Empowering researchers. Enabling journalists and other researchers to more easily explore data

- Business intelligence. Reducing the burden on technical employees to build & run queries for non-technical

Setup instructions for BYOD are [here](https://github.com/caesarHQ/textSQL/tree/main/byod).

## :pencil: Additional Notes

#### Datasets: 

A lot of the users of this project have asked for additional data for both CensusGPT and sfGPT — historical census data (trends), weather, health, transportation and real-estate data. Feel free to create a pull request, drop a link to your dataset in our [Discord](https://discord.gg/JZtxhZQQus), or contribute data via our [dedicated submission form](https://airtable.com/shrDKRRGyRCihWEZd).

More data → Better CensusGPT and sfGPT

#### Query Building:

Users build complex queries progressively. They start with a simple query like _"Which neighborhoods in LA have the best schools?"_ and then progressively add details like _"with median income that is under $100,000"_. One of the most powerful aspects of textSQL is enabling iterating on a query as a process of uncovering insights.

### 

## :computer: How to Contribute:

Join our [discord](https://discord.gg/JZtxhZQQus)

ReadMe for the backend [here](https://github.com/caesarHQ/textSQL/blob/main/api/README.md)

ReadMe for the frontend [here](https://github.com/caesarHQ/textSQL/blob/main/client/censusGPT/README.md)



  

  

### 

**Note:** Census data, like any other dataset, has its limitations and potential biases. Some data may not be collected or reported uniformly across different regions or time periods, which can affect the comparability of results. Users should keep these limitations in mind when interpreting the results of their queries and exercise caution when making decisions based on census data.