update parameter order and serverless doc link

pingcap · Oct 14, 2024 · 5ddb8cf · 5ddb8cf
1 parent 49f624c
commit 5ddb8cf
Show file tree

Hide file tree

Showing 10 changed files with 20 additions and 21 deletions.
diff --git a/vector-search-functions-and-operators.md b/vector-search-functions-and-operators.md
@@ -17,7 +17,7 @@ This document lists the functions and operators available for Vector data types.
 
 > **Note:**
 >
-> Vector data types and these vector functions are only available for TiDB Self-Managed clusters and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters.
+> Vector data types and these vector functions are only available for TiDB Self-Managed clusters and [TiDB Cloud Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters.
 
 ## Vector functions
 

diff --git a/vector-search-get-started-using-python.md b/vector-search-get-started-using-python.md
@@ -121,7 +121,7 @@ TIDB_DATABASE_URL="mysql+pymysql://<USER>:<PASSWORD>@<HOST>:<PORT>/<DATABASE>"
 
 If you are running TiDB on your local machine, `<HOST>` is `127.0.0.1` by default. The initial `<PASSWORD>` is empty, so if you are starting the cluster for the first time, you can omit this field.
 
-The following are descriptions for each placeholder:
+The following are descriptions for each parameter:
 
 - `<USER>`: The username to connect to the TiDB cluster.
 - `<PASSWORD>`: The password to connect to the TiDB cluster.

diff --git a/vector-search-index.md b/vector-search-index.md
@@ -19,7 +19,7 @@ In TiDB, you can create and use vector search indexes for such approximate neare
 
 > **Note:**
 >
-> The vector search feature is only available for TiDB Self-Managed clusters and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters.
+> 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.
 
 TiDB currently supports the [HNSW (Hierarchical Navigable Small World)](https://en.wikipedia.org/wiki/Hierarchical_navigable_small_world) vector search index algorithm.
 

diff --git a/vector-search-integrate-with-jinaai-embedding.md b/vector-search-integrate-with-jinaai-embedding.md
@@ -17,7 +17,7 @@ This tutorial walks you through how to use [Jina AI](https://jina.ai/) to genera
 
 > **Note:**
 >
-> The vector search feature is only available for TiDB Self-Managed clusters and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters.
+> 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.
 
 ## Prerequisites
 
@@ -128,14 +128,14 @@ export TIDB_DATABASE_URL="mysql+pymysql://<USERNAME>:<PASSWORD>@<HOST>:<PORT>/<D
 # For example: export TIDB_DATABASE_URL="mysql+pymysql://[email protected]:4000/test"
 ```
 
-You need to replace parameters in the preceding command according to your TiDB cluster. If you are running TiDB on your local machine, `HOST` is `127.0.0.1` by default. The initial `PASSWORD` is empty, so if you are starting the cluster for the first time, you can omit this field.
+You need to replace parameters in the preceding command according to your TiDB cluster. If you are running TiDB on your local machine, `<HOST>` is `127.0.0.1` by default. The initial `<PASSWORD>` is empty, so if you are starting the cluster for the first time, you can omit this field.
 
 The following are descriptions for each parameter:
 
-- `<HOST>`: The host of the TiDB cluster.
-- `<PORT>`: The port of the TiDB cluster.
 - `<USERNAME>`: The username to connect to the TiDB cluster.
 - `<PASSWORD>`: The password to connect to the TiDB cluster.
+- `<HOST>`: The host of the TiDB cluster.
+- `<PORT>`: The port of the TiDB cluster.
 - `<DATABASE>`: The name of the database you want to connect to.
 
 </div>

diff --git a/vector-search-integrate-with-langchain.md b/vector-search-integrate-with-langchain.md
@@ -17,7 +17,7 @@ This tutorial demonstrates how to integrate the [vector search](/vector-search-o
 
 > **Note:**
 >
-> The vector search feature is only available for TiDB Self-Managed clusters and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters.
+> 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.
 
 > **Tip**
 >
@@ -131,7 +131,6 @@ This document uses [OpenAI](https://platform.openai.com/docs/introduction) as th
 
 To configure the environment variables, run the following code. You will be prompted to enter your connection string and OpenAI API key:
 
-
 ```python
 # Use getpass to securely prompt for environment variables in your terminal.
 import getpass
@@ -150,14 +149,14 @@ TIDB_DATABASE_URL="mysql+pymysql://<USERNAME>:<PASSWORD>@<HOST>:<PORT>/<DATABASE
 # For example: TIDB_DATABASE_URL="mysql+pymysql://[email protected]:4000/test"
 ```
 
-You need to modify the values of the connection parameters according to your TiDB cluster. If you are running TiDB on your local machine, `HOST` is `127.0.0.1` by default. The initial `PASSWORD` is empty, so if you are starting the cluster for the first time, you can omit this field.
+You need to modify the values of the connection parameters according to your TiDB cluster. If you are running TiDB on your local machine, `<HOST>` is `127.0.0.1` by default. The initial `<PASSWORD>` is empty, so if you are starting the cluster for the first time, you can omit this field.
 
 The following are descriptions for each parameter:
 
-- `<HOST>`: The host of the TiDB cluster.
-- `<PORT>`: The port of the TiDB cluster.
 - `<USERNAME>`: The username to connect to the TiDB cluster.
 - `<PASSWORD>`: The password to connect to the TiDB cluster.
+- `<HOST>`: The host of the TiDB cluster.
+- `<PORT>`: The port of the TiDB cluster.
 - `<DATABASE>`: The name of the database you want to connect to.
 
 </div>

diff --git a/vector-search-integrate-with-llamaindex.md b/vector-search-integrate-with-llamaindex.md
@@ -17,7 +17,7 @@ This tutorial demonstrates how to integrate the [vector search](/vector-search-o
 
 > **Note:**
 >
-> The vector search feature is only available for TiDB Self-Managed clusters and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters.
+> 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.
 
 > **Tip**
 >
@@ -143,14 +143,14 @@ TIDB_DATABASE_URL="mysql+pymysql://<USERNAME>:<PASSWORD>@<HOST>:<PORT>/<DATABASE
 # For example: TIDB_DATABASE_URL="mysql+pymysql://[email protected]:4000/test"
 ```
 
-You need to modify the parameters in the connection string according to your TiDB cluster. If you are running TiDB on your local machine, `HOST` is `127.0.0.1` by default. The initial `PASSWORD` is empty, so if you are starting the cluster for the first time, you can omit this field.
+You need to modify the parameters in the connection string according to your TiDB cluster. If you are running TiDB on your local machine, `<HOST>` is `127.0.0.1` by default. The initial `<PASSWORD>` is empty, so if you are starting the cluster for the first time, you can omit this field.
 
 The following are descriptions for each parameter:
 
-- `<HOST>`: The host of the TiDB cluster.
-- `<PORT>`: The port of the TiDB cluster.
 - `<USERNAME>`: The username to connect to the TiDB cluster.
 - `<PASSWORD>`: The password to connect to the TiDB cluster.
+- `<HOST>`: The host of the TiDB cluster.
+- `<PORT>`: The port of the TiDB cluster.
 - `<DATABASE>`: The name of the database you want to connect to.
 
 </div>

diff --git a/vector-search-integrate-with-sqlalchemy.md b/vector-search-integrate-with-sqlalchemy.md
@@ -17,7 +17,7 @@ This tutorial walks you through how to use [SQLAlchemy](https://www.sqlalchemy.o
 
 > **Note:**
 >
-> The vector search feature is only available for TiDB Self-Managed clusters and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters.
+> 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.
 
 ## Prerequisites
 
@@ -130,7 +130,7 @@ TIDB_DATABASE_URL="mysql+pymysql://<USER>:<PASSWORD>@<HOST>:<PORT>/<DATABASE>"
 
 If you are running TiDB on your local machine, `<HOST>` is `127.0.0.1` by default. The initial `<PASSWORD>` is empty, so if you are starting the cluster for the first time, you can omit this field.
 
-The following are descriptions for each placeholder:
+The following are descriptions for each parameter:
 
 - `<USER>`: The username to connect to the TiDB cluster.
 - `<PASSWORD>`: The password to connect to the TiDB cluster.

diff --git a/vector-search-integration-overview.md b/vector-search-integration-overview.md
@@ -17,7 +17,7 @@ This document provides an overview of TiDB vector search integration, including
 
 > **Note:**
 >
-> The vector search feature is only available for TiDB Self-Managed clusters and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters.
+> 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.
 
 ## AI frameworks
 

diff --git a/vector-search-limitations.md b/vector-search-limitations.md
@@ -17,7 +17,7 @@ This document describes the known limitations of TiDB Vector Search.
 
 > **Note:**
 >
-> The vector search feature is only available for TiDB Self-Managed clusters and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters.
+> 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.
 
 - Each [vector](/vector-search-data-types.md) supports up to 16383 dimensions.
 - You cannot store `NaN`, `Infinity`, or `-Infinity` values in the vector data type.

diff --git a/vector-search-overview.md b/vector-search-overview.md
@@ -25,7 +25,7 @@ TiDB Vector Search provides an advanced search solution for performing semantic
 
 > **Note:**
 >
-> The vector search feature is only available for TiDB Self-Managed clusters and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters.
+> 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.
 
 ## Concepts