如何通过Python SDK描述Collection

本文介绍如何通过Python SDK获取已创建的Collection的状态和Schema信息。

前提条件

• 已创建Cluster：创建Cluster

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

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

接口定义

Python示例：

Client.describe(name: str) -> 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'
)

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",
#       "weight": "FLOAT",
#       "id": "LONG"
#     },
#     "status": "SERVING",
#     "partitions": {
#       "default": "SERVING"
#     }
#   }
# }