Skip to content

Fix: Make metadata mutable in AzureVectorStore (Azure AI Search) #4131

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
merged 5 commits into from
Aug 14, 2025
Merged

Fix: Make metadata mutable in AzureVectorStore (Azure AI Search) #4131

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
25b0353
fix(azure): parse metadata JSON into mutable Map before injecting dis…
jinlee1703 Aug 13, 2025
4ab833a
test(azure): add unit tests for mutable metadata parsing and distance
jinlee1703 Aug 13, 2025
4b44359
refactor(azure): replace LinkedHashMap with HashMap in parseMetadataT…
jinlee1703 Aug 13, 2025
903706a
docs(azure): add @author and document metadata tests
jinlee1703 Aug 13, 2025
08544a5
chore(license): add Apache 2.0 header to new test
jinlee1703 Aug 13, 2025
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
21 changes: 17 additions & 4 deletions ...-azure-store/src/main/java/org/springframework/ai/vectorstore/azure/AzureVectorStore.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@

import java.util.ArrayList;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
Expand Down Expand Up @@ -239,10 +240,7 @@ public List<Document> doSimilaritySearch(SearchRequest request) {

final AzureSearchDocument entry = result.getDocument(AzureSearchDocument.class);

Map<String, Object> metadata = (StringUtils.hasText(entry.metadata()))
? JSONObject.parseObject(entry.metadata(), new TypeReference<>() {

}) : Map.of();
Map<String, Object> metadata = parseMetadataToMutable(entry.metadata());

metadata.put(DocumentMetadata.DISTANCE.value(), 1.0 - result.getScore());

Expand Down Expand Up @@ -325,6 +323,21 @@ public <T> Optional<T> getNativeClient() {
return Optional.of(client);
}

static Map<String, Object> parseMetadataToMutable(@Nullable String metadataJson) {
if (!StringUtils.hasText(metadataJson)) {
return new LinkedHashMap<>();
Copy link
Contributor

@dev-jonghoonpark dev-jonghoonpark Aug 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a particular reason you used a LinkedHashMap?
It seems like a regular HashMap would work just as well.

Copy link
Contributor Author

@jinlee1703 jinlee1703 Aug 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the question! I used LinkedHashMap to preserve iteration order so that the parsed JSON key order is kept and the injected distance appears last. This gives deterministic logging/serialization and makes debugging easier. There’s no functional dependency on ordering though—if the project prefers HashMap, I’m happy to switch.

Copy link
Contributor

@dev-jonghoonpark dev-jonghoonpark Aug 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it doesn’t affect the outcome, there may not be a significant difference, but since HashMap is more efficient, it seems better to change it to a HashMap.

Copy link
Contributor Author

@jinlee1703 jinlee1703 Aug 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great point—updated to use HashMap since ordering isn’t required. The helper now returns a new HashMap<> and tests still pass. PTAL. ✅ (4b44359)

}
try {
Map<String, Object> parsed = JSONObject.parseObject(metadataJson, new TypeReference<Map<String, Object>>() {
});
return (parsed == null) ? new LinkedHashMap<>() : new LinkedHashMap<>(parsed);
}
catch (Exception ex) {
logger.warn("Failed to parse metadata JSON. Using empty metadata. json={}", metadataJson, ex);
return new LinkedHashMap<>();
}
}

public record MetadataField(String name, SearchFieldDataType fieldType) {

public static MetadataField text(String name) {
Expand Down
34 changes: 34 additions & 0 deletions ...src/test/java/org/springframework/ai/vectorstore/azure/AzureVectorStoreMetadataTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
package org.springframework.ai.vectorstore.azure;

import static org.assertj.core.api.Assertions.assertThat;

import java.util.Map;

import org.junit.jupiter.api.Test;

class AzureVectorStoreMetadataTests {

@Test
void returnsMutableMapForBlankOrNull() {
Map<String, Object> m1 = AzureVectorStore.parseMetadataToMutable(null);
m1.put("distance", 0.1);
assertThat(m1).containsEntry("distance", 0.1);

Map<String, Object> m2 = AzureVectorStore.parseMetadataToMutable("");
m2.put("distance", 0.2);
assertThat(m2).containsEntry("distance", 0.2);

Map<String, Object> m3 = AzureVectorStore.parseMetadataToMutable(" ");
m3.put("distance", 0.3);
assertThat(m3).containsEntry("distance", 0.3);
}

@Test
void wrapsParsedJsonInLinkedHashMapSoItIsMutable() {
Map<String, Object> map = AzureVectorStore.parseMetadataToMutable("{\"k\":\"v\"}");
assertThat(map).containsEntry("k", "v");
map.put("distance", 0.4);
assertThat(map).containsEntry("distance", 0.4);
}

}