Skip to content

Fix a bug of SearchResultsWrapper.getRowRecords() that returns wrong data for output fields #1445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sre-ci-robot merged 1 commit into from
Jul 7, 2025
Merged

Fix a bug of SearchResultsWrapper.getRowRecords() that returns wrong data for output fields #1445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion examples/src/main/java/io/milvus/v1/CommonUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,18 @@ public static List<List<Float>> generateFixFloatVectors(int dimension, int count
return vectors;
}

public static void compareFloatVectors(List<Float> vec1, List<Float> vec2) {
if (vec1.size() != vec2.size()) {
throw new RuntimeException(String.format("Vector dimension mismatch: %d vs %d", vec1.size(), vec2.size()));
}
for (int i = 0; i < vec1.size(); i++) {
if (Math.abs(vec1.get(i) - vec2.get(i)) > 0.001f) {
throw new RuntimeException(String.format("Vector value mismatch: %f vs %f at No.%d value",
vec1.get(i), vec2.get(i), i));
}
}
}

/////////////////////////////////////////////////////////////////////////////////////////////////////
public static ByteBuffer generateBinaryVector(int dimension) {
Random ran = new Random();
Expand Down Expand Up @@ -302,5 +314,4 @@ public static List<SortedMap<Long, Float>> generateSparseVectors(int count) {
}
return vectors;
}

}
77 changes: 73 additions & 4 deletions examples/src/main/java/io/milvus/v1/JsonFieldExample.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,25 +26,30 @@
import io.milvus.common.clientenum.ConsistencyLevelEnum;
import io.milvus.grpc.DataType;
import io.milvus.grpc.QueryResults;
import io.milvus.grpc.SearchResults;
import io.milvus.param.*;
import io.milvus.param.collection.*;
import io.milvus.param.dml.InsertParam;
import io.milvus.param.dml.QueryParam;
import io.milvus.param.dml.SearchParam;
import io.milvus.param.index.CreateIndexParam;
import io.milvus.response.QueryResultsWrapper;
import io.milvus.response.SearchResultsWrapper;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

