Skip to content

armgit / floci

Public Imported from GitHub
0

Light, fluffy, and always free - The AWS Local Emulator alternative

fix(s3vectors): return cosine distance from queries (#2175)

Aniket Shukla2f5bc3968030
diff --git a/compatibility-tests/sdk-test-java/src/test/java/com/floci/test/S3VectorsTest.java b/compatibility-tests/sdk-test-java/src/test/java/com/floci/test/S3VectorsTest.java
index 9c0f0a9de7..cd3395e88d 100644
--- a/compatibility-tests/sdk-test-java/src/test/java/com/floci/test/S3VectorsTest.java
+++ b/compatibility-tests/sdk-test-java/src/test/java/com/floci/test/S3VectorsTest.java
@@ -173,6 +173,7 @@ class S3VectorsTest {
.queryVector(VectorData.builder().float32(1.0f, 0.1f, 0.0f).build())
.topK(1)
.returnMetadata(true)
+ .returnDistance(true)
.build()
);
assertThat(response.vectors()).hasSize(1);
diff --git a/src/main/java/io/github/hectorvent/floci/services/s3vectors/S3VectorsController.java b/src/main/java/io/github/hectorvent/floci/services/s3vectors/S3VectorsController.java
index 24b1778c41..863cdd3c6b 100644
--- a/src/main/java/io/github/hectorvent/floci/services/s3vectors/S3VectorsController.java
+++ b/src/main/java/io/github/hectorvent/floci/services/s3vectors/S3VectorsController.java
@@ -394,11 +394,13 @@ public class S3VectorsController {
);
boolean returnMetadata = request.returnMetadata() != null && request.returnMetadata();
+ boolean returnDistance = request.returnDistance() != null && request.returnDistance();
List<QueryResultRepresentation> reps = results.stream()
.map(res -> {
Map<String, Object> metadata = returnMetadata ? res.getVector().getMetadata() : null;
- return new QueryResultRepresentation(res.getVector().getKey(), res.getDistance(), metadata);
+ Double distance = returnDistance ? res.getDistance() : null;
+ return new QueryResultRepresentation(res.getVector().getKey(), distance, metadata);
})
.toList();
diff --git a/src/main/java/io/github/hectorvent/floci/services/s3vectors/S3VectorsService.java b/src/main/java/io/github/hectorvent/floci/services/s3vectors/S3VectorsService.java
index 4cf8cbe2f2..5d4e8f22b2 100644
--- a/src/main/java/io/github/hectorvent/floci/services/s3vectors/S3VectorsService.java
+++ b/src/main/java/io/github/hectorvent/floci/services/s3vectors/S3VectorsService.java
@@ -182,20 +182,13 @@ public class S3VectorsService {
break;
case "cosine":
default:
- distance = calculateCosineSimilarity(queryVector, v.getData());
+ distance = calculateCosineDistance(queryVector, v.getData());
break;
}
results.add(new QueryResult(v, distance));
}
- // Sorting:
- // For Euclidean distance, smaller distance is closer (ascending)
- // For Cosine similarity, larger score is closer (descending)
- if ("euclidean".equals(metric)) {
- results.sort(Comparator.comparingDouble(QueryResult::getDistance));
- } else {
- results.sort((r1, r2) -> Double.compare(r2.getDistance(), r1.getDistance()));
- }
+ results.sort(Comparator.comparingDouble(QueryResult::getDistance));
return results.stream().limit(topK).collect(Collectors.toList());
}
@@ -216,6 +209,11 @@ public class S3VectorsService {
return dotProduct / (Math.sqrt(normA) * Math.sqrt(normB));
}
+ private double calculateCosineDistance(List<Float> v1, List<Float> v2) {
+ double similarity = calculateCosineSimilarity(v1, v2);
+ return 1.0 - Math.max(-1.0, Math.min(1.0, similarity));
+ }
+
private double calculateEuclideanDistance(List<Float> v1, List<Float> v2) {
if (v1 == null || v2 == null || v1.size() != v2.size()) return Double.MAX_VALUE;
double sum = 0.0;
@@ -226,15 +224,6 @@ public class S3VectorsService {
return Math.sqrt(sum);
}
- private double calculateDotProduct(List<Float> v1, List<Float> v2) {
- if (v1 == null || v2 == null || v1.size() != v2.size()) return 0.0;
- double dotProduct = 0.0;
- for (int i = 0; i < v1.size(); i++) {
- dotProduct += v1.get(i) * v2.get(i);
- }
- return dotProduct;
- }
-
public static class QueryResult {
private final VectorData vector;
private final double distance;
diff --git a/src/test/java/io/github/hectorvent/floci/services/s3vectors/S3VectorsIntegrationTest.java b/src/test/java/io/github/hectorvent/floci/services/s3vectors/S3VectorsIntegrationTest.java
index 9b837fb47b..bd026e6b6c 100644
--- a/src/test/java/io/github/hectorvent/floci/services/s3vectors/S3VectorsIntegrationTest.java
+++ b/src/test/java/io/github/hectorvent/floci/services/s3vectors/S3VectorsIntegrationTest.java
@@ -204,24 +204,50 @@ class S3VectorsIntegrationTest {
"vectorBucketName": "%s",
"indexName": "%s",
"queryVector": {
- "float32": [1.0, 0.1, 0.0]
+ "float32": [1.0, 0.0, 0.0]
},
- "topK": 1,
- "returnMetadata": true
+ "topK": 2,
+ "returnMetadata": true,
+ "returnDistance": true
}
""".formatted(BUCKET_NAME, INDEX_NAME))
.when()
.post("/QueryVectors")
.then()
.statusCode(200)
- .body("vectors", hasSize(1))
+ .body("vectors", hasSize(2))
.body("vectors[0].key", equalTo("v1"))
- .body("vectors[0].distance", notNullValue())
- .body("vectors[0].metadata.label", equalTo("first"));
+ .body("vectors[0].distance", equalTo(0.0f))
+ .body("vectors[0].metadata.label", equalTo("first"))
+ .body("vectors[1].key", equalTo("v2"))
+ .body("vectors[1].distance", equalTo(1.0f));
}
@Test
@Order(10)
+ void queryVectors_withoutReturnDistance_omitsDistance() {
+ given()
+ .contentType(JSON_CONTENT_TYPE)
+ .body("""
+ {
+ "vectorBucketName": "%s",
+ "indexName": "%s",
+ "queryVector": {
+ "float32": [1.0, 0.0, 0.0]
+ },
+ "topK": 1
+ }
+ """.formatted(BUCKET_NAME, INDEX_NAME))
+ .when()
+ .post("/QueryVectors")
+ .then()
+ .statusCode(200)
+ .body("vectors", hasSize(1))
+ .body("vectors[0]", not(hasKey("distance")));
+ }
+
+ @Test
+ @Order(11)
void deleteVectors() {
given()
.contentType(JSON_CONTENT_TYPE)
@@ -256,7 +282,7 @@ class S3VectorsIntegrationTest {
}
@Test
- @Order(11)
+ @Order(12)
void deleteIndex() {
given()
.contentType(JSON_CONTENT_TYPE)
@@ -287,7 +313,7 @@ class S3VectorsIntegrationTest {
}
@Test
- @Order(12)
+ @Order(13)
void deleteVectorBucket() {
given()
.contentType(JSON_CONTENT_TYPE)