Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/Canner/WrenAI

WrenAI makes your database RAG-ready. Implement Text-to-SQL more accurately and securely.
https://github.com/Canner/WrenAI

agent ai bigquery duckdb fastapi llm nextjs nlidb openai postgresql python rag sql text-to-sql typescript

Last synced: 15 days ago
JSON representation

WrenAI makes your database RAG-ready. Implement Text-to-SQL more accurately and securely.

Lists

README 

        





  

    

      

      

    

    
WrenAI


  






  

    

  

  

    

  

  

    

  

  

    

  

  

    

  




> WrenAI is a **text-to-SQL solution** for data teams to get results and insights faster by asking business questions without writing SQL.



![wrenai_overview](./misc/wrenai_view.png)



## 🕶 Try It Live!



[Play around with WrenAI yourself!](https://demo.getwren.ai/)



## 🎯 Our Vision & Mission



WrenAI’s mission is to democratize data by bringing text-to-SQL ability to any data source and industry. We believe that breakthroughs in Text-to-SQL technology will usher in a new era of Data Democratization.



🤩 [About our Vision](https://blog.getwren.ai/the-new-wave-of-composable-data-systems-and-the-interface-to-llm-agents-ec8f0a2e7141)



🙌 [About our Mission](https://docs.getwren.ai/overview/introduction)



## 👊 Text-to-SQL End-To-End Solution



### 1. Indexing With Semantics



> WrenAI has implemented a [semantic engine architecture](https://blog.getwren.ai/how-we-design-our-semantic-engine-for-llms-84a00e6e3baa) to provide the LLM context of your business; you can easily establish a logical presentation layer on your data schema that helps LLM learn more about your business context.



### 2. Augment LLM Prompts



> With WrenAI, you can process metadata, schema, terminology, data relationships, and the logic behind calculations and aggregations with [“Modeling Definition Language” (MDL)](https://docs.getwren.ai/engine/concept/what_is_mdl), reducing duplicate coding and simplifying data joins.



### 3. Generate Insights



> When starting a new conversation in WrenAI, your question is used to find the most relevant tables. From these, LLM generates three relevant questions for the user to choose from. You can also ask follow-up questions to get deeper insights.



### 4. Self-Learning Feedback Loop (Coming Soon)



> The AI self-learning feedback loop is designed to refine SQL augmentation and generation by collecting data from various sources. These include user query history, revision intentions, feedback, schema patterns, semantics enhancement, and query frequency.



## 🔥 Preview



### Ask your business questions and follow-up insights



![](./misc/preview_ask.png)



### Modeling with semantics, such as relationships, metrics, and calculations



![](./misc/preview_model.png)



## 🤔 Why WrenAI?



We focus on providing an open, secure, and reliable text-to-SQL solution for everyone.



### 1. Turnkey Solution



> WrenAI makes it easy to onboard your data. Discover and analyze your data with our user interface. Effortlessly generate results without needing to code.



### 2. Secure By Design



> Your database contents will never be transmitted to the LLM. Only metadata, like schemas, documentation, and queries, will be used in semantic search.



### 3. Open-Source



> Deploy WrenAI anywhere you like on your own data, LLM APIs, and environment, it's free.



## 🤖 WrenAI's Architecture



WrenAI consists of three core services:



- ***[Wren UI](https://github.com/Canner/WrenAI/tree/main/wren-ui):*** An intuitive user interface for asking questions, defining data relationships, and integrating data sources within WrenAI's framework.



- ***[Wren AI Service](https://github.com/Canner/WrenAI/tree/main/wren-ai-service):*** Processes queries using a vector database for context retrieval, guiding LLMs to produce precise SQL outputs.



- ***[Wren Engine](https://github.com/Canner/wren-engine):*** Serves as the semantic engine, mapping business terms to data sources, defining relationships, and incorporating predefined calculations and aggregations.



![wrenai_works](./misc/how_wrenai_works.png)



## 🤩 Learn More About Text-to-SQL



- [The new wave of Composable Data Systems and the Interface to LLM agents](https://blog.getwren.ai/the-new-wave-of-composable-data-systems-and-the-interface-to-llm-agents-ec8f0a2e7141)

- [How do you use OpenAI GPT-4o to query your database?](https://medium.com/wrenai/how-do-you-use-openai-gpt-4o-to-query-your-database-f24be68b0b70)

- [Top 4 Challenges using RAG with LLMs to Query Database (Text-to-SQL) and how to solve it.](https://blog.getwren.ai/4-key-technical-challenges-using-rag-with-llms-to-query-database-text-to-sql-and-how-to-solve-it-5d5a3d6682e5)

- [How we design our semantic engine for LLMs? The backbone of the semantic layer for LLM architecture.](https://blog.getwren.ai/how-we-design-our-semantic-engine-for-llms-84a00e6e3baa)

- [How do you use LangChain to build a Text-to-SQL solution? What are the challenges? How to solve it?](https://blog.getwren.ai/how-do-you-use-langchain-to-build-a-text-to-sql-solution-what-are-the-challenges-how-to-solve-it-b6d9c66aa038)

- [Deep dive into how Pinterest built its Text-to-SQL solution.](https://blog.getwren.ai/what-we-learned-from-pinterests-text-to-sql-solution-840fa5840635)

- [How Snowflake building the most powerful SQL LLM in the world](https://blog.getwren.ai/what-we-learned-from-snowflake-copilot-building-the-most-powerful-sql-llm-in-the-world-52f82d661bc1)

- [How to directly access 150k+ Hugging Face Datasets with DuckDB and query using GPT-4o](https://medium.com/wrenai/how-to-load-huggingface-datasets-into-duckdb-and-query-with-gpt-4o-c2db89519e4d)



## 🚧 Project Status



WrenAI is currently in ***alpha version***. The project team is actively working on progress and aiming to release new versions at least biweekly.



## 🚀 Getting Started



Using WrenAI is super simple, you can setup within 3 minutes, and start to interact with your own data!



- Visit our [Installation Guide of WrenAI](http://docs.getwren.ai/installation).

- Visit the [Usage Guides](http://docs.getwren.ai/guide/connect/overview) to learn more about how to use WrenAI.



## 📚 Documentation



Visit [WrenAI documentation](https://docs.getwren.ai) to view the full documentation.



## ⭐️ Community



- Welcome to our [Discord server](https://discord.gg/5DvshJqG8Z) to give us feedback!

- If there is any issues, please visit [GitHub Issues](https://github.com/Canner/WrenAI/issues).



Do note that our [Code of Conduct](./CODE_OF_CONDUCT.md) applies to all WrenAI community channels. Users are **highly encouraged** to read and adhere to them to avoid repercussions.