使用 Python 搭配 TiDB + AI 入门

本教程演示如何开发一个提供 semantic search 功能的简单 AI 应用。与传统的关键词搜索不同，语义搜索能够智能理解你的查询背后的含义，并返回最相关的结果。例如，如果你有标题为 "dog"、"fish" 和 "tree" 的文档，当你搜索 "一只会游泳的动物" 时，应用会识别出 "fish" 是最相关的结果。

在整个教程中，你将使用 TiDB Vector Search、Python、TiDB Vector SDK for Python 和 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：提供预训练模型，用于从文本生成 vector embeddings。

步骤 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. 初始化嵌入模型

embedding model 将数据转换为 vector embeddings。本示例使用预训练模型 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):
    """为给定文本生成向量嵌入。"""
    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

# 从 .env 文件加载连接字符串
load_dotenv()

vector_store = TiDBVectorClient(
   # `embedded_documents` 表将存储向量数据。
   table_name='embedded_documents',
   # 连接 TiDB 集群的连接字符串。
   connection_string=os.environ.get('TIDB_DATABASE_URL'),
   # 嵌入模型生成的向量维度。
   vector_dimension=embed_model_dims,
   # 如果表已存在，则重新创建。
   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. 执行语义搜索

在此步骤中，你将搜索 "一只会游泳的动物"，该词组与现有文档中的词没有直接匹配。

以下代码再次使用 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 = "一只会游泳的动物"
query_embedding = text_to_embedding(query)
search_result = vector_store.query(query_embedding, k=3)
print_result(query, search_result)

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

Search result ("一只会游泳的动物"):
- text: "fish", distance: 0.4562914811223072
- text: "dog", distance: 0.6469335836410557
- text: "tree", distance: 0.798545178640937

搜索结果中的三个词条按照它们与查询向量的距离排序：距离越小，相关性越高。

因此，根据输出，最可能的匹配对象是鱼，或者是擅长游泳的狗。

相关链接

• Vector Data Types
• Vector Search Index