-
Notifications
You must be signed in to change notification settings - Fork 188
[ISSUE-851] implemented VectorStore and VectorStoreMetadata interfaces with validation and persistence - #855
Open
Sumit2342 wants to merge 2 commits into
Open
Conversation
...s with validation and persistence
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Pull request overview
Implements the vector store SPI for geaflow-ai, adding a metadata contract plus two concrete store implementations (in-memory and local JSONL persistence), along with basic unit tests.
Changes:
- Added
VectorStoreAPI plus core model types (VectorRecord,VectorQuery,VectorHit) andVectorStoreException. - Implemented
InMemoryVectorStoreandLocalVectorStore(JSONL append + checksum/quarantine). - Added
DistanceMetric/DistanceUtilsand JUnit tests covering basic upsert/search/delete and some validation.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 16 comments.
Show a summary per file
| File | Description |
|---|---|
| geaflow-ai/src/test/java/org/apache/geaflow/ai/index/vectorstore/VectorStoreTest.java | Adds unit tests exercising both store implementations and some validation scenarios |
| geaflow-ai/src/main/java/org/apache/geaflow/ai/index/vectorstore/VectorStoreMetadata.java | Introduces persisted metadata model with constructor validation and equality |
| geaflow-ai/src/main/java/org/apache/geaflow/ai/index/vectorstore/VectorStoreException.java | Adds domain exception with error codes for consistent failure handling |
| geaflow-ai/src/main/java/org/apache/geaflow/ai/index/vectorstore/VectorStore.java | Defines the SPI for vector operations (upsert/search/delete/close) |
| geaflow-ai/src/main/java/org/apache/geaflow/ai/index/vectorstore/VectorRecord.java | Defines the stored vector payload and associated metadata |
| geaflow-ai/src/main/java/org/apache/geaflow/ai/index/vectorstore/VectorQuery.java | Defines query vector + topK + filter metadata |
| geaflow-ai/src/main/java/org/apache/geaflow/ai/index/vectorstore/VectorHit.java | Defines search result item (id/score/record) |
| geaflow-ai/src/main/java/org/apache/geaflow/ai/index/vectorstore/LocalVectorStore.java | Implements a JSONL-backed store with checksum/quarantine and in-memory index |
| geaflow-ai/src/main/java/org/apache/geaflow/ai/index/vectorstore/InMemoryVectorStore.java | Implements an in-memory store with filtering + topK scoring |
| geaflow-ai/src/main/java/org/apache/geaflow/ai/index/vectorstore/DistanceUtils.java | Implements scoring for cosine/L2/dot-product |
| geaflow-ai/src/main/java/org/apache/geaflow/ai/index/vectorstore/DistanceMetric.java | Adds supported distance metrics enum |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+70
to
+78
for (Map.Entry<String, String> entry : query.getFilterMetadata().entrySet()) {
if (entry.getKey().equals("model_name")) {
continue;
}
if (!Objects.equals(record.getMetadata().get(entry.getKey()), entry.getValue()) && !Objects.equals(record.getSourceType(), entry.getValue())) {
match = false;
break;
}
}
* See the License for the specific language governing permissions and
* limitations under the License.
*/
private final Gson gson = new Gson();
private final ConcurrentHashMap<String, VectorRecord> store = new ConcurrentHashMap<>();
private final Set<String> deletedIds = ConcurrentHashMap.newKeySet();
private BufferedWriter writer;
Comment on lines
+189
to
+197
for (Map.Entry<String, String> entry : query.getFilterMetadata().entrySet()) {
if (entry.getKey().equals("model_name")) {
continue;
}
if (!Objects.equals(record.getMetadata().get(entry.getKey()), entry.getValue()) && !Objects.equals(record.getSourceType(), entry.getValue())) {
match = false;
break;
}
}
Comment on lines
+83
to
+91
String expectedChecksum = json.get("__checksum").getAsString();
JsonObject dataForChecksum = new JsonParser().parse(line).getAsJsonObject();
dataForChecksum.remove("__checksum");
String actualChecksum = computeChecksum(dataForChecksum.toString());
if (!expectedChecksum.equals(actualChecksum)) {
quarantineLine(line);
return;
testVectorStore(store);
}
private void testVectorStore(VectorStore store) {
assertEquals(1, hits.size());
assertEquals("v1", hits.get(0).getVectorId());
// Dimension mismatch
store.upsert(badRecord);
});
// Model mismatch
store.search(badQuery);
});
// Delete
Comment on lines
+24
to
+30
/**
* Insert or update a single vector record.
* Upsert is idempotent: same vectorId overwrites the previous record.
*
* @throws VectorStoreException if record.embedding.length != metadata.dimension (DIMENSION_MISMATCH)
* @throws VectorStoreException if required metadata fields are missing (METADATA_INCOMPLETE)
*/
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
This PR addresses issue [#851 ] by defining the VectorStore SPI and VectorStoreMetadata contract for the geaflow-ai module.
Major changes include:
• Created the generic VectorStore interface to define standard vector operations (add, delete, search, init).
• Added VectorStoreMetadata with required fields (model_name, dimension, distance, index_version, created_at, format_version) and local fixture
persistence using Gson.
• Implemented strict metadata validation that throws IllegalArgumentException on dimension mismatch, missing metadata, or model
mismatch.
How was this PR tested?
[✓] Tests have Added for the changes
[ ] Production environment verified
Added the VectorStoreMetadataTest which systematically verifies:
• Saving and loading the metadata to/from the JSON local fixture.
• Exception throwing when required fields are missing during validation.
• Exception throwing when testing against dimension or model mismatches.