如何通过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对象中可获取本次操作错误信息，如下表所示。