Skip to content

Latest commit

 

History

History
254 lines (180 loc) · 7.53 KB

vector-search-integrate-with-peewee.md

File metadata and controls

254 lines (180 loc) · 7.53 KB
Raw
title summary
在 peewee 中使用 TiDB 向量搜索
了解如何在 peewee 中通过 TiDB 向量搜索功能存储向量并执行语义搜索。

在 peewee 中使用 TiDB 向量搜索

本文档将展示如何使用 peewee 与 TiDB 向量搜索进行交互，以及如何存储向量和执行向量搜索查询。

警告：

向量搜索目前为实验特性，不建议在生产环境中使用。该功能可能会在未事先通知的情况下发生变化。如果发现 bug，请在 GitHub 上提 issue 反馈。

前置需求

为了能够顺利完成本文中的操作，你需要提前：

  • 在你的机器上安装 Python 3.8 或更高版本
  • 在你的机器上安装 Git
  • 准备一个 TiDB 集群

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

运行示例应用程序

你可以通过以下步骤快速了解如何在 peewee 中使用 TiDB 向量搜索。

第 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，请在 Python 项目的根目录下新建一个 .env 文件，将以下内容复制到 .env 文件中，并根据集群的连接参数修改环境变量值为 TiDB 实际对应的值：

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

如果你在本机运行 TiDB，TIDB_HOST 默认为 127.0.0.1。TIDB_PASSWORD 初始密码为空，若你是第一次启动集群，则无需带上此字段。

以下为各参数的解释：

  • TIDB_HOST：TiDB 集群的主机号。
  • TIDB_PORT：TiDB 集群的端口号。
  • TIDB_USERNAME：连接 TiDB 集群的用户名。
  • TIDB_PASSWORD：连接 TiDB 集群的密码。
  • TIDB_DATABASE：要连接的数据库名称。

对于 TiDB Cloud Serverless 集群，请按照以下步骤获取集群的连接字符串，然后配置环境变量：

  1. 在 TiDB Cloud 的 Clusters 页面，单击你的 TiDB Cloud Serverless 集群名，进入集群的 Overview 页面。

  2. 点击右上角的 Connect 按钮，将会弹出连接对话框。

  3. 确认对话框中的配置和你的运行环境一致。

    • Connection Type 设置为 Public
    • Branch 设置为 main
    • Connect With 设置为 General
    • Operating System 与你的机器环境相匹配

    Tip:

    如果你的程序在 Windows Subsystem for Linux (WSL) 中运行，请切换为对应的 Linux 发行版。

  4. 从连接对话框中复制连接参数。

    Tip:

    如果你还没有设置密码，点击 Generate Password 生成一个随机密码。

  5. 在 Python 项目的根目录下新建一个 .env 文件，并将连接参数粘贴到相应的环境变量中。

    • TIDB_HOST：TiDB 集群的主机号。
    • TIDB_PORT：TiDB 集群的端口号。
    • TIDB_USERNAME：连接 TiDB 集群的用户名。
    • TIDB_PASSWORD：连接 TiDB 集群的密码。
    • TIDB_DATABASE：要连接的数据库名称。
    • TIDB_CA_PATH：根证书文件的路径。

    以下为 macOS 的示例：

    TIDB_HOST=gateway01.****.prod.aws.tidbcloud.com
TIDB_PORT=4000
TIDB_USERNAME=********.root
TIDB_PASSWORD=********
TIDB_DATABASE=test
TIDB_CA_PATH=/etc/ssl/cert.pem

第 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()

# Using `pymysql` as the driver.
connect_kwargs = {
    'ssl_verify_cert': True,
    'ssl_verify_identity': True,
}

# Using `mysqlclient` as the driver.
# connect_kwargs = {
#     'ssl_mode': 'VERIFY_IDENTITY',
#     'ssl': {
#         # Root certificate default path.
#         # If you are using a tidb serverless cluster, 
#         # you can refer to the following link to configure "TIDB_CA_PATH".
#         # 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,
)

定义向量列

创建一个表格，其中包含一个向量数据类型的 embedding 列，用于存储三维向量。

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

    content = TextField()
    embedding = VectorField(3)

存储包含向量的 document

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

搜索近邻向量

可以选择使用余弦距离 (CosineDistance) 函数，查询与向量 [1, 2, 3] 语义最接近的前 3 个 document。

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

搜索一定距离内的向量

可以选择使用余弦距离 (CosineDistance) 函数，查询与向量 [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)

另请参阅