腾讯云向量数据库(Tencent Cloud VectorDB)通过 HTTP 协议进行数据写入和查询等操作。您可以将不同类型的请求消息以 JSON 格式放入 HTTP 请求消息 Body 中,将请求发送到 VectorDB 的 HTTP API 地址即可。VectorDB 将自动解析请求消息 Body 中的 JSON 数据,并将其存储到数据库中。
说明:
准备工作
使用腾讯云向量数据库(Tencent Cloud VectorDB)HTTP API 接口进行数据库操作之前,请您优先做如下准备。
已新建数据库实例,且状态为运行中。
申请与腾讯云向量数据库在同一地域同一个 VPC 内的 Linux 云服务器 CVM。
说明:
在腾讯云 CVM 安全组中配置出站规则,需要把腾讯云向量数据库的 IP 及端口添加到出站规则中。在腾讯云向量数据库安全组中配置入站规则,把 CVM 的 IP 及端口添加到入站规则中。 操作详情,可参见 安全组。
API 列表
腾讯云向量数据库(Tencent Cloud VectorDB)的 HTTP 请求要素包含请求方法(GET、POST)、鉴权方式、数据库服务的 URI 地址以及消息体。其中,鉴权方式通过账号和 API 密钥(HTTP 参数格式为 account=root&api_key=xxx)进行校验。如下列出目前所支持的每个 API 接口,包含的接口含义、请求方式与 URL 拼接地址。
接口层级 | 接口名 | 接口含义 | 请求方式 | URL 拼接地址 |
Database | 创建 Base类数据库 | POST | http://{实例内网 IP 地址}:{实例网络端口}/database/create | |
| 创建 AI 类数据库 | POST | http://{实例内网 IP 地址}:{实例网络端口}/ai/database/create | |
| 删除 Base 类数据库 | POST | http://{实例内网 IP 地址}:{实例网络端口}/database/drop | |
| 删除 AI 类数据库所有集合视图数据 | POST | http://{实例内网 IP 地址}:{实例网络端口}/ai/database/drop | |
| 查询所有数据库 | GET | http://{实例内网 IP 地址}:{实例网络端口}/database/list | |
Collection | 创建集合 | POST | http://{实例内网 IP 地址}:{实例网络端口}/collection/create | |
| 删除集合 | POST | http://{实例内网 IP 地址}:{实例网络端口}/collection/drop | |
| 查询集合 | POST | http://{实例内网 IP 地址}:{实例网络端口}/collection/list | |
| 查询指定集合 | POST | http://{实例内网 IP 地址}:{实例网络端口}/collection/describe | |
| 清空集合别名 | POST | http://{实例内网 IP 地址}:{实例网络端口}/collection/truncate | |
CollectionView | 创建集合视图 | POST | http://{实例内网 IP 地址}:{实例网络端口}/ai/collectionView/create | |
| 删除集合视图 | POST | http://{实例内网 IP 地址}:{实例网络端口}/ai/collectionView/drop | |
| 展示指定 AI Database 下的所有集合视图列表 | POST | http://{实例内网 IP 地址}:{实例网络端口}/ai/collectionView/list | |
| 返回指定集合的详细信息 | POST | http://{实例内网 IP 地址}:{实例网络端口}/ai/collectionView/describe | |
| 清空集合视图数据 | | http://{实例内网 IP 地址}:{实例网络端口}/ai/collectionView/truncate | |
Alias | 给 Collection 创建别名 | POST | http://{实例内网 IP 地址}:{实例网络端口}/alias/set | |
| 给 CollectionView 创建别名 | POST | http://{实例内网 IP 地址}:{实例网络端口}/ai/alias/set | |
| 删除 Collection 别名 | POST | http://{实例内网 IP 地址}:{实例网络端口}/alias/delete | |
| 删除 CollectionView 别名 | POST | http://{实例内网 IP 地址}:{实例网络端口}/ai/alias/delete | |
Document | 插入数据 | POST | http://{实例内网 IP 地址}:{实例网络口}/document/upsert | |
| 精确查找数据 | POST | http://{实例内网IP地址}:{实例网络端口}/document/query | |
| 检索相似向量 | POST | http://{实例内网 IP 地址}:{实例网络口}/document/search | |
| 删除数据 | POST | http://{实例内网 IP 地址}:{实例网络口}/document/delete | |
| 更新数据 | POST | http://{实例内网 IP 地址}:{实例网络口}/ai/documentSet/update | |
DocumentSet | 获取文件上传路径与授权签名 | POST | http://{实例内网 IP 地址}:{实例网络口}/ai/documentSet/uploadUrl | |
| 获取文件信息 | POST | http://{实例内网 IP 地址}:{实例网络口}/ai/documentSet/get | |
| 精确查询 | POST | http://{实例内网 IP 地址}:{实例网络口}/ai/documentSet/query | |
| 相似度检索 | POST | http://{实例内网 IP 地址}:{实例网络口}/ai/documentSet/search | |
| 删除文档 | POST | http://{实例内网 IP 地址}:{实例网络口}/ai/documentSet/delete | |
| 更新文档 | POST | http://{实例内网 IP 地址}:{实例网络端口}/ai/documentSet/update | |
Index | 重建索引 | POST | http://{实例内网 IP 地址}:{实例网络端口}/index/rebuild |