新建 Client

最近更新时间:2024-07-04 10:29:01

我的收藏

功能介绍

RPCVectorDBClient() 用于通过 RPC(Remote Procedure Call,远程过程调用)的请求方式创建一个向量数据库的客户端对象,用于与向量数据库服务器连接并进行数据交互。
VectorDBClient() 为了兼容旧版本而保留,用于通过 HTTP I/O 请求方式创建一个向量数据库的客户端对象,与向量数据库服务器连接并进行数据交互。
说明:
Python SDK 为 1.3.3 及以上版本支持 RPC(Remote Procedure Call,远程过程调用)通信,在多线程场景,RPC 可以提供比 HTTP I/O 更好的的并发请求能力。同时,为了确保兼容性和性能,Python SDK 需要在 Python 3.8或更高版本的环境下运行。

SDK 准备

SDK 下载以及安装方式,请参见 SDK 准备

请求接口

RPC 请求(推荐)
HTTP IO 请求(兼容 Restful 旧版本)
import tcvectordb
from tcvectordb.model.enum import FieldType, IndexType, MetricType, ReadConsistency

client = tcvectordb.RPCVectorDBClient( url='http://10.0.X.X', username='root', key='eC4bLRy2va******************************', read_consistency=ReadConsistency.EVENTUAL_CONSISTENCY, timeout=timeout )
import tcvectordb
from tcvectordb.model.enum import FieldType, IndexType, MetricType, ReadConsistency

#create a database client object
client = tcvectordb.VectorDBClient(url='http://10.0.X.X', username='root', key='eC4bLRy2va******************************', read_consistency=ReadConsistency.EVENTUAL_CONSISTENCY, timeout=30)

请求参数

参数名称
参数含义
是否必选
获取方式
url
客户端所需连接的向量数据库服务端访问地址。
获取向量数据库实例内网 IP 地址与端口,请登录 向量数据库控制台,在实例详情页面网络信息区域直接复制访问地址。具体操作,请参见 查看实例信息

username
客户端访问向量数据库服务端的账号。
数据库当前仅支持 root 账号。
key
客户端访问向量数据库服务端的 API 密钥,用于进行身份认证。
请登录 向量数据库控制台,在密钥管理页面直接复制密钥。具体操作,请参见 密钥管理



read_consistency
设置读一致性。
取值如下所示,默认为 EVENTUAL_CONSISTENCY
ReadConsistency.STRONG_CONSISTENCY:强一致性。
ReadConsistency.EVENTUAL_CONSISTENCY:最终一致性。
timeout
请求超时时间。
单位:秒。
默认值:5。
取值范围:大于等于0。若 timeout 设置为小于0或为 Null,系统会自动赋值为默认值。