Skip to content

Support for SimpleVectorStore with metdata filter expressions #1851

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

Closed
wants to merge 1 commit into from
Closed

Support for SimpleVectorStore with metdata filter expressions #1851

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
64 changes: 38 additions & 26 deletions spring-ai-core/src/main/java/org/springframework/ai/vectorstore/SimpleVectorStore.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,6 @@

package org.springframework.ai.vectorstore;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.nio.charset.StandardCharsets;
import java.nio.file.FileAlreadyExistsException;
import java.nio.file.Files;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.concurrent.ConcurrentHashMap;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
Expand All @@ -41,23 +24,35 @@
import io.micrometer.observation.ObservationRegistry;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.springframework.ai.document.Document;
import org.springframework.ai.embedding.EmbeddingModel;
import org.springframework.ai.observation.conventions.VectorStoreProvider;
import org.springframework.ai.observation.conventions.VectorStoreSimilarityMetric;
import org.springframework.ai.util.JacksonUtils;
import org.springframework.ai.vectorstore.filter.FilterExpressionConverter;
import org.springframework.ai.vectorstore.filter.converter.SimpleVectorStoreFilterExpressionConverter;
import org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore;
import org.springframework.ai.vectorstore.observation.VectorStoreObservationContext;
import org.springframework.ai.vectorstore.observation.VectorStoreObservationConvention;
import org.springframework.core.io.Resource;
import org.springframework.expression.ExpressionParser;
import org.springframework.expression.spel.standard.SpelExpressionParser;
import org.springframework.expression.spel.support.StandardEvaluationContext;

import java.io.*;
import java.nio.charset.StandardCharsets;
import java.nio.file.FileAlreadyExistsException;
import java.nio.file.Files;
import java.util.*;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Predicate;

