From 7cf4e88192baeb86ee1ba7004e411f75f12cb338 Mon Sep 17 00:00:00 2001 From: Howard Chi Date: Sat, 17 May 2025 18:39:16 +0800 Subject: [PATCH 1/2] Update README.md make readme much simpler --- README.md | 113 ++++++++++++++---------------------------------------- 1 file changed, 29 insertions(+), 84 deletions(-) diff --git a/README.md b/README.md index 34205f87ec..182c9c41cc 100644 --- a/README.md +++ b/README.md @@ -37,103 +37,30 @@

-## 🕶 Try it yourself! - -### GenBI (Generative Business Intelligence) - -[Watch GenBI Demo](https://github.com/user-attachments/assets/90ad1d35-bb1e-490b-9676-b29863ff090b) - -### Ask any questions - - -https://github.com/user-attachments/assets/f9c1cb34-5a95-4580-8890-ec9644da4160 - -👉 Try with your data on [Wren AI Cloud](https://getwren.ai/?utm_source=github&utm_medium=content&utm_campaign=readme) or [Install in your local environment](https://docs.getwren.ai/oss/installation/?utm_source=github&utm_medium=content&utm_campaign=readme) - -## Supported LLM Models - -Wren AI supports integration with various Large Language Models (LLMs), including but not limited to: -- OpenAI Models -- Azure OpenAI Models -- DeepSeek Models -- Google AI Studio – Gemini Models -- Vertex AI Models (Gemini + Anthropic) -- Bedrock Models -- Anthropic API Models -- Groq Models -- Ollama Models -- Databricks Models - -Check [configuration examples here](https://github.com/Canner/WrenAI/tree/main/wren-ai-service/docs/config_examples)! - -> [!CAUTION] -> The performance of Wren AI depends significantly on the capabilities of the LLM you choose. We strongly recommend using the most powerful model available for optimal results. Using less capable models may lead to reduced performance, slower response times, or inaccurate outputs. - ## 🎯 Our Vision & Mission At Wren AI, our mission is to revolutionize business intelligence by empowering organizations with seamless access to data through Generative Business Intelligence (GenBI). We aim to break down barriers to data insights with advanced AI-driven solutions, composable data frameworks, and semantic intelligence, enabling every team member to make faster, smarter, and data-driven decisions with confidence. 🤩 [Learn more about GenBI](https://getwren.ai/genbi?utm_source=github&utm_medium=content&utm_campaign=readme) -## 🤖 A User-Centric, End-to-End Open-source SQL AI Agent - Text-to-SQL Total Solution +## 🤖 Features ### 1. Talk to Your Data in Any Language > Wren AI speaks [your language](https://docs.getwren.ai/oss/guide/settings/pj_settings#change-project-language?utm_source=github&utm_medium=content&utm_campaign=readme), such as English, German, Spanish, French, Japanese, Korean, Portuguese, Chinese, and more. Unlock valuable insights by asking your business questions to Wren AI. It goes beyond surface-level data analysis to reveal meaningful information and simplifies obtaining answers from lead scoring templates to customer segmentation. -

- -

- ### 2. GenBI Insights > The GenBI feature empowers users with AI-generated summaries that provide key insights alongside SQL queries, simplifying complex data. Instantly convert query results into AI-generated reports, charts, transforming raw data into clear, actionable visuals. With GenBI, you can make faster, smarter decisions with ease. -

- Screenshot of Wren AI's GenBI feature showing AI-generated summaries and visualizations -

- - -### 3. AI-powered Data Exploration Features - -> Beyond just retrieving data from your databases, Wren AI now answers exploratory questions like “What data do I have?” or “What are the columns in my customer tables?” Additionally, our AI dynamically generates recommended questions and intelligent follow-up queries tailored to your context, making data exploration smarter, faster, and more intuitive. Empower your team to unlock deeper insights effortlessly with AI. - -

- -

