使用 Python 快速上手 TiDB + AI

本教程演示如何开发一个简单的 AI 应用，实现语义搜索功能。与传统的关键词搜索不同，语义搜索能够智能理解你的查询意图，并返回最相关的结果。例如，如果你有标题为 "dog"、"fish" 和 "tree" 的文档，当你搜索 "a swimming animal" 时，应用会识别出 "fish" 是最相关的结果。

在本教程中，你将使用 TiDB Vector Search、Python、TiDB Vector SDK for Python 以及 AI 模型来开发该 AI 应用。

前置条件

完成本教程，你需要：

• 已安装 Python 3.8 或更高版本。
• 已安装 Git。
• 一个 TiDB 集群。

如果你还没有 TiDB 集群，可以按如下方式创建：

• （推荐）参考 创建 TiDB Cloud Starter 集群 创建属于你自己的 TiDB Cloud 集群。
• 参考 部署本地测试 TiDB 集群 或 部署生产环境 TiDB 集群 创建 v8.4.0 或更高版本的本地集群。

快速上手

以下步骤展示了如何从零开发该应用。如果你想直接运行示例代码，可以参考 pingcap/tidb-vector-python 仓库中的示例代码。

步骤 1. 创建新的 Python 项目

在你喜欢的目录下，创建一个新的 Python 项目，并新建一个名为 example.py 的文件：

mkdir python-client-quickstart
cd python-client-quickstart
touch example.py

步骤 2. 安装所需依赖

在你的项目目录下，运行以下命令安装所需的依赖包：

pip install sqlalchemy pymysql sentence-transformers tidb-vector python-dotenv

• tidb-vector：用于与 TiDB 向量检索交互的 Python 客户端。
• sentence-transformers：一个 Python 库，提供用于从文本生成向量嵌入的预训练模型。

步骤 3. 配置 TiDB 集群连接字符串

根据你选择的 TiDB 部署方式，配置集群连接字符串。

TIDB_DATABASE_URL="mysql+pymysql://<USER>:<PASSWORD>@<HOST>:<PORT>/<DATABASE>"
# 例如：TIDB_DATABASE_URL="mysql+pymysql://root@127.0.0.1:4000/test"

步骤 4. 初始化嵌入模型

嵌入模型用于将数据转换为向量嵌入。本示例使用预训练模型 msmarco-MiniLM-L12-cos-v5 进行文本嵌入。该轻量级模型由 sentence-transformers 库提供，可将文本数据转换为 384 维的向量嵌入。

要设置模型，将以下代码复制到 example.py 文件中。该代码初始化了一个 SentenceTransformer 实例，并定义了后续使用的 text_to_embedding() 函数。

from sentence_transformers import SentenceTransformer

print("Downloading and loading the embedding model...")
embed_model = SentenceTransformer("sentence-transformers/msmarco-MiniLM-L12-cos-v5", trust_remote_code=True)
embed_model_dims = embed_model.get_sentence_embedding_dimension()

def text_to_embedding(text):
    """Generates vector embeddings for the given text."""
    embedding = embed_model.encode(text)
    return embedding.tolist()

步骤 5. 连接 TiDB 集群

使用 TiDBVectorClient 类连接你的 TiDB 集群，并创建一个包含向量列的 embedded_documents 表。

import os
from tidb_vector.integrations import TiDBVectorClient
from dotenv import load_dotenv

# Load the connection string from the .env file
load_dotenv()

vector_store = TiDBVectorClient(
   # The 'embedded_documents' table will store the vector data.
   table_name='embedded_documents',
   # The connection string to the TiDB cluster.
   connection_string=os.environ.get('TIDB_DATABASE_URL'),
   # The dimension of the vector generated by the embedding model.
   vector_dimension=embed_model_dims,
   # Recreate the table if it already exists.
   drop_existing_table=True,
)

步骤 6. 嵌入文本数据并存储向量

在此步骤中，你将准备包含单词的示例文档，如 "dog"、"fish" 和 "tree"。以下代码使用 text_to_embedding() 函数将这些文本文档转换为向量嵌入，并插入到向量存储中。

documents = [
    {
        "id": "f8e7dee2-63b6-42f1-8b60-2d46710c1971",
        "text": "dog",
        "embedding": text_to_embedding("dog"),
        "metadata": {"category": "animal"},
    },
    {
        "id": "8dde1fbc-2522-4ca2-aedf-5dcb2966d1c6",
        "text": "fish",
        "embedding": text_to_embedding("fish"),
        "metadata": {"category": "animal"},
    },
    {
        "id": "e4991349-d00b-485c-a481-f61695f2b5ae",
        "text": "tree",
        "embedding": text_to_embedding("tree"),
        "metadata": {"category": "plant"},
    },
]

vector_store.insert(
    ids=[doc["id"] for doc in documents],
    texts=[doc["text"] for doc in documents],
    embeddings=[doc["embedding"] for doc in documents],
    metadatas=[doc["metadata"] for doc in documents],
)

步骤 7. 执行语义搜索

在此步骤中，你将搜索 "a swimming animal"，该查询与现有文档中的单词并不直接匹配。

以下代码再次使用 text_to_embedding() 函数将查询文本转换为向量嵌入，并用该嵌入向量查询，返回最接近的前三个结果。

def print_result(query, result):
   print(f"Search result (\"{query}\"):")
   for r in result:
      print(f"- text: \"{r.document}\", distance: {r.distance}")

query = "a swimming animal"
query_embedding = text_to_embedding(query)
search_result = vector_store.query(query_embedding, k=3)
print_result(query, search_result)

运行 example.py 文件，输出如下：

Search result ("a swimming animal"):
- text: "fish", distance: 0.4562914811223072
- text: "dog", distance: 0.6469335836410557
- text: "tree", distance: 0.798545178640937

搜索结果中的三个词根据与查询向量的距离排序：距离越小，document 越相关。

因此，根据输出，最有可能的游泳动物是 fish，或者是一只擅长游泳的 dog。

相关阅读

• 向量数据类型
• 向量检索索引