擷取Doc

本文介紹如何通過Java SDK，根據id或id列表擷取Collection中已存在的Doc。

說明

如果指定id不存在，則該id對應的Doc為空白。

前提條件

已建立Cluster：建立Cluster。
已獲得API-KEY：API-KEY管理。
已安裝最新版SDK：安裝DashVector SDK。

介面定義

Java

            
// class DashVectorCollection

// 同步介面
public Response<Map<String, Doc>> fetch(FetchDocRequest fetchDocRequest);

// 非同步介面
public ListenableFuture<Response<Map<String, Doc>>> fetchAsync(FetchDocRequest fetchDocRequest);

使用樣本

說明

需要使用您的api-key替換樣本中的YOUR_API_KEY、您的Cluster Endpoint替換樣本中的YOUR_CLUSTER_ENDPOINT，代碼才能正常運行。

本樣本需要參考建立Collection-使用樣本提前建立好名稱為quickstart的Collection，並參考插入Doc提前插入部分資料。

Java

            
            
          
import com.aliyun.dashvector.DashVectorClient;
import com.aliyun.dashvector.DashVectorCollection;
import com.aliyun.dashvector.common.DashVectorException;
import com.aliyun.dashvector.models.Doc;
import com.aliyun.dashvector.models.requests.FetchDocRequest;
import com.aliyun.dashvector.models.responses.Response;

import java.util.Map;

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");

        // 構建 FetchDocRequest
        FetchDocRequest request = FetchDocRequest.builder()
            .id("1")
            .build();

        // 發送擷取Doc請求
        Response<Map<String, Doc>> response = collection.fetch(request);

        System.out.println(response);
        // example output:
        // {
        //     "code":0,
        //     "message":"Success",
        //     "requestId":"489c5cda-3ffc-4171-b6e0-1837b932962b",
        //     "output":{
        //         "1":{
        //             "id":"1",
        //             "vector":{"value":[0.1,0.2,0.3,0.4]},
        //             "fields":{
        //                 "name":"zhangsan",
        //                 "age":20,
        //                 "weight":100.0,
        //                 "anykey1":"String",
        //                 "anykey2":1,
        //                 "anykey3":true,
        //                 "anykey4":3.1415926
        //             },
        //             "score":0
        //         }
        //     }
        // }
    }
}

入參描述

通過FetchDocRequestBuilder構造FetchDocRequest對象，其可用方法如下表所示：

方法	必填	預設值	描述
ids(List<String> ids)	是	-	文檔主鍵列表
id(String id)	否	-	文檔主鍵列表
partition(String partition)	否	default	分區名稱
build()	-	-	構造`FetchDocRequest`對象

出參描述

說明

返回結果為Response<Map<String, Doc>>對象，Response<Map<String, Doc>>對象中可擷取本次操作結果資訊，如下表所示。

方法	類型	描述	樣本
getCode()	int	傳回值，參考返回狀態代碼說明	0
getMessage()	String	返回訊息	success
getRequestId()	String	請求唯一id	19215409-ea66-4db9-8764-26ce2eb5bb99
getOutput()	Map<String, Doc>	key為主鍵，value為對應Doc的Map	`{ "1":{ "id":"1", "vector":{"value":[0.1,0.2,0.3,0.4]}, "fields":{"name":"zhangsan"}, "score":0 } }`
isSuccess()	Boolean	判斷請求是否成功	true