- -### 4. Semantic Indexing with a Well-Crafted UI/UX +### 3. Semantic Layer with a Well-Crafted UI/UX > Wren AI has implemented a [semantic engine architecture](https://www.getwren.ai/post/how-we-design-our-semantic-engine-for-llms-the-backbone-of-the-semantic-layer-for-llm-architecture/?utm_source=github&utm_medium=content&utm_campaign=readme) 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. -

- -

- -### 5. Generate SQL Queries with Context - -> With Wren AI, you can process metadata, schema, terminology, data relationships, and the logic behind calculations and aggregations with [“Modeling Definition Language”](https://docs.getwren.ai/oss/engine/concept/what_is_mdl/?utm_source=github&utm_medium=content&utm_campaign=readme), reducing duplicate coding and simplifying data joins. - -

- -

- -### 6. Get Insights without Writing Code - -> When starting a new conversation in Wren AI, your question is used to find the most relevant tables. From these, LLM generates the most relevant question for the user. You can also ask follow-up questions to get deeper insights. - -

- -

- -### 7. Embedded AI-Powered SQL and Charts with the Wren AI API +### 4. Embedded AI-Powered SQL and Charts with the Wren AI API > Unlock the full power of Wren AI in your own applications. Our API lets you generate SQL queries and rich charts from natural language, effortlessly embedding Wren AI’s intelligence into your workflows. Plus, monitor and manage every interaction with our built-in API History for complete transparency and control. -

- -

- Check out the [full API documentation here](https://wrenai.readme.io/reference/welcome) ## 🤔 Why Wren AI? @@ -156,19 +83,37 @@ We focus on providing an open, secure, and accurate SQL AI Agent for everyone. > Build your own AI agents and applications with accurate and powerful GenBI capabilities powered by Wren AI API. -## 🤖 Wren AI Text-to-SQL Agentic Architecture +## 🕶 Try it yourself! -Wren AI consists of three core services: +### GenBI (Generative Business Intelligence) -- ***[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. +[Watch GenBI Demo](https://github.com/user-attachments/assets/90ad1d35-bb1e-490b-9676-b29863ff090b) -- ***[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. +### Ask any questions -- ***[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. -

- -

+https://github.com/user-attachments/assets/f9c1cb34-5a95-4580-8890-ec9644da4160 + +👉 Try with your data on [Wren AI Cloud](https://getwren.ai/?utm_source=github&utm_medium=content&utm_campaign=readme) or [Install in your local environment](https://docs.getwren.ai/oss/installation/?utm_source=github&utm_medium=content&utm_campaign=readme) + +## Supported LLM Models + +Wren AI supports integration with various Large Language Models (LLMs), including but not limited to: +- OpenAI Models +- Azure OpenAI Models +- DeepSeek Models +- Google AI Studio – Gemini Models +- Vertex AI Models (Gemini + Anthropic) +- Bedrock Models +- Anthropic API Models +- Groq Models +- Ollama Models +- Databricks Models + +Check [configuration examples here](https://github.com/Canner/WrenAI/tree/main/wren-ai-service/docs/config_examples)! + +> [!CAUTION] +> The performance of Wren AI depends significantly on the capabilities of the LLM you choose. We strongly recommend using the most powerful model available for optimal results. Using less capable models may lead to reduced performance, slower response times, or inaccurate outputs. ## ❤️ Knowledge Sharing From Wren AI From 1c190aa9228dff2f8e63d983ab0beb53bf343133 Mon Sep 17 00:00:00 2001 From: Howard Chi Date: Sat, 17 May 2025 18:40:18 +0800 Subject: [PATCH 2/2] Update README.md make it simpler --- README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/README.md b/README.md index 182c9c41cc..f555e00f01 100644 --- a/README.md +++ b/README.md @@ -79,10 +79,6 @@ We focus on providing an open, secure, and accurate SQL AI Agent for everyone. > Deploy Wren AI anywhere you like on your own data, LLM APIs, and environment, it's free. -### 4. Embedded AI with Wren AI API - -> Build your own AI agents and applications with accurate and powerful GenBI capabilities powered by Wren AI API. - ## 🕶 Try it yourself! ### GenBI (Generative Business Intelligence)