项目处于早期开发阶段,接口和部署方式可能变动;需自备 TiDB(Serverless Vector Storage)作为向量库;对话与嵌入依赖外部大模型,需另行配置模型服务。
autoflow
pingcapApache-2.0活跃维护基于 Graph RAG 的对话式知识库工具,用 TiDB Serverless 向量存储做检索,能基于知识图谱回答提问。
pingcap/autoflow is a Graph RAG based and conversational knowledge base tool built with TiDB Serverless Vector Storage. Demo: https://tidb.ai
docker compose up -dREADME 未说明 GPU 或显存要求;Docker Compose 部署建议 4 核 CPU、8GB 内存。
基于 Graph RAG 的对话式知识库工具,用 TiDB 向量存储快速搭建站点问答
基于 Graph RAG 的对话式知识库工具,用 TiDB Serverless 向量存储做检索,能基于知识图谱回答提问。
核心能力
- 用内置爬虫抓取官网与文档站,支持 sitemap 批量导入
- 提供 Perplexity 风格对话式搜索页面
- 可嵌入 JavaScript 片段,在网站右下角挂问答窗口
- 基于 LlamaIndex 与 DSPy 构建 Graph RAG 检索链路
- 用 TiDB 存储向量、聊天历史与 JSON 数据
容易踩的坑
- 0.4.0最新正式版2025-01-03 · 2025-01-03 09:33 UTC
Highlights
- Support Evaluation (beta) tool to evaluate the performance and reliability of the Chat Engine’s outputs (by @Icemap @634750802 ).
- Current support key metrics:
- Factual Correctness
- Semantic Similarity
- Current support key metrics:
- Support new LLM providers
- Gitee AI (by @lc-soft)
- Test new OpenAI-like providers (by @jrj5423)
- Support new embedding model providers
- Gitee AI (by @lc-soft)
- Amazon Bedrock (by @jrj5423 @Mini256)
Improvements
- Limit the upload file size via
max_upload_file_size(10MB by default) parameter on site setting (by @sszgwdk @634750802 ) - Support download the reference file in the chat page (by @Rutheniumlmw @634750802 )
New Contributors
- @sszgwdk made their first contribution in https://github.com/pingcap/autoflow/pull/497
- @jrj5423 made their first contribution in https://github.com/pingcap/autoflow/pull/522
- @Rutheniumlmw made their first contribution in https://github.com/pingcap/autoflow/pull/538
- @lc-soft made their first contribution in https://github.com/pingcap/autoflow/pull/470
- @nicognaW made their first contribution in https://github.com/pingcap/autoflow/pull/496
If you are deploying Autoflow using docker, please follow the Upgrade guide to upgrade your Autoflow.
Full Changelog: https://github.com/pingcap/autoflow/compare/v0.3.0...0.4.0
- Support Evaluation (beta) tool to evaluate the performance and reliability of the Chat Engine’s outputs (by @Icemap @634750802 ).
- 0.4.0rc1pre-release2024-12-31 · 2024-12-31 07:24 UTC
查看更新说明
What's Changed
- e2e: fix bootstrap by @634750802 in https://github.com/pingcap/autoflow/pull/438
- fix: structured prediction is only for openai api by @Icemap in https://github.com/pingcap/autoflow/pull/487
- ui(frontend): add a cool homepage background made by magicui.design by @634750802 in https://github.com/pingcap/autoflow/pull/464
- ui(frontend): refine progress chart label by @634750802 in https://github.com/pingcap/autoflow/pull/489
- chore(frontend): upgrade to nextjs 15 + react 19 by @634750802 in https://github.com/pingcap/autoflow/pull/488
- e2e: fix bootstrap by @634750802 in https://github.com/pingcap/autoflow/pull/491
- fix(frontend): refresh after navigating by @634750802 in https://github.com/pingcap/autoflow/pull/492
- feat: evaluate api by @Icemap in https://github.com/pingcap/autoflow/pull/463
- feat(frontend): evaluation management pages by @634750802 in https://github.com/pingcap/autoflow/pull/495
- Enable passing custom domain username via cli by @chethanuk in https://github.com/pingcap/autoflow/pull/420
- add verification for stackvm by @IANTHEREAL in https://github.com/pingcap/autoflow/pull/503
- feat: add site setting upload_max_body_size by @sszgwdk in https://github.com/pingcap/autoflow/pull/497
- Enable passing custom admin username and password, enable resetting … by @sszgwdk in https://github.com/pingcap/autoflow/pull/499
- support response format by @IANTHEREAL in https://github.com/pingcap/autoflow/pull/504
- fix: staging errors by @Icemap in https://github.com/pingcap/autoflow/pull/498
- feat: update evaluation api group by @Icemap in https://github.com/pingcap/autoflow/pull/515
- feat(frontend): refine evaluation management pages by @634750802 in https://github.com/pingcap/autoflow/pull/513
- Extend graph search capabilities by @IANTHEREAL in https://github.com/pingcap/autoflow/pull/517
- refine(frontend): partial replace react-hook-form with @tanstack/form by @634750802 in https://github.com/pingcap/autoflow/pull/519
- Improve graph basic api by @IANTHEREAL in https://github.com/pingcap/autoflow/pull/521
- docs: add examples of vLLM and Xinference models by @jrj5423 in https://github.com/pingcap/autoflow/pull/522
- refactor(frontend): replace react-hook-form with @tanstack/form by @634750802 in https://github.com/pingcap/autoflow/pull/524
- Refine the goal background generation and api by @IANTHEREAL in https://github.com/pingcap/autoflow/pull/530
- e2e: add new chat engine tests by @634750802 in https://github.com/pingcap/autoflow/pull/529
- fix(frontend): only show widget on homepage by @634750802 in https://github.com/pingcap/autoflow/pull/531
- fix(frontend): fix widget display conditions by @634750802 in https://github.com/pingcap/autoflow/pull/533
- e2e: add knowledge base test cases by @634750802 in https://github.com/pingcap/autoflow/pull/536
- doc: evaluation by @Icemap in https://github.com/pingcap/autoflow/pull/539
- docs: add "How to add an API?" to CONTRIBUTING.md by @Rutheniumlmw in https://github.com/pingcap/autoflow/pull/538
- Upgrade claude sonnet models by @chethanuk in https://github.com/pingcap/autoflow/pull/534
- Fix embedding model bug and support arm platform by @IANTHEREAL in https://github.com/pingcap/autoflow/pull/543
- feat: change the visibility of evaluation entities by @Icemap in https://github.com/pingcap/autoflow/pull/540
- fix bug of merging entities by @IANTHEREAL in https://github.com/pingcap/autoflow/pull/546
- feat: add Gitee AI provider by @lc-soft in https://github.com/pingcap/autoflow/pull/470
- Add current to text refine question prompt by @nicognaW in https://github.com/pingcap/autoflow/pull/496
- e2e: add evaluation dataset test cases by @634750802 in https://github.com/pingcap/autoflow/pull/544
- fix chunks model for knowledge graph by @IANTHEREAL in https://github.com/pingcap/autoflow/pull/550
- docs: fix dev docker compose filepath on CONTRIBUTING.md by @lc-soft in https://github.com/pingcap/autoflow/p
- v0.3.00.3.02024-12-09 · 2024-12-09 05:16 UTC
查看更新说明
Release note
- Rename project to autoflow
- Multiple Knowledge Bases support
- Support new embedding models providers
For details, please check Release Notes for v0.3.0
‼️ Migrate from v0.2.x to v0.3.0
If you want to upgrade autoflow from v0.2.x to v0.3.0, please check the breaking changes and migration guide before migration.
New Contributors
- @chethanuk made their first contribution in https://github.com/pingcap/autoflow/pull/421
Full Changelog: https://github.com/pingcap/autoflow/compare/0.2.9...v0.3.0
- 0.2.02024-08-22 · 2024-08-22 00:26 UTC
- 0.1.02024-08-12 · 2024-08-12 08:45 UTC
查看更新说明
See release note and deployment guide
用户点评
登录用户的真实使用记录,可按版本和硬件筛选还没有人点评。第一个说出真实体验的人最有价值。
[!WARNING] Autoflow is still in the early stages of development. And we are actively working on it, the next move is to make it to a python package and make it a RAG solution e.g.
pip install autoflow-ai. If you have any questions or suggestions, please feel free to contact us on Discussion.
Introduction
AutoFlow is an open source graph rag (graphrag: knowledge graph rag) based knowledge base tool built on top of TiDB Vector and LlamaIndex and DSPy.
- Live Demo: https://tidb.ai
- Deployment Docs: Deployment Docs
Features
- 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.
- 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.
Deploy
- Deploy with Docker Compose (with: 4 CPU cores and 8GB RAM)
Tech Stack
- TiDB – Database to store chat history, vector, json, and analytic
- LlamaIndex - RAG framework
- DSPy - The framework for programming—not prompting—foundation models
- Next.js – Framework
- Tailwind CSS – CSS framework
- shadcn/ui - Design
Contributing
We welcome contributions from the community. If you are interested in contributing to the project, please read the Contributing Guidelines.
License
AutoFlow is open-source under the Apache License, Version 2.0. You can find it here.
Contact
You can reach out to us on Discord.