Skip to content

Commit 042ef19

Browse files
committed
docs: update references from TiDB Cloud Serverless to TiDB Cloud Starter
- Changed all instances of "TiDB Cloud Serverless" to "TiDB Cloud Starter" across various documentation files, including demos, guides, and examples. - Ensured consistency in terminology to reflect the updated branding and offerings of TiDB Cloud.
1 parent 4dc91ad commit 042ef19

22 files changed

+132
-86
lines changed

.cursor/rules/styleguide.mdc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ You are acting as a **senior technical writer** who is reviewing TiDB documentat
5151

5252
- Inconsistent use of technical terms
5353

54-
_"TiDB Cloud Serverless clusters" vs. "TiDB Serverless clusters"_ – pick one.
54+
_"TiDB Cloud Starter clusters" vs. "TiDB Cloud clusters"_ – pick one.
5555

5656
- Unclear step instructions
5757

demos.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
title: "Demo Gallery"
33
description: |
44
Explore hands-on demos showcasing how TiDB empowers AI applications.<br>
5-
Get started quickly with <a href='https://tidbcloud.com/?utm_source=github&utm_medium=referral&utm_campaign=demo_gallery' target='_blank' rel='noopener noreferrer' class='gallery-cta-link'><b>TiDB Cloud Serverless</b></a> to build your own AI-powered solutions.
5+
Get started quickly with <a href='https://tidbcloud.com/?utm_source=github&utm_medium=referral&utm_campaign=demo_gallery' target='_blank' rel='noopener noreferrer' class='gallery-cta-link'><b>TiDB Cloud Starter</b></a> to build your own AI-powered solutions.
66
77
meta:
8-
description: "Explore hands-on demos showcasing how TiDB empowers AI applications. Get started quickly with TiDB Cloud Serverless to build your own AI-powered solutions."
8+
description: "Explore hands-on demos showcasing how TiDB empowers AI applications. Get started quickly with TiDB Cloud Starter to build your own AI-powered solutions."
99

1010
categories:
1111
- id: "featured"
@@ -119,9 +119,9 @@ demos:
119119
# CTA section configuration
120120
cta:
121121
title: "Ready to build your AI application?"
122-
description: "Start your AI journey with TiDB Cloud Serverless. Follow our quickstart guide to build your first AI-powered application in minutes, or explore specific examples for your use case."
122+
description: "Start your AI journey with TiDB Cloud Starter. Follow our quickstart guide to build your first AI-powered application in minutes, or explore specific examples for your use case."
123123
buttons:
124-
- text: "Try TiDB Cloud Serverless"
124+
- text: "Try TiDB Cloud Starter"
125125
url: "https://tidbcloud.com/?utm_source=github&utm_medium=referral&utm_campaign=pytidb_readme"
126126
type: "primary"
127127
external: true

src/ai/concepts/vector-search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Vector search offers a powerful solution for semantic similarity searches across
1010

1111
!!! note
1212

