大网数据广告活动
数据库部署与 SQL 参考

Auto Embedding 示例

· 52CE 我爱测

1. 使用 client 连接 TiDB。 2. 定义一个配置了 Auto Embedding 的 VectorField 的表。 3. 插入纯文本数据:嵌入向量会在后台自动填充。 4. 使用自然语言查询进行向量搜索:嵌入向量会透明地生成。

Auto Embedding 示例

本示例展示如何通过 Auto Embedding 功能,结合 pytidb client 使用 Auto Embedding。

  1. 使用 pytidb client 连接 TiDB。
  2. 定义一个配置了 Auto Embedding 的 VectorField 的表。
  3. 插入纯文本数据:嵌入向量会在后台自动填充。
  4. 使用自然语言查询进行向量搜索:嵌入向量会透明地生成。

前置条件

在开始之前,请确保你具备以下条件:

  • Python (>=3.10):安装 Python 3.10 或以上版本。
  • 一个 {{{ .starter }}} 实例:你可以在 TiDB Cloud 上创建一个免费的 {{{ .starter }}} 实例。

运行方法

步骤 1. 克隆 pytidb 仓库

git clone https://github.com/pingcap/pytidb.git
cd pytidb/examples/auto_embedding/

步骤 2. 安装所需依赖包

python -m venv .venv
source .venv/bin/activate
pip install -r reqs.txt

步骤 3. 设置环境变量

  1. 在 TiDB Cloud 控制台中,进入 My TiDB 页面,然后点击目标 {{{ .starter }}} 实例的名称,进入其概览页面。
  2. 点击右上角的 Connect。会弹出连接对话框,显示连接参数。
  3. 根据连接参数如下设置环境变量:
cat > .env <<EOF
TIDB_HOST={gateway-region}.prod.aws.tidbcloud.com
TIDB_PORT=4000
TIDB_USERNAME={prefix}.root
TIDB_PASSWORD={password}
TIDB_DATABASE=test

# 默认使用 TiDB Cloud 免费嵌入模型,无需设置任何 API key
EMBEDDING_PROVIDER=tidbcloud_free
EOF

步骤 4. 运行示例

python main.py

预期输出:

=== Define embedding function ===
Embedding function (model id: tidbcloud_free/amazon/titan-embed-text-v2) defined

=== Define table schema ===
Table created

=== Truncate table ===
Table truncated

=== Insert sample data ===
Inserted 3 chunks

=== Perform vector search ===
id: 1, text: TiDB is a distributed database that supports OLTP, OLAP, HTAP and AI workloads., distance: 0.30373281240458805
id: 2, text: PyTiDB is a Python library for developers to connect to TiDB., distance: 0.422506501973434
id: 3, text: LlamaIndex is a Python library for building AI-powered applications., distance: 0.5267239638442787

相关资源

本文来自 PingCAP / TiDB 文档贡献者,按 CC BY-SA 3.0 整理版式与相对链接,保留正文与代码。图示请参阅原文。作者与贡献记录。

资料来源与适用范围

资料来源
PingCAP / TiDB 文档贡献者
适用范围
master 文档快照(2026-11-16)
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-16
授权说明
CC BY-SA 3.0

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。