如何通过 Python SDK 获取 Collection

本文介绍如何通过 Python SDK 获取已创建的 Collection 对象。

说明

通过 Collection 对象，后续可进行 Doc 相关操作，如插入 Doc、检索 Doc、管理 Partition 等

前提条件

• 已创建 Cluster：创建Cluster
  

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

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

接口定义

Python 示例：

Client.get(name: str) -> Union[Collection, DashVectorResponse]

使用示例

说明

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

2. 本示例需要参考新建Collection-使用示例提前创建好名称为quickstart的 Collection。

Python 示例：

import dashvector
client = dashvector.Client(    api_key='YOUR_API_KEY',    endpoint='YOUR_CLUSTER_ENDPOINT')
collection = client.get(name='quickstart')
# 判断get接口是否成功assert collection

出参描述

说明

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

2. 失败返回结果为 DashVectorResponse 对象，DashVectorResponse 对象中可获取本次操作错误信息，如下表所示。