Skip to content

Commit 90b3b37

Browse files
authored
*: add a vector-search directory and update links (#19893)
1 parent 3127a0a commit 90b3b37

25 files changed

+108
-108
lines changed

Diff for: TOC-tidb-cloud.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
- [Roadmap](/tidb-cloud/tidb-cloud-roadmap.md)
1111
- Get Started
1212
- [Try Out TiDB Cloud](/tidb-cloud/tidb-cloud-quickstart.md)
13-
- [Try Out TiDB + AI](/vector-search-get-started-using-python.md)
13+
- [Try Out TiDB + AI](/vector-search/vector-search-get-started-using-python.md)
1414
- [Try Out HTAP](/tidb-cloud/tidb-cloud-htap-quickstart.md)
1515
- [Try Out TiDB Cloud CLI](/tidb-cloud/get-started-with-cli.md)
1616
- [Perform a PoC](/tidb-cloud/tidb-cloud-poc.md)
@@ -241,27 +241,27 @@
241241
- Explore Data
242242
- [Chat2Query (Beta) in SQL Editor](/tidb-cloud/explore-data-with-chat2query.md)
243243
- Vector Search (Beta)
244-
- [Overview](/vector-search-overview.md)
244+
- [Overview](/vector-search/vector-search-overview.md)
245245
- Get Started
246-
- [Get Started with SQL](/vector-search-get-started-using-sql.md)
247-
- [Get Started with Python](/vector-search-get-started-using-python.md)
246+
- [Get Started with SQL](/vector-search/vector-search-get-started-using-sql.md)
247+
- [Get Started with Python](/vector-search/vector-search-get-started-using-python.md)
248248
- Integrations
249-
- [Overview](/vector-search-integration-overview.md)
249+
- [Overview](/vector-search/vector-search-integration-overview.md)
250250
- AI Frameworks
251-
- [LlamaIndex](/vector-search-integrate-with-llamaindex.md)
252-
- [Langchain](/vector-search-integrate-with-langchain.md)
251+
- [LlamaIndex](/vector-search/vector-search-integrate-with-llamaindex.md)
252+
- [Langchain](/vector-search/vector-search-integrate-with-langchain.md)
253253
- Embedding Models/Services
254-
- [Jina AI](/vector-search-integrate-with-jinaai-embedding.md)
254+
- [Jina AI](/vector-search/vector-search-integrate-with-jinaai-embedding.md)
255255
- ORM Libraries
256-
- [SQLAlchemy](/vector-search-integrate-with-sqlalchemy.md)
257-
- [peewee](/vector-search-integrate-with-peewee.md)
258-
- [Django ORM](/vector-search-integrate-with-django-orm.md)
256+
- [SQLAlchemy](/vector-search/vector-search-integrate-with-sqlalchemy.md)
257+
- [peewee](/vector-search/vector-search-integrate-with-peewee.md)
258+
- [Django ORM](/vector-search/vector-search-integrate-with-django-orm.md)
259259
- Reference
260-
- [Vector Data Types](/vector-search-data-types.md)
261-
- [Vector Functions and Operators](/vector-search-functions-and-operators.md)
262-
- [Vector Index](/vector-search-index.md)
263-
- [Improve Performance](/vector-search-improve-performance.md)
264-
- [Limitations](/vector-search-limitations.md)
260+
- [Vector Data Types](/vector-search/vector-search-data-types.md)
261+
- [Vector Functions and Operators](/vector-search/vector-search-functions-and-operators.md)
262+
- [Vector Index](/vector-search/vector-search-index.md)
263+
- [Improve Performance](/vector-search/vector-search-improve-performance.md)
264+
- [Limitations](/vector-search/vector-search-limitations.md)
265265
- [Changelogs](/tidb-cloud/vector-search-changelogs.md)
266266
- Data Service (Beta)
267267
- [Overview](/tidb-cloud/data-service-overview.md)

Diff for: TOC.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -82,23 +82,23 @@
8282
- [Stale Read](/develop/dev-guide-use-stale-read.md)
8383
- [HTAP Queries](/develop/dev-guide-hybrid-oltp-and-olap-queries.md)
8484
- Vector Search
85-
- [Overview](/vector-search-overview.md)
85+
- [Overview](/vector-search/vector-search-overview.md)
8686
- Get Started
87-
- [Get Started with SQL](/vector-search-get-started-using-sql.md)
88-
- [Get Started with Python](/vector-search-get-started-using-python.md)
87+
- [Get Started with SQL](/vector-search/vector-search-get-started-using-sql.md)
88+
- [Get Started with Python](/vector-search/vector-search-get-started-using-python.md)
8989
- Integrations
90-
- [Overview](/vector-search-integration-overview.md)
90+
- [Overview](/vector-search/vector-search-integration-overview.md)
9191
- AI Frameworks
92-
- [LlamaIndex](/vector-search-integrate-with-llamaindex.md)
93-
- [Langchain](/vector-search-integrate-with-langchain.md)
92+
- [LlamaIndex](/vector-search/vector-search-integrate-with-llamaindex.md)
93+
- [Langchain](/vector-search/vector-search-integrate-with-langchain.md)
9494
- Embedding Models/Services
95-
- [Jina AI](/vector-search-integrate-with-jinaai-embedding.md)
95+
- [Jina AI](/vector-search/vector-search-integrate-with-jinaai-embedding.md)
9696
- ORM Libraries
97-
- [SQLAlchemy](/vector-search-integrate-with-sqlalchemy.md)
98-
- [peewee](/vector-search-integrate-with-peewee.md)
99-
- [Django](/vector-search-integrate-with-django-orm.md)
100-
- [Improve Performance](/vector-search-improve-performance.md)
101-
- [Limitations](/vector-search-limitations.md)
97+
- [SQLAlchemy](/vector-search/vector-search-integrate-with-sqlalchemy.md)
98+
- [peewee](/vector-search/vector-search-integrate-with-peewee.md)
99+
- [Django](/vector-search/vector-search-integrate-with-django-orm.md)
100+
- [Improve Performance](/vector-search/vector-search-improve-performance.md)
101+
- [Limitations](/vector-search/vector-search-limitations.md)
102102
- Transaction
103103
- [Overview](/develop/dev-guide-transaction-overview.md)
104104
- [Optimistic and Pessimistic Transactions](/develop/dev-guide-optimistic-and-pessimistic-transaction.md)
@@ -891,7 +891,7 @@
891891
- [Date and Time Types](/data-type-date-and-time.md)
892892
- [String Types](/data-type-string.md)
893893
- [JSON Type](/data-type-json.md)
894-
- [Vector Types](/vector-search-data-types.md)
894+
- [Vector Types](/vector-search/vector-search-data-types.md)
895895
- Functions and Operators
896896
- [Overview](/functions-and-operators/functions-and-operators-overview.md)
897897
- [Type Conversion in Expression Evaluation](/functions-and-operators/type-conversion-in-expression-evaluation.md)
@@ -905,7 +905,7 @@
905905
- [Encryption and Compression Functions](/functions-and-operators/encryption-and-compression-functions.md)
906906
- [Locking Functions](/functions-and-operators/locking-functions.md)
907907
- [Information Functions](/functions-and-operators/information-functions.md)
908-
- [Vector Functions and Operators](/vector-search-functions-and-operators.md)
908+
- [Vector Functions and Operators](/vector-search/vector-search-functions-and-operators.md)
909909
- JSON Functions
910910
- [Overview](/functions-and-operators/json-functions.md)
911911
- [Functions That Create JSON](/functions-and-operators/json-functions/json-functions-create.md)
@@ -926,7 +926,7 @@
926926
- [TiDB Specific Functions](/functions-and-operators/tidb-functions.md)
927927
- [Comparisons between Functions and Syntax of Oracle and TiDB](/oracle-functions-to-tidb.md)
928928
- [Clustered Indexes](/clustered-indexes.md)
929-
- [Vector Index](/vector-search-index.md)
929+
- [Vector Index](/vector-search/vector-search-index.md)
930930
- [Constraints](/constraints.md)
931931
- [Generated Columns](/generated-columns.md)
932932
- [SQL Mode](/sql-mode.md)

Diff for: basic-features.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ You can try out TiDB features on [TiDB Playground](https://play.tidbcloud.com/?u
2828
| [Date and time types](/data-type-date-and-time.md) | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y |
2929
| [String types](/data-type-string.md) | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y |
3030
| [JSON type](/data-type-json.md) | Y | Y | Y | Y | Y | E | E | E | E | E |
31-
| [Vectort types](/vector-search-data-types.md) | E | N | N | N | N | N | N | N | N | N |
31+
| [Vectort types](/vector-search/vector-search-data-types.md) | E | N | N | N | N | N | N | N | N | N |
3232
| [Control flow functions](/functions-and-operators/control-flow-functions.md) | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y |
3333
| [String functions](/functions-and-operators/string-functions.md) | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y |
3434
| [Numeric functions and operators](/functions-and-operators/numeric-functions-and-operators.md) | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y |
3535
| [Date and time functions](/functions-and-operators/date-and-time-functions.md) | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y |
3636
| [Bit functions and operators](/functions-and-operators/bit-functions-and-operators.md) | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y |
3737
| [Cast functions and operators](/functions-and-operators/cast-functions-and-operators.md) | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y |
3838
| [Encryption and compression functions](/functions-and-operators/encryption-and-compression-functions.md) | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y |
39-
| [Vector functions and operators](/vector-search-functions-and-operators.md) | E | N | N | N | N | N | N | N | N | N |
39+
| [Vector functions and operators](/vector-search/vector-search-functions-and-operators.md) | E | N | N | N | N | N | N | N | N | N |
4040
| [Information functions](/functions-and-operators/information-functions.md) | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y |
4141
| [JSON functions](/functions-and-operators/json-functions.md) | Y | Y | Y | Y | Y | E | E | E | E | E |
4242
| [Aggregation functions](/functions-and-operators/aggregate-group-by-functions.md) | Y | Y | Y | Y | Y | Y | Y | Y | Y | Y |
@@ -67,7 +67,7 @@ You can try out TiDB features on [TiDB Playground](https://play.tidbcloud.com/?u
6767
| [Foreign key](/foreign-key.md) | Y | E | E | E | N | N | N | N | N | N |
6868
| [TiFlash late materialization](/tiflash/tiflash-late-materialization.md) | Y | Y | Y | Y | N | N | N | N | N | N |
6969
| [Global index](/partitioned-table.md#global-indexes) | Y | N | N | N | N | N | N | N | N | N |
70-
| [Vector index](/vector-search-index.md) | E | N | N | N | N | N | N | N | N | N |
70+
| [Vector index](/vector-search/vector-search-index.md) | E | N | N | N | N | N | N | N | N | N |
7171

7272
## SQL statements
7373

@@ -98,7 +98,7 @@ You can try out TiDB features on [TiDB Playground](https://play.tidbcloud.com/?u
9898

9999
| Advanced SQL features | 8.5 | 8.1 | 7.5 | 7.1 | 6.5 | 6.1 | 5.4 | 5.3 | 5.2 | 5.1 |
100100
|---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
101-
| [Vector search](/vector-search-overview.md) | E | N | N | N | N | N | N | N | N | N |
101+
| [Vector search](/vector-search/vector-search-overview.md) | E | N | N | N | N | N | N | N | N | N |
102102
| [Prepared statement cache](/sql-prepared-plan-cache.md) | Y | Y | Y | Y | Y | Y | Y | Y | E | E |
103103
| [Non-prepared statement cache](/sql-non-prepared-plan-cache.md) | Y | Y | Y | E | N | N | N | N | N | N |
104104
| [Instance-level execution plan cache](/system-variables.md#tidb_enable_instance_plan_cache-new-in-v840) | E | N | N | N | N | N | N | N | N | N |

Diff for: br/backup-and-restore-overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Backup and restore might go wrong when some TiDB features are enabled or disable
118118
| Global temporary tables | | Make sure that you are using v5.3.0 or a later version of BR to back up and restore data. Otherwise, an error occurs in the definition of the backed global temporary tables. |
119119
| TiDB Lightning Physical Import| | If the upstream database uses the physical import mode of TiDB Lightning, data cannot be backed up in log backup. It is recommended to perform a full backup after the data import. For more information, see [When the upstream database imports data using TiDB Lightning in the physical import mode, the log backup feature becomes unavailable. Why?](/faq/backup-and-restore-faq.md#when-the-upstream-database-imports-data-using-tidb-lightning-in-the-physical-import-mode-the-log-backup-feature-becomes-unavailable-why).|
120120
| TiCDC | | BR v8.2.0 and later: if the target cluster to be restored has a changefeed and the changefeed [CheckpointTS](/ticdc/ticdc-architecture.md#checkpointts) is earlier than the BackupTS, BR does not perform the restoration. BR versions before v8.2.0: if the target cluster to be restored has any active TiCDC changefeeds, BR does not perform the restoration. |
121-
| Vector search | | Make sure that you are using v8.4.0 or a later version of BR to back up and restore data. Restoring tables with [vector data types](/vector-search-data-types.md) to TiDB clusters earlier than v8.4.0 is not supported. |
121+
| Vector search | | Make sure that you are using v8.4.0 or a later version of BR to back up and restore data. Restoring tables with [vector data types](/vector-search/vector-search-data-types.md) to TiDB clusters earlier than v8.4.0 is not supported. |
122122

123123
### Version compatibility
124124

Diff for: releases/release-8.4.0.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -200,13 +200,13 @@ Quick access: [Quick start](https://docs.pingcap.com/tidb/v8.4/quick-start-with-
200200

201201
Vector search is a search method based on data semantics, which provides more relevant search results. As one of the core functions of AI and large language models (LLMs), vector search can be used in various scenarios such as Retrieval-Augmented Generation (RAG), semantic search, and recommendation systems.
202202

203-
Starting from v8.4.0, TiDB supports [vector data types](/vector-search-data-types.md) and [vector search indexes](/vector-search-index.md), offering powerful vector search capabilities. TiDB vector data types support up to 16,383 dimensions and support various [distance functions](/vector-search-functions-and-operators.md#vector-functions), including L2 distance (Euclidean distance), cosine distance, negative inner product, and L1 distance (Manhattan distance).
203+
Starting from v8.4.0, TiDB supports [vector data types](/vector-search/vector-search-data-types.md) and [vector search indexes](/vector-search/vector-search-index.md), offering powerful vector search capabilities. TiDB vector data types support up to 16,383 dimensions and support various [distance functions](/vector-search/vector-search-functions-and-operators.md#vector-functions), including L2 distance (Euclidean distance), cosine distance, negative inner product, and L1 distance (Manhattan distance).
204204

205205
To start vector search, you only need to create a table with vector data types, insert vector data, and then perform a query of vector data. You can also perform mixed queries of vector data and traditional relational data.
206206

207-
To enhance the performance of vector search, you can create and use [vector search indexes](/vector-search-index.md). Note that TiDB vector search indexes rely on TiFlash. Before using vector search indexes, make sure that TiFlash nodes are deployed in your TiDB cluster.
207+
To enhance the performance of vector search, you can create and use [vector search indexes](/vector-search/vector-search-index.md). Note that TiDB vector search indexes rely on TiFlash. Before using vector search indexes, make sure that TiFlash nodes are deployed in your TiDB cluster.
208208

209-
For more information, see [documentation](/vector-search-overview.md).
209+
For more information, see [documentation](/vector-search/vector-search-overview.md).
210210

211211
### DB operations
212212

Diff for: ticdc/ticdc-compatibility.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ If the upstream cluster contains a global temporary table, the downstream TiDB c
7878

7979
### Compatibility with vector data types
8080

81-
Starting from v8.4.0, TiCDC supports replicating tables with [vector data types](/vector-search-data-types.md) to downstream (experimental).
81+
Starting from v8.4.0, TiCDC supports replicating tables with [vector data types](/vector-search/vector-search-data-types.md) to downstream (experimental).
8282

8383
When the downstream is Kafka or a storage service (such as Amazon S3, GCS, Azure Blob Storage, or NFS), TiCDC converts vector data types into string types before writing to the downstream.
8484

Diff for: tidb-cloud/data-service-manage-endpoint.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ In TiDB Cloud Data Service, you can generate one or multiple endpoints automatic
4444

4545
For each operation you select, TiDB Cloud Data Service will generate a corresponding endpoint. If you select a batch operation (such as `POST (Batch Create)`), the generated endpoint lets you operate on multiple rows in a single request.
4646

47-
If the table you selected contains [vector data types](/vector-search-data-types.md), you can enable the **Vector Search Operations** option and select a vector distance function to generate a vector search endpoint that automatically calculates vector distances based on your selected distance function. The supported [vector distance functions](/vector-search-functions-and-operators.md) include the following:
47+
If the table you selected contains [vector data types](/vector-search/vector-search-data-types.md), you can enable the **Vector Search Operations** option and select a vector distance function to generate a vector search endpoint that automatically calculates vector distances based on your selected distance function. The supported [vector distance functions](/vector-search/vector-search-functions-and-operators.md) include the following:
4848

4949
- `VEC_L2_DISTANCE` (default): calculates the L2 distance (Euclidean distance) between two vectors.
5050
- `VEC_COSINE_DISTANCE`: calculates the cosine distance between two vectors.

Diff for: tidb-cloud/tidb-cloud-release-notes.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c
7676

7777
- [Data Service (beta)](https://tidbcloud.com/console/data-service) supports automatically generating vector search endpoints.
7878

79-
If your table contains [vector data types](/vector-search-data-types.md), you can automatically generate a vector search endpoint that calculates vector distances based on your selected distance function.
79+
If your table contains [vector data types](/vector-search/vector-search-data-types.md), you can automatically generate a vector search endpoint that calculates vector distances based on your selected distance function.
8080

8181
This feature enables seamless integration with AI platforms such as [Dify](https://docs.dify.ai/guides/tools) and [GPTs](https://openai.com/blog/introducing-gpts), enhancing your applications with advanced natural language processing and AI capabilities for more complex tasks and intelligent solutions.
8282

@@ -122,12 +122,12 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c
122122

123123
The vector search (beta) feature provides an advanced search solution for performing semantic similarity searches across various data types, including documents, images, audio, and video. This feature enables developers to easily build scalable applications with generative artificial intelligence (AI) capabilities using familiar MySQL skills. Key features include:
124124

125-
- [Vector data types](/vector-search-data-types.md), [vector index](/vector-search-index.md), and [vector functions and operators](/vector-search-functions-and-operators.md).
126-
- Ecosystem integrations with [LangChain](/vector-search-integrate-with-langchain.md), [LlamaIndex](/vector-search-integrate-with-llamaindex.md), and [JinaAI](/vector-search-integrate-with-jinaai-embedding.md).
127-
- Programming language support for Python: [SQLAlchemy](/vector-search-integrate-with-sqlalchemy.md), [Peewee](/vector-search-integrate-with-peewee.md), and [Django ORM](/vector-search-integrate-with-django-orm.md).
128-
- Sample applications and tutorials: perform semantic searches for documents using [Python](/vector-search-get-started-using-python.md) or [SQL](/vector-search-get-started-using-sql.md).
125+
- [Vector data types](/vector-search/vector-search-data-types.md), [vector index](/vector-search/vector-search-index.md), and [vector functions and operators](/vector-search/vector-search-functions-and-operators.md).
126+
- Ecosystem integrations with [LangChain](/vector-search/vector-search-integrate-with-langchain.md), [LlamaIndex](/vector-search/vector-search-integrate-with-llamaindex.md), and [JinaAI](/vector-search/vector-search-integrate-with-jinaai-embedding.md).
127+
- Programming language support for Python: [SQLAlchemy](/vector-search/vector-search-integrate-with-sqlalchemy.md), [Peewee](/vector-search/vector-search-integrate-with-peewee.md), and [Django ORM](/vector-search/vector-search-integrate-with-django-orm.md).
128+
- Sample applications and tutorials: perform semantic searches for documents using [Python](/vector-search/vector-search-get-started-using-python.md) or [SQL](/vector-search/vector-search-get-started-using-sql.md).
129129

130-
For more information, see [Vector search (beta) overview](/vector-search-overview.md).
130+
For more information, see [Vector search (beta) overview](/vector-search/vector-search-overview.md).
131131

132132
- [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) now offers weekly email reports for organization owners.
133133

0 commit comments

Comments
 (0)