public class JsonFieldExample {
private static final String COLLECTION_NAME = "java_sdk_example_json_v1";
private static final String ID_FIELD = "id";
private static final String ID_FIELD = "key";
private static final String VECTOR_FIELD = "vector";
private static final String JSON_FIELD = "metadata";
private static final Integer VECTOR_DIM = 128;

private static void queryWithExpr(MilvusClient client, String expr) {
System.out.printf("%n=============================Query with expr: '%s'================================%n", expr);
R<QueryResults> queryRet = client.query(QueryParam.newBuilder()
.withCollectionName(COLLECTION_NAME)
.withExpr(expr)
Expand All @@ -56,7 +61,6 @@ private static void queryWithExpr(MilvusClient client, String expr) {
for (QueryResultsWrapper.RowRecord record : records) {
System.out.println(record);
}
System.out.println("=============================================================");
}

public static void main(String[] args) {
Expand Down Expand Up @@ -123,22 +127,28 @@ public static void main(String[] args) {
System.out.println("Collection created");

// insert rows
List<List<Float>> vectors = new ArrayList<>();
List<JsonObject> metadatas = new ArrayList<>();
Gson gson = new Gson();
for (int i = 0; i < 100; i++) {
JsonObject row = new JsonObject();
row.addProperty(ID_FIELD, i);
row.add(VECTOR_FIELD, gson.toJsonTree(CommonUtils.generateFloatVector(VECTOR_DIM)));
List<Float> vector = CommonUtils.generateFloatVector(VECTOR_DIM);
row.add(VECTOR_FIELD, gson.toJsonTree(vector));
vectors.add(vector);

// Note: for JSON field, always construct a real JsonObject
// don't use row.addProperty(JSON_FIELD, strContent) since the value is treated as a string, not a JsonObject
JsonObject metadata = new JsonObject();
metadata.addProperty("path", String.format("\\root/abc/path%d", i));
metadata.addProperty("path", String.format("\\root/abc/path_%d", i));
metadata.addProperty("size", i);
if (i%7 == 0) {
metadata.addProperty("special", true);
}

metadata.add("flags", gson.toJsonTree(Arrays.asList(i, i + 1, i + 2)));
row.add(JSON_FIELD, metadata);
metadatas.add(metadata);
// System.out.println(metadata);

// dynamic fields
Expand All @@ -165,6 +175,65 @@ public static void main(String[] args) {
long rowCount = (long)queryWrapper.getFieldWrapper("count(*)").getFieldData().get(0);
System.out.printf("%d rows persisted\n", rowCount);

// search and output JSON field
List<List<Float>> searchVectors = new ArrayList<>();
List<JsonObject> expectedMetadatas = new ArrayList<>();
for (int i = 0; i < 10; i++) {
List<Float> targetVector = vectors.get(i);
searchVectors.add(targetVector);
expectedMetadatas.add(metadatas.get(i));
}
R<SearchResults> searchRet = client.search(SearchParam.newBuilder()
.withCollectionName(COLLECTION_NAME)
.withLimit(3L)
.withFloatVectors(searchVectors)
.withVectorFieldName(VECTOR_FIELD)
.addOutField(ID_FIELD)
.addOutField(VECTOR_FIELD)
.addOutField(JSON_FIELD)
.build());
CommonUtils.handleResponseStatus(searchRet);

SearchResultsWrapper resultsWrapper = new SearchResultsWrapper(searchRet.getData().getResults());
System.out.println("\n=============================Search result with IDScore================================");
for (int i = 0; i < 10; i++) {
List<SearchResultsWrapper.IDScore> scores = resultsWrapper.getIDScore(i);
System.out.printf("\nThe result of No.%d target vector:\n", i);
for (SearchResultsWrapper.IDScore score : scores) {
System.out.println(score);
}
long pk = scores.get(0).getLongID();
if (pk != i) {
throw new RuntimeException(String.format("The top1 ID %d is not equal to target vector's ID %d", pk, i));
}
JsonObject metadata = (JsonObject) scores.get(0).get(JSON_FIELD);
if (!metadata.equals(expectedMetadatas.get(i))) {
throw new RuntimeException(String.format("The top1 metadata %s is not equal to target metadata %s",
metadata, expectedMetadatas.get(i)));
}
List<Float> vector = (List<Float>) scores.get(0).get(VECTOR_FIELD);
CommonUtils.compareFloatVectors(vector, searchVectors.get(i));
}
System.out.println("\n=============================Search result with RowRecord================================");
for (int i = 0; i < 10; i++) {
List<QueryResultsWrapper.RowRecord> records = resultsWrapper.getRowRecords(i);
System.out.printf("\nThe result of No.%d target vector:\n", i);
for (QueryResultsWrapper.RowRecord record : records) {
System.out.println(record);
}
long pk = (long)records.get(0).get(ID_FIELD);
if (pk != i) {
throw new RuntimeException(String.format("The top1 ID %d is not equal to target vector's ID %d", pk, i));
}
JsonObject metadata = (JsonObject) records.get(0).get(JSON_FIELD);
if (!metadata.equals(expectedMetadatas.get(i))) {
throw new RuntimeException(String.format("The top1 metadata %s is not equal to target metadata %s",
metadata, expectedMetadatas.get(i)));
}
List<Float> vector = (List<Float>) records.get(0).get(VECTOR_FIELD);
CommonUtils.compareFloatVectors(vector, searchVectors.get(i));
}

// query by filtering JSON
queryWithExpr(client, "exists metadata[\"special\"]");
queryWithExpr(client, "metadata[\"size\"] < 5");
Expand Down
55 changes: 51 additions & 4 deletions examples/src/main/java/io/milvus/v2/JsonFieldExample.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,18 +32,23 @@
import io.milvus.v2.service.collection.request.DropCollectionReq;
import io.milvus.v2.service.vector.request.InsertReq;
import io.milvus.v2.service.vector.request.QueryReq;
import io.milvus.v2.service.vector.request.SearchReq;
import io.milvus.v2.service.vector.request.data.BaseVector;
import io.milvus.v2.service.vector.request.data.FloatVec;
import io.milvus.v2.service.vector.response.QueryResp;
import io.milvus.v2.service.vector.response.SearchResp;

import java.util.*;

public class JsonFieldExample {
private static final String COLLECTION_NAME = "java_sdk_example_json_v2";
private static final String ID_FIELD = "id";
private static final String ID_FIELD = "key";
private static final String VECTOR_FIELD = "vector";
private static final String JSON_FIELD = "metadata";
private static final Integer VECTOR_DIM = 128;

private static void queryWithExpr(MilvusClientV2 client, String expr) {
System.out.printf("%n=============================Query with expr: '%s'================================%n", expr);
QueryResp queryRet = client.query(QueryReq.builder()
.collectionName(COLLECTION_NAME)
.filter(expr)
Expand All @@ -54,7 +59,6 @@ private static void queryWithExpr(MilvusClientV2 client, String expr) {
for (QueryResp.QueryResult record : records) {
System.out.println(record.getEntity());
}
System.out.println("=============================================================");
}

public static void main(String[] args) {
Expand Down Expand Up @@ -104,22 +108,27 @@ public static void main(String[] args) {
System.out.println("Collection created");

// Insert rows
List<List<Float>> vectors = new ArrayList<>();
List<JsonObject> metadatas = new ArrayList<>();
Gson gson = new Gson();
for (int i = 0; i < 100; i++) {
JsonObject row = new JsonObject();
row.addProperty(ID_FIELD, i);
row.add(VECTOR_FIELD, gson.toJsonTree(CommonUtils.generateFloatVector(VECTOR_DIM)));
List<Float> vector = CommonUtils.generateFloatVector(VECTOR_DIM);
row.add(VECTOR_FIELD, gson.toJsonTree(vector));
vectors.add(vector);

// Note: for JSON field, always construct a real JsonObject
// don't use row.addProperty(JSON_FIELD, strContent) since the value is treated as a string, not a JsonObject
JsonObject metadata = new JsonObject();
metadata.addProperty("path", String.format("\\root/abc/path%d", i));
metadata.addProperty("path", String.format("\\root/abc/path_%d", i));
metadata.addProperty("size", i);
if (i%7 == 0) {
metadata.addProperty("special", true);
}
metadata.add("flags", gson.toJsonTree(Arrays.asList(i, i + 1, i + 2)));
row.add(JSON_FIELD, metadata);
metadatas.add(metadata);
// System.out.println(metadata);

// dynamic fields
Expand All @@ -144,6 +153,44 @@ public static void main(String[] args) {
.build());
System.out.printf("%d rows persisted\n", (long)countR.getQueryResults().get(0).getEntity().get("count(*)"));

// Search and output JSON field
List<BaseVector> searchVectors = new ArrayList<>();
List<JsonObject> expectedMetadatas = new ArrayList<>();
for (int i = 0; i < 10; i++) {
List<Float> targetVector = vectors.get(i);
searchVectors.add(new FloatVec(targetVector));
expectedMetadatas.add(metadatas.get(i));
}
SearchResp searchRet = client.search(SearchReq.builder()
.collectionName(COLLECTION_NAME)
.data(searchVectors)
.limit(3L)
.annsField(VECTOR_FIELD)
.outputFields(Arrays.asList(ID_FIELD, VECTOR_FIELD, JSON_FIELD))
.build());

System.out.println("\n=============================Search result================================");
List<List<SearchResp.SearchResult>> searchResults = searchRet.getSearchResults();
for (int i = 0; i < 10; i++) {
List<SearchResp.SearchResult> results = searchResults.get(i);
System.out.printf("\nThe result of No.%d target vector:\n", i);
for (SearchResp.SearchResult result : results) {
System.out.println(result);
}

long pk = (long)results.get(0).getId();
if (pk != i) {
throw new RuntimeException(String.format("The top1 ID %d is not equal to target vector's ID %d", pk, i));
}
JsonObject metadata = (JsonObject) results.get(0).getEntity().get(JSON_FIELD);
if (!metadata.equals(expectedMetadatas.get(i))) {
throw new RuntimeException(String.format("The top1 metadata %s is not equal to target metadata %s",
metadata, expectedMetadatas.get(i)));
}
List<Float> vector = (List<Float>) results.get(0).getEntity().get(VECTOR_FIELD);
CommonUtils.compareFloatVectors(vector, (List<Float>)searchVectors.get(i).getData());
}

// Query by filtering JSON
queryWithExpr(client, "exists metadata[\"special\"]");
queryWithExpr(client, "metadata[\"size\"] < 5");
Expand Down
14 changes: 8 additions & 6 deletions sdk-core/src/main/java/io/milvus/response/SearchResultsWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,11 @@
public class SearchResultsWrapper extends RowRecordWrapper {
private final SearchResultData results;

private String primaryKey = "id";

public SearchResultsWrapper(@NonNull SearchResultData results) {
this.results = results;
this.primaryKey = results.getPrimaryFieldName();
}

/**
Expand Down Expand Up @@ -86,13 +89,13 @@ public List<QueryResultsWrapper.RowRecord> getRowRecords(int indexOfTarget) {
IDScore score = idScore.get(i);
QueryResultsWrapper.RowRecord record = new QueryResultsWrapper.RowRecord();
if (score.getStrID().isEmpty()) {
record.put("id", score.getLongID());
record.put(primaryKey, score.getLongID());
} else {
record.put("id", score.getStrID());
record.put(primaryKey, score.getStrID());
}

record.put("score", score.getScore()); // use score instead
buildRowRecord(record, i);
buildRowRecord(record, indexOfTarget*topK + (long)i);
records.add(record);
}
return records;
Expand Down Expand Up @@ -162,15 +165,14 @@ public List<IDScore> getIDScore(int indexOfTarget) throws ParamException, Illega

// set id and score
IDs ids = results.getIds();
String pkName = results.getPrimaryFieldName();
if (ids.hasIntId()) {
LongArray longIDs = ids.getIntId();
if (offset + k > longIDs.getDataCount()) {
throw new IllegalResponseException("Result ids count is wrong");
}

for (int n = 0; n < k; ++n) {
idScores.add(new IDScore(pkName, "", longIDs.getData((int)offset + n), results.getScores((int)offset + n)));
idScores.add(new IDScore(primaryKey, "", longIDs.getData((int)offset + n), results.getScores((int)offset + n)));
}
} else if (ids.hasStrId()) {
StringArray strIDs = ids.getStrId();
Expand All @@ -179,7 +181,7 @@ public List<IDScore> getIDScore(int indexOfTarget) throws ParamException, Illega
}

for (int n = 0; n < k; ++n) {
idScores.add(new IDScore(pkName, strIDs.getData((int)offset + n), 0, results.getScores((int)offset + n)));
idScores.add(new IDScore(primaryKey, strIDs.getData((int)offset + n), 0, results.getScores((int)offset + n)));
}
} else {
// in v2.3.3, return an empty list instead of throwing exception
Expand Down
11 changes: 11 additions & 0 deletions sdk-core/src/test/java/io/milvus/client/MilvusClientDockerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -678,6 +678,17 @@ void testFloatVectors() {
for (int k = 0; k < outputVec.size(); k++) {
Assertions.assertEquals(targetVectors.get(i).get(k), outputVec.get(k));
}

// verify the old way
List<QueryResultsWrapper.RowRecord> records = results.getRowRecords(i);
obj = records.get(0).get(DataType.FloatVector.name());
outputVec = (List<Float>)obj;
Assertions.assertEquals(targetVectors.get(i).size(), outputVec.size());
for (int k = 0; k < outputVec.size(); k++) {
Assertions.assertEquals(targetVectors.get(i).get(k), outputVec.get(k));
}
double d = (double)records.get(0).get(DataType.Double.name());
Assertions.assertEquals(d, compareWeights.get(i));
}

List<?> fieldData = results.getFieldData(DataType.Double.name(), 0);
Expand Down
Loading