如何通過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對象中可獲取本次操作錯誤信息，如下表所示。