向量数据库新建 Client

接口定义
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 或更高版本的环境下运行。
RPCVectorDBClient() 支持创建连接池，特别适合客户端节点较少但 collection 副本较多（尤其是单 Shard 多副本）的场景。
RPC 请求（推荐）
HTTP IO 请求（兼容 Restful 旧版本）
class RPCVectorDBClient(
    url: str,
    username: str = '',
    key: str = '',
    read_consistency: ReadConsistency = ReadConsistency.EVENTUAL_CONSISTENCY,
    timeout: int = 10,
    adapter: HTTPAdapter = None,
    pool_size: int = 1,
    proxies: dict | None = None,
    password: str | None = None,
    tls_config: TLSConfig | None = None,
    **kwargs: Any
)
class VectorDBClient(
    url: Any | None = None,
    username: str = '',
    key: str = '',
    read_consistency: ReadConsistency = ReadConsistency.EVENTUAL_CONSISTENCY,
    timeout: int = 10,
    adapter: HTTPAdapter = None,
    pool_size: int = 10,
    proxies: dict | None = None,
    password: str | None = None,
    tls_config: TLSConfig | None = None
)
使用示例
RPC 请求（推荐）
HTTP IO 请求（兼容 Restful 旧版本）
import tcvectordb
from tcvectordb.model.enum import ReadConsistency
﻿
client = tcvectordb.RPCVectorDBClient(
            url='http://10.0.X.X:80',
            username='root',
            key='eC4bLRy2va******************************',
            read_consistency=ReadConsistency.EVENTUAL_CONSISTENCY,
            timeout=30,
            tls_config=tcvectordb.TLSConfig(ca_cert_path='./ca.crt'),
          )
import tcvectordb
from tcvectordb.model.enum import ReadConsistency
﻿
client = tcvectordb.VectorDBClient(
    url='http://10.0.X.X:80',
    username='root', 
    key='eC4bLRy2va******************************', 
    read_consistency=ReadConsistency.EVENTUAL_CONSISTENCY, 
    timeout=30,
    tls_config=tcvectordb.TLSConfig(ca_cert_path='./ca.crt'),
)
入参描述
参数名
参数含义
是否必选
获取方式
url
客户端所需连接的向量数据库服务端访问地址。
是
获取向量数据库实例内网 IP 地址与端口，请登录 向量数据库控制台，在实例详情页面网络信息区域直接复制访问地址。具体操作，请参见 查看实例信息。默认端口为80。
﻿
username
客户端访问向量数据库服务端的账号。
是
支持 root 账号，支持自定义账号。
key
客户端访问向量数据库服务端的 API 密钥，用于进行身份认证。
是
请登录 向量数据库控制台，在密钥管理页面直接复制密钥。具体操作，请参见 密钥管理。
﻿
﻿
﻿
read_consistency
设置读一致性。
否
取值如下所示，默认为 EVENTUAL_CONSISTENCY。
ReadConsistency.STRONG_CONSISTENCY：强一致性。
ReadConsistency.EVENTUAL_CONSISTENCY：最终一致性。
pool_size
设置连接池最大连接数
否
正整数，建议设置为数据节点个数的2-5倍。
timeout
请求超时时间。
是
单位：秒。
默认值：10。
取值范围：大于等于0。若 timeout 设置为小于0或为 null，系统会自动赋值为默认值。
tls_config
SSL 加密方式证书配置。
否
ca_cert_path：指定证书路径。获取方式，请参见 SSL 加密。
﻿
﻿
﻿
skip_verify：指定是否跳过证书校验。
False：默认为 False，不跳过证书校验（默认），SDK 将验证服务端证书以确保连接安全。
True：跳过证书校验。SDK 将不验证服务端证书。

参数名	参数含义	是否必选	获取方式
url	客户端所需连接的向量数据库服务端访问地址。	是	获取向量数据库实例内网 IP 地址与端口，请登录向量数据库控制台，在实例详情页面网络信息区域直接复制访问地址。具体操作，请参见查看实例信息。默认端口为80。
username	客户端访问向量数据库服务端的账号。	是	支持 root 账号，支持自定义账号。
key	客户端访问向量数据库服务端的 API 密钥，用于进行身份认证。	是	请登录向量数据库控制台，在密钥管理页面直接复制密钥。具体操作，请参见密钥管理。
read_consistency	设置读一致性。	否	取值如下所示，默认为 EVENTUAL_CONSISTENCY。 ReadConsistency.STRONG_CONSISTENCY：强一致性。 ReadConsistency.EVENTUAL_CONSISTENCY：最终一致性。
pool_size	设置连接池最大连接数	否	正整数，建议设置为数据节点个数的2-5倍。
timeout	请求超时时间。	是	单位：秒。默认值：10。取值范围：大于等于0。若 timeout 设置为小于0或为 null，系统会自动赋值为默认值。
tls_config	SSL 加密方式证书配置。	否	ca_cert_path：指定证书路径。获取方式，请参见 SSL 加密。
tls_config	SSL 加密方式证书配置。	否		skip_verify：指定是否跳过证书校验。 False：默认为 False，不跳过证书校验（默认），SDK 将验证服务端证书以确保连接安全。 True：跳过证书校验。SDK 将不验证服务端证书。

新建 Client

本页目录：

接口定义

使用示例

入参描述