描述Collection
更新時間：
本文介紹如何通過Python SDK獲取已創(chuàng)建的Collection的狀態(tài)和Schema信息。
前提條件
已創(chuàng)建Cluster：創(chuàng)建Cluster。
已獲得API-KEY：API-KEY管理。
已安裝最新版SDK：安裝DashVector SDK。
接口定義
Client.describe(name: str) -> DashVectorResponse使用示例
說明
需要使用您的api-key替換示例中的YOUR_API_KEY、您的Cluster Endpoint替換示例中的YOUR_CLUSTER_ENDPOINT，代碼才能正常運行。
本示例需要參考新建Collection-使用示例提前創(chuàng)建好名稱為
quickstart的Collection。
import dashvector
client = dashvector.Client(
api_key='YOUR_API_KEY',
endpoint='YOUR_CLUSTER_ENDPOINT'
)
ret = client.describe(name='quickstart')
print(ret)
# example output:
# {
# "request_id": "8d3ac14e-5382-4736-b77c-4318761ddfab",
# "code": 0,
# "message": "",
# "output": {
# "name": "quickstart",
# "dimension": 4,
# "dtype": "FLOAT",
# "metric": "dotproduct",
# "fields_schema": {
# "name": "STRING",
# "age": "INT",
# "height": "FLOAT"
# },
# "status": "SERVING",
# "partitions": {
# "default": "SERVING"
# }
# }
# }入?yún)⒚枋?/b>
參數(shù) | 類型 | 默認(rèn)值 | 說明 |
name | str | - | 您已創(chuàng)建的Collection名稱 |
出參描述
說明
返回結(jié)果為DashVectorResponse對象，DashVectorResponse對象中可獲取本次操作結(jié)果信息，如下表所示。
字段 | 類型 | 描述 | 示例 |
code | int | 返回值，參考返回狀態(tài)碼說明 | 0 |
message | str | 返回消息 | success |
request_id | str | 請求唯一id | 19215409-ea66-4db9-8764-26ce2eb5bb99 |
output | CollectionMeta |
文檔內(nèi)容是否對您有幫助？