Merge pull request #4 from WayneCao/main

support sparse vector && binary vector && HNSWPQ && case sensitivity && search iterator

Author: WayneCao

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.baidu</groupId>
     <artifactId>mochow-sdk-java</artifactId>
-    <version>2.0.1</version>
+    <version>2.2.1</version>
     <name>mochow-sdk-java</name>
     <description>Java SDK for mochow.</description>
     <url>https://cloud.baidu.com/doc/VDB/index.html</url>

src/main/java/com/baidu/mochow/client/MochowClient.java

@@ -10,6 +10,7 @@
  * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
  * specific language governing permissions and limitations under the License.
  */
+
 package com.baidu.mochow.client;
 
 import org.slf4j.Logger;
@@ -72,10 +73,13 @@
 import com.baidu.mochow.model.BatchSearchRequest;
 import com.baidu.mochow.model.BatchSearchResponse;
 import com.baidu.mochow.model.UpsertResponse;
-import com.baidu.mochow.model.SearchRequest.BM25SearchRequestInterface;
-import com.baidu.mochow.model.SearchRequest.HybridSearchRequestInterface;
-import com.baidu.mochow.model.SearchRequest.SearchRequestInterface;
-import com.baidu.mochow.model.SearchRequest.VectorSearchRequestInterface;
+import com.baidu.mochow.model.ModifyTableRequest;
+import com.baidu.mochow.model.SearchIterator;
+import com.baidu.mochow.model.SearchIteratorArgs;
+import com.baidu.mochow.model.VectorSearchRequestInterface;
+import com.baidu.mochow.model.BM25SearchRequestInterface;
+import com.baidu.mochow.model.HybridSearchRequestInterface;
+import com.baidu.mochow.model.SearchRequestInterface;
 
 /**
  * Provides the client for accessing the Baidu VDB Service.
@@ -104,6 +108,7 @@ public class MochowClient extends AbstractMochowClient {
     private static final String QUERY = "query";
     private static final String SEARCH = "search";
     private static final String BATCH_SEARCH = "batchSearch";
+    private static final String MULTI_VECTOR_SEARCH = "multiVectorSearch";
     private static final String UPDATE = "update";
     private static final String SELECT = "select";
 
@@ -175,7 +180,7 @@ public boolean hasTable(String databaseName, String tableName) throws MochowClie
 
     public void dropTable(String databaseName, String tableName) throws MochowClientException {
         InternalRequest internalRequest = this.createRequest(
-                new AbstractMochowRequest() {}, HttpMethodName.DELETE, TABLE_PREFIX);
+            new AbstractMochowRequest() {}, HttpMethodName.DELETE, TABLE_PREFIX);
         internalRequest.addParameter("database", databaseName);
         internalRequest.addParameter("table", tableName);
         this.invokeHttpClient(internalRequest, AbstractMochowResponse.class);
@@ -369,6 +374,17 @@ public SelectResponse select(SelectRequest request) throws MochowClientException
         return this.invokeHttpClient(internalRequest, SelectResponse.class);
     }
 
+    public void modifyTable(ModifyTableRequest request) throws MochowClientException {
+        InternalRequest internalRequest = this.createRequest(request, HttpMethodName.POST, TABLE_PREFIX);
+        internalRequest.addParameter(MODIFY, "");
+        fillPayload(internalRequest, request);
+        this.invokeHttpClient(internalRequest, AbstractMochowResponse.class);
+    }
+
+    public SearchIterator searchIterator(SearchIteratorArgs args) {
+        return new SearchIterator(this, args);
+    }
+
     /**
      * Creates and initializes a new request object for the specified resource.
      *

src/main/java/com/baidu/mochow/examples/Main.java

@@ -2,6 +2,7 @@
 
 import com.baidu.mochow.auth.Credentials;
 import com.baidu.mochow.client.ClientConfiguration;
+import com.baidu.mochow.model.enums.IndexType;
 
 public class Main {
     public static void main(String[] args) {
@@ -12,9 +13,9 @@ public static void main(String[] args) {
         ClientConfiguration clientConfiguration = new ClientConfiguration();
         clientConfiguration.setCredentials(new Credentials(account, apiKey));
         clientConfiguration.setEndpoint(endpoint);
-        MochowExample example = new MochowExample(clientConfiguration);
+        MochowExample example = new MochowExample(clientConfiguration, IndexType.HNSW);
         example.example();
         System.out.println("Finish to execute mochow example");
         System.exit(0);
     }
-}
+}

src/main/java/com/baidu/mochow/examples/MochowExample.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2025 Baidu, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+
+package com.baidu.mochow.model;
+
+import java.util.HashMap;
+import java.util.Map;
+
+public class BM25SearchFields extends SearchCommonFields {
+    public String indexName;
+    public String searchText;
+
+    public void fillSearchFields(Map<String, Object> fields) {
+        for (Map.Entry<String, Object> entry : toMap().entrySet()) {
+            fields.put(entry.getKey(), entry.getValue());
+        }
+
+        Map<String, Object> params = new HashMap<>();
+        params.put("indexName", indexName);
+        params.put("searchText", searchText);
+
+        fields.put("BM25SearchParams", params);
+    }
+} 

src/main/java/com/baidu/mochow/model/BM25SearchFields.java

@@ -17,8 +17,6 @@
 import java.util.List;
 import java.util.Map;
 
-import com.baidu.mochow.model.SearchRequest.BM25SearchFields;
-import com.baidu.mochow.model.SearchRequest.BM25SearchRequestInterface;
 import com.baidu.mochow.model.entity.GeneralParams;
 import com.baidu.mochow.model.enums.ReadConsistency;
 import com.fasterxml.jackson.annotation.JsonValue;

src/main/java/com/baidu/mochow/model/BM25SearchRequest.java

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2025 Baidu, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+
+package com.baidu.mochow.model;
+
+public interface BM25SearchRequestInterface extends SearchRequestInterface {
+} 

src/main/java/com/baidu/mochow/model/BM25SearchRequestInterface.java

@@ -13,23 +13,63 @@
 
 package com.baidu.mochow.model;
 
+import java.util.ArrayList;
 import java.util.List;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import lombok.AllArgsConstructor;
-import lombok.Builder;
 import lombok.Getter;
+import lombok.NoArgsConstructor;
 import lombok.Setter;
 
 import com.baidu.mochow.model.entity.IndexField;
 
 @Getter
 @Setter
-@Builder
+@NoArgsConstructor
 @AllArgsConstructor
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public class CreateIndexRequest extends AbstractMochowRequest {
     private String database;
     private String table;
     private List<IndexField> indexes;
+
+    private CreateIndexRequest(CreateIndexRequest.Builder builder) {
+        this.database = builder.database;
+        this.table = builder.table;
+        this.indexes = builder.indexes;
+    }
+
+    public static CreateIndexRequest.Builder builder() {
+        return new CreateIndexRequest.Builder();
+    }
+
+    public static class Builder {
+        private String database;
+        private String table;
+        private List<IndexField> indexes;
+
+        private Builder() {
+            this.indexes = new ArrayList<>();
+        }
+
+        public CreateIndexRequest.Builder database(String database) {
+            this.database = database;
+            return this;
+        }
+
+        public CreateIndexRequest.Builder table(String table) {
+            this.table = table;
+            return this;
+        }
+
+        public CreateIndexRequest.Builder addIndex(IndexField field) {
+            this.indexes.add(field);
+            return this;
+        }
+
+        public CreateIndexRequest build() {
+            return new CreateIndexRequest(this);
+        }
+    }
 }

src/main/java/com/baidu/mochow/model/CreateIndexRequest.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2025 Baidu, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+
+package com.baidu.mochow.model;
+
+import java.util.Map;
+
+public class HybridSearchFields extends SearchCommonFields {
+    VectorSearchRequestInterface vectorRequest;
+    BM25SearchRequestInterface bm25Request;
+    float vectorWeight;
+    float bm25Weight;
+
+    public void fillSearchFields(Map<String, Object> fields) {
+        if (vectorRequest != null) {
+            vectorRequest.toMap().forEach(fields::put);
+        }
+
+        if (bm25Request != null) {
+            bm25Request.toMap().forEach(fields::put);
+        }
+
+        for (Map.Entry<String, Object> entry : toMap().entrySet()) {
+            fields.put(entry.getKey(), entry.getValue());
+        }
+
+        if (fields.containsKey("anns")) {
+            @SuppressWarnings("unchecked")
+            Map<String, Object> anns = (Map<String, Object>) fields.get("anns");
+            anns.put("weight", vectorWeight);
+        }
+
+        if (fields.containsKey("BM25SearchParams")) {
+            @SuppressWarnings("unchecked")
+            Map<String, Object> bm25 = (Map<String, Object>) fields.get("BM25SearchParams");
+            bm25.put("weight", bm25Weight);
+        }
+    }
+} 

src/main/java/com/baidu/mochow/model/HybridSearchFields.java

@@ -17,10 +17,6 @@
 import java.util.List;
 import java.util.Map;
 
-import com.baidu.mochow.model.SearchRequest.BM25SearchRequestInterface;
-import com.baidu.mochow.model.SearchRequest.HybridSearchFields;
-import com.baidu.mochow.model.SearchRequest.HybridSearchRequestInterface;
-import com.baidu.mochow.model.SearchRequest.VectorSearchRequestInterface;
 import com.baidu.mochow.model.entity.GeneralParams;
 import com.baidu.mochow.model.enums.ReadConsistency;
 import com.fasterxml.jackson.annotation.JsonValue;