From 159da60c29edfd5a34799b99f2b006a4f0db16b7 Mon Sep 17 00:00:00 2001 From: sykp241095 Date: Fri, 21 Jun 2024 10:05:36 +0800 Subject: [PATCH] docs: fix readme --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3d368db1..7fc3af46 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ ## Introduction -A [WIP] conversational search RAG (Retrieval-Augmented Generation) app based on TiDB Serverless Vector Storage, providing a out-of-the-box and **embeddable** QA robot experience based on your knowledge on official and documentation sites. +A conversational search tool based on GraphRAG (Knowledge Graph) that built on top of [TiDB Vector](https://tidb.cloud/ai) and [LlamaIndex](https://github.com/run-llama/llama_index) and [DSPy](https://github.com/stanfordnlp/dspy). **Live Demo**: [TiDB.AI](https://tidb.cloud/?utm_source=github&utm_medium=tidb.ai) @@ -15,8 +15,11 @@ With this tool, you can achieve: ## Features 1. **Perplexity-style Conversational Search page**: Our platform features an advanced built-in website crawler, designed to elevate your browsing experience. This crawler effortlessly navigates official and documentation sites, ensuring comprehensive coverage and streamlined search processes through sitemap URL scraping. +![out-of-box-conversational-search](https://github.com/pingcap/tidb.ai/assets/1237528/9cc87d32-14ac-47c6-b664-efa7ec53e751 "Image Title") -![out-of-box-conversational-search](https://github.com/pingcap/tidb.ai/assets/1237528/0784e26e-8392-4bbe-bda1-6a680b12a805 "Image Title") +You can even edit the Knowledge Graph to add more information or correct any inaccuracies. This feature is particularly useful for enhancing the search experience and ensuring that the information provided is accurate and up-to-date. + +![out-of-box-conversational-search](https://github.com/pingcap/tidb.ai/assets/1237528/7bc57b34-99b7-4c4b-a098-9ad33dd0dfdc "Image Title") 2. **Embeddable JavaScript Snippet**: Integrate our conversational search window effortlessly into your website by copying and embedding a simple JavaScript code snippet. This widget, typically placed at the bottom right corner of your site, facilitates instant responses to product-related queries. @@ -33,6 +36,8 @@ With this tool, you can achieve: - [NextAuth.js](https://next-auth.js.org/) – Auth - [Vercel](https://vercel.com/) – Deployments - [LlamaIndex](https://www.llamaindex.ai/) - RAG framework +- [DSPy](https://github.com/stanfordnlp/dspy) - The framework for programming—not prompting—foundation models +- [TiDB Vector](https://tidb.cloud/ai) - Vector storage and search engine ## License