本文介紹如何通過Java SDK向Collection中插入Doc。
插入Doc時若指定id已存在,已存在的Doc不會被覆蓋,本次插入Doc操作無效。
插入Doc時若不指定id,則在插入過程中會自動生成id,并在返回結果中攜帶id信息。
前提條件
已創建Cluster:創建Cluster。
已獲得API-KEY:API-KEY管理。
已安裝最新版SDK:安裝DashVector SDK。
接口定義
// class DashVectorCollection
// 同步接口
public Response<List<DocOpResult>> insert(InsertDocRequest insertDocRequest);
// 異步接口
public ListenableFuture<Response<List<DocOpResult>>> insertAsync(InsertDocRequest insertDocRequest);
使用示例
需要使用您的api-key替換示例中的YOUR_API_KEY、您的Cluster Endpoint替換示例中的YOUR_CLUSTER_ENDPOINT,代碼才能正常運行。
本示例需要參考新建Collection提前創建好名稱為
quickstart
的Collection。
插入Doc
import com.aliyun.dashvector.DashVectorClient;
import com.aliyun.dashvector.DashVectorClientConfig;
import com.aliyun.dashvector.DashVectorCollection;
import com.aliyun.dashvector.common.DashVectorException;
import com.aliyun.dashvector.models.Doc;
import com.aliyun.dashvector.models.Vector;
import com.aliyun.dashvector.models.requests.InsertDocRequest;
import com.aliyun.dashvector.models.responses.Response;
import com.google.common.util.concurrent.ListenableFuture;
import java.util.*;
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");
// 構建Vector
Vector vector = Vector.builder().value(Arrays.asList(0.1f, 0.2f, 0.3f, 0.4f)).build();
// 構建Doc
Doc doc = Doc.builder().id("1").vector(vector).build();
// 插入Doc
Response<List<DocOpResult>> response = collection.insert(InsertDocRequest.builder().doc(doc).build());
// 判斷插入是否成功
// assert response.isSuccess()
}
}
插入不帶有Id的Doc
// 構建Vector
Vector vector = Vector.builder().value(Arrays.asList(0.1f, 0.2f, 0.3f, 0.4f)).build();
// 構建Doc
Doc doc = Doc.builder().vector(vector).build();
// 插入Doc
Response<List<DocOpResult>> response = collection.insert(InsertDocRequest.builder().doc(doc).build());
插入帶有Fields的Doc
// 構建Vector
Vector vector = Vector.builder().value(Arrays.asList(0.2f, 0.2f, 0.3f, 0.4f)).build();
// 插入單條數據,并設置Fields Value
Doc doc = Doc.builder()
.id("2")
.vector(vector)
// 設置創建Collection時預定義的Fields Value
.field("name", "zhangshan")
.field("age", 20)
.field("weight", 100f)
// 設置Schema-Free的Field & Value
.field("anykey1", "String")
.field("anykey2", 1)
.field("anykey3", true)
.field("anykey4", 3.1415926f)
.build();
// 插入Doc
Response<List<DocOpResult>> response = collection.insert(InsertDocRequest.builder().doc(doc).build());
// 判斷插入Doc是否成功
assert response.isSuccess()
批量插入Doc
// 通過InsertDocRequest對象,批量插入10條Doc
List<Doc> docs = new ArrayList<>();
for (int i = 0; i < 10; i++) {
docs.add(
Doc.builder()
.id(Integer.toString(i+3))
.vector(Vector.builder().value(Collections.nCopies(4, (float) i+3)).build())
.build()
);
}
InsertDocRequest request = InsertDocRequest.builder().docs(docs).build();
Response<List<DocOpResult>> response = collection.insert(request);
// 判斷插入是否成功
assert response.isSuccess();
異步插入Doc
// 異步批量插入10條數據
List<Doc> docs = new ArrayList<>();
for (int i = 0; i < 10; i++) {
docs.add(
Doc.builder()
.id(Integer.toString(i+13))
.vector(Vector.builder().value(Collections.nCopies(4, (float) i+13)).build())
.build()
);
}
InsertDocRequest request = InsertDocRequest.builder().docs(docs).build();
ListenableFuture<Response<List<DocOpResult>>> response = collection.insertAsync(request);
// 等待并獲取異步insert結果
Response<List<DocOpResult>> ret = response.get();
插入帶有Sparse Vector的Doc
Vector vector = Vector.builder().value(Arrays.asList(0.1f, 0.2f, 0.3f, 0.4f)).build();
// 構建帶有Sparse Vector的Doc
Doc doc = Doc.builder()
.id("28")
.sparseVector(
new Map<Integer, Float>() {
{
put(1, 0.4f);
put(10000, 0.6f);
put(222222, 0.8f);
}
})
.vector(vector)
.build();
// 插入帶有Sparse Vector的Doc
Response<List<DocOpResult>> response = collection.insert(InsertDocRequest.builder().doc(doc).build());
插入多向量的Doc
public void insert() {
collection = client.get(collectionName);
assert collection.isSuccess();
List<Doc> docs = new ArrayList<>();
docs.add(Doc.builder().id("0")
.vector("title", (Vector.builder().value(Collections.nCopies(4, 0.1f))).build())
.vector("content", (Vector.builder().value(Collections.nCopies(6, 0.1f))).build())
.build());
// 允許部分向量字段缺失
docs.add(Doc.builder().id("1")
.vector("title", (Vector.builder().value(Collections.nCopies(4, 0.2f))).build())
.build());
docs.add(Doc.builder().id("2")
.vector("content", (Vector.builder().value(Collections.nCopies(6, 0.3f))).build())
.build());
InsertDocRequest insertRequest = InsertDocRequest.builder().docs(docs).build();
Response<List<DocOpResult>> insertResponse = collection.insert(insertRequest);
System.out.println(insertResponse);
assert insertResponse.isSuccess();
}
入參描述
可通過InsertDocRequestBuilder
構造InsertDocRequest
對象,其可用方法如下:
方法 | 必填 | 默認值 | 描述 |
docs(List<Doc> docs) | 是 | - | 設置Doc列表 |
doc(Doc doc) | 追加Doc至Doc列表,可多次調用 | ||
partition(String partition) | 否 | default | 分區名稱 |
build() | - | - | 構造 |
可通過DocBuilder
構造Doc
對象,其可用方法如下:
方法 | 必填 | 默認值 | 描述 |
id(String id) | 否 | - | 主鍵 |
vector(Vector vector) | 是 | - | 向量數據 |
sparseVector(Map(Integer, Float)) | 否 | - | 稀疏向量 |
fields(Map<String, Object>) | 否 | - | 設置Fields |
field(String key, Object value) | 追加Field至Fields,可多次調用 | ||
build() | - | - | 構造 |
Doc對象的fields參數,可自由設置“任意”的KeyValue數據,Key必須為
String
類型,Value必須為String, Integer, Boolean or Float
。當Key在創建Collection時預先定義過,則Value的類型必須為預定義時的類型
當Key未在創建Collection時預先定義過,則Value的類型可為
String, Integer, Boolean or Float
是否預先定義Fields,可參考Schema Free。
出參描述
返回結果為Response<List<DocOpResult>>
對象,Response<List<DocOpResult>>
對象中可獲取本次操作結果信息,如下表所示。
方法 | 返回類型 | 描述 | 示例 |
getCode() | int | 返回值,參考返回狀態碼說明 | 0 |
getMessage() | String | 返回消息 | success |
getRequestId() | String | 請求唯一id | 19215409-ea66-4db9-8764-26ce2eb5bb99 |
getOutput() | List<DocOpResult> | 返回插入Doc的結果 | |
getUsage() | 對Serverless實例(按量付費)集合的Doc插入請求,成功后返回實際消耗的寫請求單元數 | ||
isSuccess() | Boolean | 判斷請求是否成功 | true |