/**
* SimpleVectorStore is a simple implementation of the VectorStore interface.
*
* <p>
* It also provides methods to save the current state of the vectors to a file, and to
* load vectors from a file.
*
* <p>
* For a deeper understanding of the mathematical concepts and computations involved in
* calculating similarity scores among vectors, refer to this
* [resource](https://docs.spring.io/spring-ai/reference/api/vectordbs.html#_understanding_vectors).
Expand All @@ -68,13 +63,18 @@
* @author Christian Tzolov
* @author Sebastien Deleuze
* @author Ilayaperumal Gopinathan
* @author Jemin Huh
*/
public class SimpleVectorStore extends AbstractObservationVectorStore {

private static final Logger logger = LoggerFactory.getLogger(SimpleVectorStore.class);

private final ObjectMapper objectMapper;

private final ExpressionParser expressionParser;

private final FilterExpressionConverter filterExpressionConverter;

protected Map<String, SimpleVectorStoreContent> store = new ConcurrentHashMap<>();

protected EmbeddingModel embeddingModel;
Expand All @@ -91,6 +91,8 @@ public SimpleVectorStore(EmbeddingModel embeddingModel, ObservationRegistry obse
Objects.requireNonNull(embeddingModel, "EmbeddingModel must not be null");
this.embeddingModel = embeddingModel;
this.objectMapper = JsonMapper.builder().addModules(JacksonUtils.instantiateAvailableModules()).build();
this.expressionParser = new SpelExpressionParser();
this.filterExpressionConverter = new SimpleVectorStoreFilterExpressionConverter();
}

@Override
Expand Down Expand Up @@ -119,14 +121,11 @@ public Optional<Boolean> doDelete(List<String> idList) {

@Override
public List<Document> doSimilaritySearch(SearchRequest request) {
if (request.getFilterExpression() != null) {
throw new UnsupportedOperationException(
"The [" + this.getClass() + "] doesn't support metadata filtering!");
}

Predicate<SimpleVectorStoreContent> documentFilterPredicate = doFilterPredicate(request);
float[] userQueryEmbedding = getUserQueryEmbedding(request.getQuery());
return this.store.values()
.stream()
.filter(documentFilterPredicate)
.map(entry -> new Similarity(entry,
EmbeddingMath.cosineSimilarity(userQueryEmbedding, entry.getEmbedding())))
.filter(s -> s.score >= request.getSimilarityThreshold())
Expand All @@ -136,6 +135,16 @@ public List<Document> doSimilaritySearch(SearchRequest request) {
.toList();
}

private Predicate<SimpleVectorStoreContent> doFilterPredicate(SearchRequest request) {
return request.hasFilterExpression() ? document -> {
StandardEvaluationContext context = new StandardEvaluationContext();
context.setVariable("metadata", document.getMetadata());
return this.expressionParser
.parseExpression(this.filterExpressionConverter.convertExpression(request.getFilterExpression()))
.getValue(context, Boolean.class);
} : document -> true;
}

/**
* Serialize the vector store content into a file in JSON format.
* @param file the file to save the vector store content
Expand Down Expand Up @@ -247,10 +256,13 @@ public Similarity(SimpleVectorStoreContent content, double score) {
}

Document getDocument() {
// Add the calculated distance (1 - score) to the metadata
Map<String, Object> metadata = new HashMap<>(this.content.getMetadata());
metadata.put("distance", 1 - score);
return Document.builder()
.withId(this.content.getId())
.withContent(this.content.getContent())
.withMetadata(this.content.getMetadata())
.withMetadata(metadata)
.build();
}

Expand Down
147 changes: 147 additions & 0 deletions ...framework/ai/vectorstore/filter/converter/SimpleVectorStoreFilterExpressionConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
/*
* Copyright 2023-2024 the original author or authors.
*
* 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
*
* https://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 org.springframework.ai.vectorstore.filter.converter;

import org.springframework.ai.vectorstore.filter.Filter;
import org.springframework.ai.vectorstore.filter.Filter.Expression;

import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.List;
import java.util.TimeZone;
import java.util.regex.Pattern;

/**
* Converts {@link Expression} into SpEL metadata filter expression format.
* (https://docs.spring.io/spring-framework/reference/core/expressions.html)
*
* @author Jemin Huh
*/
public class SimpleVectorStoreFilterExpressionConverter extends AbstractFilterExpressionConverter {

private static final Pattern DATE_FORMAT_PATTERN = Pattern.compile("\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z");

private final SimpleDateFormat dateFormat;

public SimpleVectorStoreFilterExpressionConverter() {
this.dateFormat = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
this.dateFormat.setTimeZone(TimeZone.getTimeZone("UTC"));
}

@Override
protected void doExpression(Filter.Expression expression, StringBuilder context) {
this.convertOperand(expression.left(), context);
context.append(getOperationSymbol(expression));
this.convertOperand(expression.right(), context);
}

private String getOperationSymbol(Filter.Expression exp) {
return switch (exp.type()) {
case AND -> " and ";
case OR -> " or ";
case EQ -> " == ";
case LT -> " < ";
case LTE -> " <= ";
case GT -> " > ";
case GTE -> " >= ";
case NE -> " != ";
case IN -> " in ";
case NIN -> " not in ";
default -> throw new RuntimeException("Not supported expression type: " + exp.type());
};
}

@Override
protected void doKey(Filter.Key key, StringBuilder context) {
var identifier = hasOuterQuotes(key.key()) ? removeOuterQuotes(key.key()) : key.key();
context.append("#metadata['").append(identifier).append("']");
}

@Override
protected void doValue(Filter.Value filterValue, StringBuilder context) {
if (filterValue.value() instanceof List<?> list) {
var formattedList = new StringBuilder("{");
int c = 0;
for (Object v : list) {
this.doSingleValue(v, formattedList);
if (c++ < list.size() - 1) {
this.doAddValueRangeSpitter(filterValue, formattedList);
}
}
formattedList.append("}");

if (context.lastIndexOf("in ") == -1) {
context.append(formattedList);
}
else {
appendSpELContains(formattedList, context);
}
}
else {
this.doSingleValue(filterValue.value(), context);
}
}

private void appendSpELContains(StringBuilder formattedList, StringBuilder context) {
int metadataStart = context.lastIndexOf("#metadata");
if (metadataStart == -1)
throw new RuntimeException("Wrong SpEL expression: " + context);

int metadataEnd = context.indexOf(" ", metadataStart);
String metadata = context.substring(metadataStart, metadataEnd);
context.setLength(context.lastIndexOf("in "));
context.delete(metadataStart, metadataEnd + 1);
context.append(formattedList).append(".contains(").append(metadata).append(")");
}

@Override
protected void doSingleValue(Object value, StringBuilder context) {
if (value instanceof Date date) {
context.append("'");
context.append(this.dateFormat.format(date));
context.append("'");
}
else if (value instanceof String text) {
context.append("'");
if (DATE_FORMAT_PATTERN.matcher(text).matches()) {
try {
Date date = this.dateFormat.parse(text);
context.append(this.dateFormat.format(date));
}
catch (ParseException e) {
throw new IllegalArgumentException("Invalid date type:" + text, e);
}
}
else {
context.append(text);
}
context.append("'");
}
else {
context.append(value);
}
}

@Override
protected void doGroup(Filter.Group group, StringBuilder context) {
context.append("(");
super.doGroup(group, context);
context.append(")");
}

}
Loading