如何通过Python SDK新建一个DashVector Client

本文介绍如何通过Python SDK新建一个DashVector Client。

说明

通过DashVector Client可连接DashVector服务端，进行Collection相关操作。

前提条件

• 已创建Cluster：创建Cluster。

• 已获得API-KEY：API-KEY管理。

• 已安装最新版SDK：安装DashVector SDK。

接口定义

Python示例：

dashvector.Client(
    api_key: str,
    endpoint: str,
    protocol: dashvector.DashVectorProtocol = dashvector.DashVectorProtocol.GRPC,
    timeout: float = 10.0
) -> Client

使用示例

说明

需要使用您的api-key替换示例中的YOUR_API_KEY、您的Cluster Endpoint替换示例中的YOUR_CLUSTER_ENDPOINT，代码才能正常运行。

Python示例：

import dashvector

client = dashvector.Client(
    api_key='YOUR_API_KEY',
    endpoint='YOUR_CLUSTER_ENDPOINT'
)

# 判断client是否创建成功
if client:
    print('create client success!')

# 等同于下列代码
# from dashvector import DashVectorCode
# if client.code == DashVectorCode.Success:
#     print('create client success!')

入参描述

参数	类型	默认值	说明
api_key	str	-	api-key
endpoint	str	-	Cluster的Endpoint
protocol（可选）	DashVectorProtocol	DashVectorProtocol.GRPC	通信协议，DashVectorProtocol.GRPC、DashVectorProtocol.HTTP
timeout（可选）	float	10.0	超时时间（单位：秒），-1 代表不超时。

说明

1.endpoint参数，可在控制台Cluster详情中查看。

2.protocol参数，建议使用默认值DashVectorProtocol.GRPC，可获得更高的性能体验。

出参描述

说明

返回结果为Client对象，Client对象中可获取本次操作结果信息，如下表所示。

字段	类型	描述	示例
code	int	返回值，参考返回状态码说明	0
message	str	返回消息	success
request_id	str	请求唯一id	19215409-ea66-4db9-8764-26ce2eb5bb99