Skip to content

Commit

Permalink
docs: rename pingcap/tidb.ai to pingcap/autoflow
Browse files Browse the repository at this point in the history
  • Loading branch information
sykp241095 committed Nov 15, 2024
1 parent 57988a3 commit 7222a5d
Show file tree
Hide file tree
Showing 8 changed files with 21 additions and 21 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- markdownlint-disable MD033 MD041 -->

<div align="center">
<h1>TiDB.AI</h1>
<a href='https://tidb.cloud/?utm_source=github&utm_medium=tidb.ai'>
<h1>autoflow</h1>
<a href='https://www.pingcap.com/tidb-cloud-serverless/?utm_source=tidb.ai&utm_medium=community'>
<img src="https://raw.githubusercontent.com/pingcap/tidb.ai/main/frontend/app/public/nextra/icon-dark.svg" alt="TiDB.AI" width =100 height=100></img>
</a>
</div>
Expand All @@ -13,9 +13,9 @@

## Introduction

An open source GraphRAG (Knowledge Graph) 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).
An open source GraphRAG (Knowledge Graph) built on top of [TiDB Vector](https://www.pingcap.com/ai?utm_source=tidb.ai&utm_medium=community) 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)
- **Live Demo**: [TiDB.AI](https://tidb.ai)
- **Documentation**: [Docs](https://tidb.ai/docs/?utm_source=github&utm_medium=tidb.ai)

## Features
Expand All @@ -38,7 +38,7 @@ An open source GraphRAG (Knowledge Graph) built on top of [TiDB Vector](https://

## Tech Stack

- [TiDB](https://pingcap.com/ai/?utm_source=github&utm_medium=tidb.ai) – Database to store chat history, vector, json, and analytic
- [TiDB](https://www.pingcap.com/ai?utm_source=tidb.ai&utm_medium=community) – Database to store chat history, vector, json, and analytic
- [LlamaIndex](https://www.llamaindex.ai/) - RAG framework
- [DSPy](https://github.com/stanfordnlp/dspy) - The framework for programming—not prompting—foundation models
- [Next.js](https://nextjs.org/) – Framework
Expand Down
2 changes: 1 addition & 1 deletion frontend/app/src/pages/docs/data-source.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ In order to provide answers to users, you need to add data source to the tool. T

Currently we support the following data sources:
* Markdown, HTML, PDF, etc.
* Website's SiteMap, if you have a website, you can use the SiteMap to add data source. tidb.ai will crawl the website and index the data automatically.
* Website's SiteMap, if you have a website, you can use the SiteMap to add data source. pingcap/autoflow will crawl the website and index the data automatically.
* Single URL, you can add a single URL as data source.


Expand Down
14 changes: 7 additions & 7 deletions frontend/app/src/pages/docs/deploy-with-docker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ This document provides instructions for deploying the entire RAG using Docker Co
1. Clone the repository:

```bash
git clone https://github.com/pingcap/tidb.ai.git
cd tidb.ai
git clone https://github.com/pingcap/autoflow.git
cd autoflow
```

2. Select an embedding model for TiDB.AI.
2. Select an embedding model for pingcap/autoflow.

We recommend using the OpenAI text-embedding-3-small model for TiDB.AI, but you can also use other supported embedding models.
We recommend using the OpenAI text-embedding-3-small model for autoflow, but you can also use other supported embedding models.

- OpenAI
- text-embedding-3-small
Expand Down Expand Up @@ -88,7 +88,7 @@ If you want to use a different embedding model after deployment, you need to rec

7. Open your browser and visit `http://localhost:3000` to access the web interface.

That's it! You can now use TiDB.AI locally. You can also go to https://tidb.ai to experience the live demo.
That's it! You can now use pingcap/autoflow locally. You can also go to https://tidb.ai to experience the live demo.
## Configuration
Expand All @@ -104,9 +104,9 @@ After you deploy the tool, you need to initialize the tool by following the popu
## Upgrade
This section will help you upgrade tidb.ai to the new version.
This section will help you upgrade pingcap/autoflow to the new version.
Suppose you want to upgrade tidb.ai from 0.1.0 to version 0.2.0
Suppose you want to upgrade pingcap/autoflow from 0.1.0 to version 0.2.0
1. Edit your docker-compose.yml file to use the new image version.
Expand Down
4 changes: 2 additions & 2 deletions frontend/app/src/pages/docs/embedding-model.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Note: The Embedding Model is configured at the beggining of the deployment proce

If you want to change the embedding model, you need to:
* Redeploy the RAG app currently.
* Or you can start a discussion in the [GitHub Discussions](https://github.com/pingcap/tidb.ai/discussions)
* Or you can start a discussion in the [GitHub Discussions](https://github.com/pingcap/autoflow/discussions)
</Callout>

You can enter the admin panel to view the current embedding model and its configuration.

![embedding-model-config](https://github.com/user-attachments/assets/5cb589c1-3579-417e-9730-dcbe5aee4f84 "Embedding Model Config")
![embedding-model-config](https://github.com/user-attachments/assets/5cb589c1-3579-417e-9730-dcbe5aee4f84 "Embedding Model Config")
6 changes: 3 additions & 3 deletions frontend/app/src/pages/docs/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The FAQ is a collection of useful questions and answers about the
project. If you have a question that isn't answered here, please
[open a discussion](https://github.com/pingcap/tidb.ai/discussions).
[open a discussion](https://github.com/pingcap/autoflow/discussions).

export function FAQBox({ title, children }) {
return (
Expand All @@ -26,8 +26,8 @@ export function FAQBox({ title, children }) {
</FAQBox>

<FAQBox title="Is this RAG app free?">
- [Free] The code of this RAG app is open source, it's free to use;
- [Free] The database of this RAG app is free for **25GiB storage** as we use [TiDB Serverless](https://tidb.cloud);
- [Free] The code of this RAG app pingcap/autoflow is open source, it's free to use;
- [Free] The database of this RAG app is free for **25GiB storage** as we use [TiDB Cloud Serverless](https://www.pingcap.com/tidb-cloud-serverless/?utm_source=tidb.ai&utm_medium=community);
- [Paid] **But** the token of OpenAI is paid, you should have an account of https://platform.openai.com for an API token.
</FAQBox>

Expand Down
2 changes: 1 addition & 1 deletion frontend/app/src/pages/docs/javascript.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To embed the JavaScript snippet, follow these steps:

4. Restart your website to see the conversational search window appear at the bottom right corner of your site.

![embeddable-javascript-snippet](https://github.com/pingcap/tidb.ai/assets/1237528/5a445231-a27a-4ae6-8287-a4f8cf7b64d0 "Image Title")
![embeddable-javascript-snippet](https://github.com/pingcap/autoflow/assets/1237528/5a445231-a27a-4ae6-8287-a4f8cf7b64d0 "Image Title")



Expand Down
2 changes: 1 addition & 1 deletion frontend/app/src/pages/docs/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ After deployment and configuration, you need to add data source to the tool for

After deployment, configuration and adding data source, you can use the tool to chat with users to answer their questions.

pingcap/tidb.ai provides several features to help you chat with users:
pingcap/autoflow provides several features to help you chat with users:

1. Out-of-the-box chat interface, e.g. https://tidb.ai
2. API to chat with users programmatically, e.g. https://tidb.ai/api-docs
Expand Down
2 changes: 1 addition & 1 deletion releases/v0.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ This is the first release of TiDB.AI.

## Known Issues

For a list of known issues, please visit our [GitHub Issues page](https://github.com/pingcap/tidb.ai/issues). If you encounter any problems, we encourage you to report them.
For a list of known issues, please visit our [GitHub Issues page](https://github.com/pingcap/autoflow/issues). If you encounter any problems, we encourage you to report them.

0 comments on commit 7222a5d

Please sign in to comment.