13-
The vector search feature is only available for TiDB Self-Managed clusters and [TiDB Cloud Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters.
13+
The vector search feature is only available for TiDB Self-Managed clusters and [TiDB Cloud Starter](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-starter) clusters.
1414

1515
## Concepts
1616

src/ai/examples/auto-embedding-with-pytidb.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ This example showcases how to use the auto embedding feature with PyTiDB Client.
1616
## Prerequisites
1717

1818
- **Python 3.10+**
19-
- **A TiDB Cloud Serverless cluster**: Create a free cluster here: [tidbcloud.com ↗️](https://tidbcloud.com/?utm_source=github&utm_medium=referral&utm_campaign=pytidb_readme)
20-
- **Jina AI API key**: Go to [Jina AI](https://jina.ai/embeddings/) to get your own API key
19+
- **A TiDB Cloud Starter cluster**: Create a free cluster here: [tidbcloud.com ↗️](https://tidbcloud.com/?utm_source=github&utm_medium=referral&utm_campaign=pytidb_readme)
2120

2221
## How to run
2322

@@ -47,7 +46,9 @@ TIDB_PORT=4000
4746
TIDB_USERNAME={prefix}.root
4847
TIDB_PASSWORD={password}
4948
TIDB_DATABASE=test
50-
JINA_AI_API_KEY={your-jina-api-key}
49+
50+
# Using TiDB Cloud Free embedding model by default, which is no required to set up any API key
51+
EMBEDDING_PROVIDER=tidbcloud_free
5152
EOF
5253
```
5354

@@ -61,7 +62,7 @@ python main.py
6162

6263
```plain
6364
=== Define embedding function ===
64-
Embedding function defined
65+
Embedding function (model id: tidbcloud_free/amazon/titan-embed-text-v2) defined
6566
6667
=== Define table schema ===
6768
Table created

src/ai/examples/basic-with-pytidb.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This example demonstrates basic CRUD (Create, Read, Update, Delete) operations w
1515
## Prerequisites
1616

1717
- **Python 3.10+**
18-
- **A TiDB Cloud Serverless cluster**: Create a free cluster here: [tidbcloud.com ↗️](https://tidbcloud.com/?utm_source=github&utm_medium=referral&utm_campaign=pytidb_readme)
18+
- **A TiDB Cloud Starter cluster**: Create a free cluster here: [tidbcloud.com ↗️](https://tidbcloud.com/?utm_source=github&utm_medium=referral&utm_campaign=pytidb_readme)
1919

2020
## How to run
2121

@@ -73,13 +73,13 @@ ID: 3, Content: LlamaIndex is a Python library for building AI-powered applicati
7373
7474
=== UPDATE ===
7575
Updated item #1
76-
After update - ID: 1, Content: TiDB Cloud Serverless is a fully-managed, auto-scaling cloud database service, Metadata: {'category': 'dbass'}
76+
After update - ID: 1, Content: TiDB Cloud Starter is a fully-managed, auto-scaling cloud database service, Metadata: {'category': 'dbass'}
7777
7878
=== DELETE ===
7979
Deleted item #2
8080
8181
=== FINAL STATE ===
82-
ID: 1, Content: TiDB Cloud Serverless is a fully-managed, auto-scaling cloud database service, Metadata: {'category': 'dbass'}
82+
ID: 1, Content: TiDB Cloud Starter is a fully-managed, auto-scaling cloud database service, Metadata: {'category': 'dbass'}
8383
ID: 3, Content: LlamaIndex is a Python library for building AI-powered applications, Metadata: {'category': 'rag'}
8484
8585
=== COUNT ROWS ===

src/ai/examples/fulltext-search-with-pytidb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This example demonstrates how to build a E-commerce product search application u
1616
## Prerequisites
1717

1818
- **Python 3.10+**
19-
- **A TiDB Cloud Serverless cluster**: Create a free cluster here: [tidbcloud.com ↗️](https://tidbcloud.com/?utm_source=github&utm_medium=referral&utm_campaign=pytidb_readme)
19+
- **A TiDB Cloud Starter cluster**: Create a free cluster here: [tidbcloud.com ↗️](https://tidbcloud.com/?utm_source=github&utm_medium=referral&utm_campaign=pytidb_readme)
2020

2121
## How to run
2222

src/ai/examples/hybrid-search-with-pytidb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ In this demo, we will show you how to use hybrid search to combine vector search
2323
>
2424
> Currently, full-text search is only available for the following product option and region:
2525
>
26-
> - TiDB Cloud Serverless: Frankfurt (eu-central-1), Singapore (ap-southeast-1)
26+
> - TiDB Cloud Starter: Frankfurt (eu-central-1), Singapore (ap-southeast-1)
2727
2828
## How to run
2929

src/ai/examples/image-search-with-pytidb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ With just a few lines of code, you can create an intelligent search system that
2222
## Prerequisites
2323

2424
- **Python 3.10+**
25-
- **A TiDB Cloud Serverless cluster**: Create a free cluster here: [tidbcloud.com ↗️](https://tidbcloud.com/?utm_source=github&utm_medium=referral&utm_campaign=pytidb_readme)
25+
- **A TiDB Cloud Starter cluster**: Create a free cluster here: [tidbcloud.com ↗️](https://tidbcloud.com/?utm_source=github&utm_medium=referral&utm_campaign=pytidb_readme)
2626
- **Jina AI API Key**: Get your free API key at [jina.ai Embeddings ↗️](https://jina.ai/embeddings/)
2727

2828
## How to run
@@ -54,7 +54,7 @@ TIDB_USERNAME={prefix}.root
5454
TIDB_PASSWORD={password}
5555
TIDB_DATABASE=test
5656
57-
JINA_AI_API_KEY={your-jina-api-key}
57+
JINA_AI_API_KEY={your-jina-ai-api-key}
5858
EOF
5959
```
6060

src/ai/examples/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Demo Gallery
3-
description: Explore hands-on demos showcasing how TiDB empowers AI applications. Get started quickly with TiDB Cloud Serverless to build your own AI-powered solutions.
3+
description: Explore hands-on demos showcasing how TiDB empowers AI applications. Get started quickly with TiDB Cloud Starter to build your own AI-powered solutions.
44
hide:
55
- navigation
66
- toc
@@ -64,7 +64,7 @@ html {
6464
.gallery-cta-link {
6565
position: relative;
6666
text-decoration: none;
67-
transition: all 0.2s ease-in-out;
67+
transition: all 0.3s ease-in-out;
6868
}
6969

7070
.gallery-cta-link:hover {
@@ -345,7 +345,7 @@ html {
345345
<h1 class="gallery-title">Demo Gallery</h1>
346346
<p class="gallery-description">
347347
Explore hands-on demos showcasing how TiDB empowers AI applications.<br>
348-
Get started quickly with <a href='https://tidbcloud.com/?utm_source=github&utm_medium=referral&utm_campaign=demo_gallery' target='_blank' rel='noopener noreferrer' class='gallery-cta-link'><b>TiDB Cloud Serverless</b></a> to build your own AI-powered solutions.
348+
Get started quickly with <a href='https://tidbcloud.com/?utm_source=github&utm_medium=referral&utm_campaign=demo_gallery' target='_blank' rel='noopener noreferrer' class='gallery-cta-link'><b>TiDB Cloud Starter</b></a> to build your own AI-powered solutions.
349349

350350
</p>
351351
</div>
@@ -389,8 +389,8 @@ Get started quickly with <a href='https://tidbcloud.com/?utm_source=github&utm_m
389389
</div>
390390
</a>
391391
<a href="memory-with-pytidb/" class="gallery-card">
392-
<div class="card-image card-gradient" style="background: linear-gradient(135deg, #8b5cf6, var(--brand-color));">
393-
<div>💭</div>
392+
<div class="card-image">
393+
<img src="https://github.com/user-attachments/assets/74dee96b-ea20-49dc-ad27-679faa5bf9b8" alt="Memory Demo">
394394
</div>
395395
<div class="card-content">
396396
<h3 class="card-title">Memory</h3>
@@ -492,8 +492,8 @@ Get started quickly with <a href='https://tidbcloud.com/?utm_source=github&utm_m
492492
</div>
493493
</a>
494494
<a href="memory-with-pytidb/" class="gallery-card">
495-
<div class="card-image card-gradient" style="background: linear-gradient(135deg, #8b5cf6, var(--brand-color));">
496-
<div>💭</div>
495+
<div class="card-image">
496+
<img src="https://github.com/user-attachments/assets/74dee96b-ea20-49dc-ad27-679faa5bf9b8" alt="Memory Demo">
497497
</div>
498498
<div class="card-content">
499499
<h3 class="card-title">Memory</h3>
@@ -518,11 +518,11 @@ Get started quickly with <a href='https://tidbcloud.com/?utm_source=github&utm_m
518518
<div class="gallery-cta">
519519
<h3 class="cta-title">Ready to build your AI application?</h3>
520520
<p class="cta-description">
521-
Start your AI journey with TiDB Cloud Serverless. Follow our quickstart guide to build your first AI-powered application in minutes, or explore specific examples for your use case.
521+
Start your AI journey with TiDB Cloud Starter. Follow our quickstart guide to build your first AI-powered application in minutes, or explore specific examples for your use case.
522522
</p>
523523
<div class="cta-buttons">
524-
<a href="https://tidbcloud.com/?utm_source=github&utm_medium=referral&utm_campaign=pytidb_readme" target="_blank" rel="noopener noreferrer" class="btn-primary">Try TiDB Cloud Serverless</a>
525-
<a href="quickstart-with-pytidb/" class="btn-secondary">View Quickstart Guide</a>
524+
<a href="https://tidbcloud.com/?utm_source=github&utm_medium=referral&utm_campaign=pytidb_readme" target="_blank" rel="noopener noreferrer" class="btn-primary">Try TiDB Cloud Starter</a>
525+
<a href="/ai/quickstart/" class="btn-secondary">View Quickstart Guide</a>
526526
</div>
527527
</div>
528528
</div>

src/ai/examples/memory-with-pytidb.md

Lines changed: 69 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,60 +4,103 @@ description: "Implement conversation memory for chatbots and conversational AI a
44
source_repo: "https://github.com/pingcap/pytidb/tree/main/examples/memory"
55
---
66

7-
# Agent Memory Examples
7+
# AI Agent Memory Demo
88

9-
* Use `pytidb` to connect to TiDB
9+
This example showcases how to build an intelligent AI agent with persistent memory powered by TiDB's vector search capabilities.
1010

11-
## Prerequisites
11+
With just a few lines of code, you can create a conversational AI that remembers past interactions and builds context over time.
12+
13+
- 🧠 **Persistent Memory**: The AI remembers conversations across sessions and user interactions
14+
- 💬 **Interactive Chat**: Both web interface and command-line options for flexible interaction
15+
- 👤 **Multi-User Support**: Different users can have separate memory contexts
16+
- 🔍 **Real-Time Memory Viewing**: Visual display of all stored memories in the web interface
1217

13-
* Python 3.10+
14-
* TiDB server connection parameters, either local or TiDB Cloud
15-
* OpenAI API key
18+
<p align="center">
19+
<img src="https://github.com/user-attachments/assets/b57ae0fb-9075-43a9-8690-edaa69ca9f40" alt="AI Agent with memory powered by TiDB" width="700"/>
20+
<p align="center"><i>AI Agent with memory powered by TiDB</i></p>
21+
</p>
22+
23+
## Prerequisites
1624

25+
- **Python 3.10+**
26+
- **A TiDB Cloud Starter cluster**: Create a free cluster here: [tidbcloud.com ↗️](https://tidbcloud.com/?utm_source=github&utm_medium=referral&utm_campaign=pytidb_readme)
27+
- **OpenAI API Key**: Get your API key at [OpenAI Platform ↗️](https://platform.openai.com/api-keys)
1728

1829
## How to run
1930

20-
**Step1**: Clone the repo
31+
**Step 1**: Clone the repository to local
2132

2233
```bash
2334
git clone https://github.com/pingcap/pytidb.git
24-
cd pytidb/examples/memory;
35+
cd pytidb/examples/memory/
2536
```
2637

27-
**Step2**: Install the required packages and setup environment
38+
**Step 2**: Install the required packages
2839

2940
```bash
3041
python -m venv .venv
31-
source .venv/bin/activate
42+
source .venv/bin/activate # Windows: .venv\Scripts\activate
3243
pip install -r reqs.txt
3344
```
3445

35-
**Step3**: Set up environment to connect to storage
46+
**Step 3**: Set up environment variables
3647

37-
You can find the connection string in the [TiDB Cloud console](https://tidbcloud.com/).
38-
39-
If you are using a local TiDB server, you can set up the environment variable like this:
48+
Go to [TiDB Cloud console](https://tidbcloud.com/clusters) and get the connection parameters, then set up the environment variable like this:
4049

4150
```bash
4251
cat > .env <<EOF
43-
TIDB_HOST=localhost
52+
TIDB_HOST={gateway-region}.prod.aws.tidbcloud.com
4453
TIDB_PORT=4000
45-
TIDB_USERNAME=root
46-
TIDB_PASSWORD=
54+
TIDB_USERNAME={prefix}.root
55+
TIDB_PASSWORD={password}
4756
TIDB_DATABASE=test
4857
49-
OPENAI_API_KEY=your_openai_api_key
58+
OPENAI_API_KEY={your-openai-api-key}
5059
EOF
5160
```
5261

53-
**Step4**: Run the app
62+
**Step 4**: Run the application
63+
64+
Choose one of the following options:
5465

55-
Run the following command to start the app, feel free to talk with the AI assistant and tell him/her any information about you.
66+
**Option 1**: Launch Web Application:
67+
68+
```bash
69+
streamlit run app.py
70+
```
71+
72+
Visit `http://localhost:8501` in your browser and follow the instructions in the [Interact with memory in Web Application](https://github.com/pingcap/pytidb/tree/main/examples/memory/#interact-with-memory-in-web-application) section to start interacting with the memory-enabled AI assistant.
73+
74+
**Option 2**: Run Command Line Application:
5675

5776
```bash
5877
python main.py
5978
```
6079

80+
Follow the instructions in the [Interact with memory in Command Line Application](https://github.com/pingcap/pytidb/tree/main/examples/memory/#interact-with-memory-in-command-line-application) section to start interacting with the memory-enabled AI assistant.
81+
82+
## Interact with memory in Web Application
83+
84+
In the web application, you can interact with the AI assistant, the user interface includes:
85+
86+
- **Sidebar**: User settings and chat list.
87+
- **Main chat area**: Chat interface with the AI assistant.
88+
- **Memory viewer**: Real-time memory viewer showing stored facts.
89+
90+
You can follow the following steps to check how the memory works:
91+
92+
1. Introduce yourself in the default chat session. For example, "Hello, I am John. I work as a software engineer and love guitar."
93+
2. You can see the information you provided in the memory viewer.
94+
3. Click **New chat** in the sidebar to start a new chat session.
95+
4. Ask "Who am I?" in the new chat session. The AI will recall your information from previous conversations.
96+
97+
98+
## Interact with memory in Command Line Application
99+
100+
In the command line application, you can interact with the AI assistant and introduce yourself.
101+
102+
**Example conversation:**
103+
61104
```plain
62105
Chat with AI (type 'exit' to quit)
63106
You: Hello, I am Mini256.
@@ -70,11 +113,11 @@ You: exit
70113
Goodbye!
71114
```
72115

73-
Open another terminal and run the app again, ask the AI assistant "Who am I?":
116+
After the first conversation, the AI assistant will remember the information you provided and use it to answer future questions.
74117

75-
```bash
76-
python main.py
77-
```
118+
Now, you can start a new chat session and ask the AI assistant "Who am I?".
119+
120+
**Example conversation in another chat session:**
78121

79122
```plain
80123
Chat with AI (type 'exit' to quit)
@@ -84,7 +127,8 @@ You: exit
84127
Goodbye!
85128
```
86129

87-
As you can see, the AI assistant remembers you!
130+
As you can see, the AI assistant remembers you across sessions!
131+
88132

89133

90134
---

0 commit comments

Comments
 (0)