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

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

说明

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

前提条件

接口定义

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 |

相关推荐
一眼青苔2 分钟前
python环境使用conda,conda如何升级默认的python版本
开发语言·python·conda
柒七爱吃麻辣烫6 分钟前
访问Maven私服的教程
java·maven
PeterOne7 分钟前
Trae MCP + Obsidian 集成如何缓解开发者的时间损耗
人工智能·trae
Star abuse8 分钟前
河北省大数据应用创新大赛样题
大数据·大数据应用创新大赛
橘猫云计算机设计9 分钟前
net+MySQL中小民营企业安全生产管理系统(源码+lw+部署文档+讲解),源码可白嫖!
数据库·后端·爬虫·python·mysql·django·毕业设计
Y1nhl10 分钟前
力扣hot100_链表(3)_python版本
python·算法·leetcode·链表·职场和发展
黄嚯嚯15 分钟前
Mysql8.0 推出的强大功能 窗口函数(Window Functions)
数据库·mysql
特立独行的猫a20 分钟前
redis客户端库redis++在嵌入式Linux下的交叉编译及使用
linux·数据库·c++·redis·redis客户端库
Tang102430 分钟前
Glide 4.x 版本的图片加载流程
java
振宇i32 分钟前
Java 富文本转word
java·word·富文本·docx4j