将 TiDB Vector Search 与 peewee 集成

本教程将引导你如何使用 peewee 与 TiDB Vector Search 交互，存储嵌入向量，并执行向量搜索查询。

前提条件

完成本教程，你需要：

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

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

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

运行示例应用

你可以通过以下步骤快速了解如何将 TiDB Vector Search 与 peewee 集成。

第 1 步：克隆仓库

将 tidb-vector-python 仓库克隆到你的本地机器：

git clone https://github.com/pingcap/tidb-vector-python.git

第 2 步：创建虚拟环境

为你的项目创建虚拟环境：

cd tidb-vector-python/examples/orm-peewee-quickstart
python3 -m venv .venv
source .venv/bin/activate

第 3 步：安装依赖

安装示例项目所需的依赖：

pip install -r requirements.txt

或者，你也可以单独安装以下包：

pip install peewee pymysql python-dotenv tidb-vector

第 4 步：配置环境变量

根据你选择的 TiDB 部署方式，配置环境变量。

TIDB_HOST=127.0.0.1
TIDB_PORT=4000
TIDB_USERNAME=root
TIDB_PASSWORD=
TIDB_DATABASE=test

第 5 步：运行示例

python peewee-quickstart.py

示例输出：

Get 3-nearest neighbor documents:
  - distance: 0.00853986601633272
    document: fish
  - distance: 0.12712843905603044
    document: dog
  - distance: 0.7327387580875756
    document: tree
Get documents within a certain distance:
  - distance: 0.00853986601633272
    document: fish
  - distance: 0.12712843905603044
    document: dog

示例代码片段

你可以参考以下示例代码片段，开发你的应用。

创建向量表

连接到 TiDB 集群

import os
import dotenv

from peewee import Model, MySQLDatabase, SQL, TextField
from tidb_vector.peewee import VectorField

dotenv.load_dotenv()

# 使用 `pymysql` 作为驱动
connect_kwargs = {
    'ssl_verify_cert': True,
    'ssl_verify_identity': True,
}

# 使用 `mysqlclient` 作为驱动
# connect_kwargs = {
#     'ssl_mode': 'VERIFY_IDENTITY',
#     'ssl': {
#         # 根证书默认路径
#         # https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-clusters/#root-certificate-default-path
#         'ca': os.environ.get('TIDB_CA_PATH', '/path/to/ca.pem'),
#     },
# }

db = MySQLDatabase(
    database=os.environ.get('TIDB_DATABASE', 'test'),
    user=os.environ.get('TIDB_USERNAME', 'root'),
    password=os.environ.get('TIDB_PASSWORD', ''),
    host=os.environ.get('TIDB_HOST', 'localhost'),
    port=int(os.environ.get('TIDB_PORT', '4000')),
    **connect_kwargs,
)

定义向量列

创建一个名为 peewee_demo_documents 的表，包含存储 3 维向量的列。

class Document(Model):
    class Meta:
        database = db
        table_name = 'peewee_demo_documents'

    content = TextField()
    embedding = VectorField(3)

存储带有嵌入向量的文档

Document.create(content='dog', embedding=[1, 2, 1])
Document.create(content='fish', embedding=[1, 2, 4])
Document.create(content='tree', embedding=[1, 0, 0])

搜索语义最接近的邻居文档

根据余弦距离函数，搜索与查询向量 [1, 2, 3] 语义最接近的前 3 个文档。

distance = Document.embedding.cosine_distance([1, 2, 3]).alias('distance')
results = Document.select(Document, distance).order_by(distance).limit(3)

搜索距离在一定范围内的文档

搜索与查询向量 [1, 2, 3] 的余弦距离小于 0.2 的文档。

distance_expression = Document.embedding.cosine_distance([1, 2, 3])
distance = distance_expression.alias('distance')
results = Document.select(Document, distance).where(distance_expression < 0.2).order_by(distance).limit(3)

相关链接

• Vector Data Types
• Vector Search Index