本文介绍如何通过Java SDK获取已创建的Collection对象。点击了解更多关于向量检索服务 DashVector信息，可进行免费试用~
本文介绍如何通过Java SDK获取已创建的Collection对象。
说明
通过Collection对象，后续可进行Doc相关操作，如插入Doc、检索Doc、管理Partition等
前提条件
-
已创建Cluster：创建Cluster。
-
已获得API-KEY：API-KEY管理。
-
已安装最新版SDK：安装DashVector SDK。
接口定义
Java
// class DashVectorClientpublic DashVectorCollection get(String name);
使用示例
说明
-
需要使用您的api-key替换示例中的YOUR_API_KEY、您的Cluster Endpoint替换示例中的YOUR_CLUSTER_ENDPOINT，代码才能正常运行。
-
本示例需要参考新建Collection-使用示例提前创建好名称为
quickstart的Collection。
Java
import com.aliyun.dashvector.DashVectorClient;
import com.aliyun.dashvector.DashVectorCollection;
import com.aliyun.dashvector.common.DashVectorException;public class Main {public static void main(String[] args) throws DashVectorException {DashVectorClient client = new DashVectorClient("YOUR_API_KEY", "YOUR_CLUSTER_ENDPOINT");DashVectorCollection collection = client.get("quickstart");// 判断请求是否成功assert collection.isSuccess();}
}
入参描述
| 参数 | 类型 | 必填 | 默认值 | 描述 |
|---|---|---|---|---|
| name | String | 是 | \- | 已创建的集合名称 |
出参描述
说明
返回结果为DashVectorCollection对象，DashVectorCollection对象中可获取本次操作结果信息，如下表所示。
| 方法 | 类型 | 描述 | 示例 |
|---|---|---|---|
| getCode() | int | 返回值，参考返回状态码说明 | 0 |
| getMessage() | String | 返回消息 | success |
| getRequestId() | String | 请求唯一id | 19215409-ea66-4db9-8764-26ce2eb5bb99 |
| getName() | String | 集合名称 | complex |
| getCollectionMeta() | CollectionMeta | 集合信息，参考CollectionMeta | { "name":"quickstart", "dimension":4, "dataType":"INT", "metric":"dotproduct", "status":"SERVING", "fieldsSchema":{ "name":"STRING", "weight":"FLOAT", "age":"INT" }, "partitionStatus":{ "default":"SERVING" } } |
| isSuccess() | Boolean | 判断请求是否成功 | true |