fix: fix Spring AI embeddings for Hashes (List<Double> to byte[] conv…

…ersion was buggy)
redis · Jun 14, 2024 · d97c3e1 · d97c3e1
1 parent c5622ee
commit d97c3e1
Show file tree

Hide file tree

Showing 29 changed files with 1,171 additions and 129 deletions.
diff --git a/redis-om-spring/src/main/java/com/redis/om/spring/RedisEnhancedKeyValueAdapter.java b/redis-om-spring/src/main/java/com/redis/om/spring/RedisEnhancedKeyValueAdapter.java
@@ -7,7 +7,7 @@
 import com.redis.om.spring.indexing.RediSearchIndexer;
 import com.redis.om.spring.ops.RedisModulesOperations;
 import com.redis.om.spring.ops.search.SearchOperations;
-import com.redis.om.spring.vectorize.FeatureExtractor;
+import com.redis.om.spring.vectorize.Embedder;
 import org.springframework.data.convert.CustomConversions;
 import org.springframework.data.mapping.PersistentPropertyAccessor;
 import org.springframework.data.redis.connection.RedisConnection;
@@ -41,7 +41,7 @@ public class RedisEnhancedKeyValueAdapter extends RedisKeyValueAdapter {
   private final RedisModulesOperations<String> modulesOperations;
   private final RediSearchIndexer indexer;
   private final EntityAuditor auditor;
-  private final FeatureExtractor featureExtractor;
+  private final Embedder embedder;
   private final RedisOMProperties redisOMProperties;
 
   /**
@@ -56,9 +56,9 @@ public RedisEnhancedKeyValueAdapter( //
       RedisOperations<?, ?> redisOps, //
       RedisModulesOperations<?> rmo, //
       RediSearchIndexer indexer, //
-      FeatureExtractor featureExtractor, //
+      Embedder embedder, //
       RedisOMProperties redisOMProperties) {
-    this(redisOps, rmo, new RedisMappingContext(), indexer, featureExtractor, redisOMProperties);
+    this(redisOps, rmo, new RedisMappingContext(), indexer, embedder, redisOMProperties);
   }
 
   /**
@@ -75,9 +75,9 @@ public RedisEnhancedKeyValueAdapter( //
       RedisModulesOperations<?> rmo, //
       RedisMappingContext mappingContext, //
       RediSearchIndexer indexer, //
-      FeatureExtractor featureExtractor, //
+      Embedder embedder, //
       RedisOMProperties redisOMProperties) {
-    this(redisOps, rmo, mappingContext, new RedisOMCustomConversions(), indexer, featureExtractor, redisOMProperties);
+    this(redisOps, rmo, mappingContext, new RedisOMCustomConversions(), indexer, embedder, redisOMProperties);
   }
 
   /**
@@ -96,7 +96,7 @@ public RedisEnhancedKeyValueAdapter( //
       RedisMappingContext mappingContext, //
       @Nullable CustomConversions customConversions, //
       RediSearchIndexer indexer, //
-      FeatureExtractor featureExtractor, //
+      Embedder embedder, //
       RedisOMProperties redisOMProperties) {
     super(redisOps, mappingContext, customConversions);
 
@@ -114,7 +114,7 @@ public RedisEnhancedKeyValueAdapter( //
     this.modulesOperations = (RedisModulesOperations<String>) rmo;
     this.indexer = indexer;
     this.auditor = new EntityAuditor(this.redisOperations);
-    this.featureExtractor = featureExtractor;
+    this.embedder = embedder;
     this.redisOMProperties = redisOMProperties;
   }
 
@@ -141,7 +141,7 @@ public Object put(Object id, Object item, String keyspace) {
       }
       byte[] redisKey = createKey(sanitizeKeyspace(keyspace), idAsString);
       auditor.processEntity(redisKey, item);
-      featureExtractor.processEntity(item);
+      embedder.processEntity(item);
 
       rdo = new RedisData();
       converter.write(item, rdo);

diff --git a/redis-om-spring/src/main/java/com/redis/om/spring/RedisJSONKeyValueAdapter.java b/redis-om-spring/src/main/java/com/redis/om/spring/RedisJSONKeyValueAdapter.java
@@ -11,7 +11,7 @@
 import com.redis.om.spring.ops.json.JSONOperations;
 import com.redis.om.spring.ops.search.SearchOperations;
 import com.redis.om.spring.util.ObjectUtils;
-import com.redis.om.spring.vectorize.FeatureExtractor;
+import com.redis.om.spring.vectorize.Embedder;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.springframework.beans.*;
@@ -53,7 +53,7 @@ public class RedisJSONKeyValueAdapter extends RedisKeyValueAdapter {
   private final RediSearchIndexer indexer;
   private final GsonBuilder gsonBuilder;
   private final EntityAuditor auditor;
-  private final FeatureExtractor featureExtractor;
+  private final Embedder embedder;
   private final RedisOMProperties redisOMProperties;
 
   /**
@@ -72,7 +72,7 @@ public RedisJSONKeyValueAdapter( //
       RedisMappingContext mappingContext, //
       RediSearchIndexer indexer, //
       GsonBuilder gsonBuilder, //
-      FeatureExtractor featureExtractor, //
+      Embedder embedder, //
       RedisOMProperties redisOMProperties) {
     super(redisOps, mappingContext, new RedisOMCustomConversions());
     this.modulesOperations = (RedisModulesOperations<String>) rmo;
@@ -82,7 +82,7 @@ public RedisJSONKeyValueAdapter( //
     this.indexer = indexer;
     this.auditor = new EntityAuditor(this.redisOperations);
     this.gsonBuilder = gsonBuilder;
-    this.featureExtractor = featureExtractor;
+    this.embedder = embedder;
     this.redisOMProperties = redisOMProperties;
   }
 
@@ -102,7 +102,7 @@ public Object put(Object id, Object item, String keyspace) {
 
     processVersion(key, item);
     auditor.processEntity(key, item);
-    featureExtractor.processEntity(item);
+    embedder.processEntity(item);
     Optional<Long> maybeTtl = getTTLForEntity(item);
 
     ops.set(key, item);

diff --git a/redis-om-spring/src/main/java/com/redis/om/spring/RedisModulesConfiguration.java b/redis-om-spring/src/main/java/com/redis/om/spring/RedisModulesConfiguration.java
@@ -31,9 +31,9 @@
 import com.redis.om.spring.search.stream.EntityStream;
 import com.redis.om.spring.search.stream.EntityStreamImpl;
 import com.redis.om.spring.serialization.gson.*;
-import com.redis.om.spring.vectorize.DefaultFeatureExtractor;
-import com.redis.om.spring.vectorize.FeatureExtractor;
-import com.redis.om.spring.vectorize.NoopFeatureExtractor;
+import com.redis.om.spring.vectorize.DefaultEmbedder;
+import com.redis.om.spring.vectorize.Embedder;
+import com.redis.om.spring.vectorize.NoopEmbedder;
 import com.redis.om.spring.vectorize.face.FaceDetectionTranslator;
 import com.redis.om.spring.vectorize.face.FaceFeatureTranslator;
 import org.apache.commons.lang3.ObjectUtils;
@@ -562,7 +562,7 @@ BedrockTitanEmbeddingModel bedrockTitanEmbeddingModel(RedisOMProperties properti
   }
 
   @Bean(name = "featureExtractor")
-  public FeatureExtractor featureExtractor(
+  public Embedder featureExtractor(
       @Nullable @Qualifier("djlImageEmbeddingModel") ZooModel<Image, byte[]> imageEmbeddingModel,
       @Nullable @Qualifier("djlFaceEmbeddingModel") ZooModel<Image, float[]> faceEmbeddingModel,
       @Nullable @Qualifier("djlImageFactory") ImageFactory imageFactory,
@@ -574,10 +574,10 @@ public FeatureExtractor featureExtractor(
       @Nullable BedrockTitanEmbeddingModel bedrockTitanEmbeddingModel, RedisOMProperties properties,
       ApplicationContext ac) {
     return properties.getDjl().isEnabled() ?
-        new DefaultFeatureExtractor(ac, imageEmbeddingModel, faceEmbeddingModel, imageFactory, defaultImagePipeline,
+        new DefaultEmbedder(ac, imageEmbeddingModel, faceEmbeddingModel, imageFactory, defaultImagePipeline,
             sentenceTokenizer, openAITextVectorizer, azureOpenAIClient, vertexAiPaLm2EmbeddingModel,
             bedrockCohereEmbeddingModel, bedrockTitanEmbeddingModel, properties) :
-        new NoopFeatureExtractor();
+        new NoopEmbedder();
   }
 
   @Bean(name = "redisJSONKeyValueAdapter")
@@ -588,9 +588,9 @@ RedisJSONKeyValueAdapter getRedisJSONKeyValueAdapter( //
       RediSearchIndexer indexer, //
       @Qualifier("omGsonBuilder") GsonBuilder gsonBuilder, //
       RedisOMProperties properties, //
-      @Nullable @Qualifier("featureExtractor") FeatureExtractor featureExtractor) {
+      @Nullable @Qualifier("featureExtractor") Embedder embedder) {
     return new RedisJSONKeyValueAdapter(redisOps, redisModulesOperations, mappingContext, indexer, gsonBuilder,
-        featureExtractor, properties);
+        embedder, properties);
   }
 
   @Bean(name = "redisJSONKeyValueTemplate")
@@ -601,10 +601,10 @@ public CustomRedisKeyValueTemplate getRedisJSONKeyValueTemplate( //
       RediSearchIndexer indexer, //
       @Qualifier("omGsonBuilder") GsonBuilder gsonBuilder, //
       RedisOMProperties properties, //
-      @Nullable @Qualifier("featureExtractor") FeatureExtractor featureExtractor) {
+      @Nullable @Qualifier("featureExtractor") Embedder embedder) {
     return new CustomRedisKeyValueTemplate(
-        new RedisJSONKeyValueAdapter(redisOps, redisModulesOperations, mappingContext, indexer, gsonBuilder,
-            featureExtractor, properties), mappingContext);
+        new RedisJSONKeyValueAdapter(redisOps, redisModulesOperations, mappingContext, indexer, gsonBuilder, embedder,
+            properties), mappingContext);
   }
 
   @Bean(name = "redisCustomKeyValueTemplate")
@@ -614,9 +614,9 @@ public CustomRedisKeyValueTemplate getKeyValueTemplate( //
       RedisMappingContext mappingContext, //
       RediSearchIndexer indexer, //
       RedisOMProperties properties, //
-      @Nullable @Qualifier("featureExtractor") FeatureExtractor featureExtractor) {
+      @Nullable @Qualifier("featureExtractor") Embedder embedder) {
     return new CustomRedisKeyValueTemplate(
-        new RedisEnhancedKeyValueAdapter(redisOps, redisModulesOperations, mappingContext, indexer, featureExtractor,
+        new RedisEnhancedKeyValueAdapter(redisOps, redisModulesOperations, mappingContext, indexer, embedder,
             properties), //
         mappingContext);
   }

diff --git a/.../src/main/java/com/redis/om/spring/repository/support/RedisDocumentRepositoryFactory.java b/.../src/main/java/com/redis/om/spring/repository/support/RedisDocumentRepositoryFactory.java
@@ -5,7 +5,7 @@
 import com.redis.om.spring.indexing.RediSearchIndexer;
 import com.redis.om.spring.ops.RedisModulesOperations;
 import com.redis.om.spring.repository.query.RediSearchQuery;
-import com.redis.om.spring.vectorize.FeatureExtractor;
+import com.redis.om.spring.vectorize.Embedder;
 import org.springframework.beans.BeanUtils;
 import org.springframework.data.keyvalue.core.KeyValueOperations;
 import org.springframework.data.keyvalue.repository.query.KeyValuePartTreeQuery;
@@ -42,7 +42,7 @@ public class RedisDocumentRepositoryFactory extends KeyValueRepositoryFactory {
   private final RediSearchIndexer indexer;
   private final GsonBuilder gsonBuilder;
   private final RedisMappingContext mappingContext;
-  private final FeatureExtractor featureExtractor;
+  private final Embedder embedder;
   private final RedisOMProperties properties;
 
   /**
@@ -54,7 +54,7 @@ public class RedisDocumentRepositoryFactory extends KeyValueRepositoryFactory {
    * @param indexer            must not be {@literal null}.
    * @param mappingContext     must not be {@literal null}.
    * @param gsonBuilder        must not be {@literal null}.
-   * @param featureExtractor   must not be {@literal null}.
+   * @param embedder   must not be {@literal null}.
    * @param properties         must not be {@literal null}.
    */
   public RedisDocumentRepositoryFactory( //
@@ -63,7 +63,7 @@ public RedisDocumentRepositoryFactory( //
       RediSearchIndexer indexer, //
       RedisMappingContext mappingContext, //
       GsonBuilder gsonBuilder, //
-      FeatureExtractor featureExtractor, //
+      Embedder embedder, //
       RedisOMProperties properties //
   ) {
     this( //
@@ -73,7 +73,7 @@ public RedisDocumentRepositoryFactory( //
         DEFAULT_QUERY_CREATOR, //
         mappingContext, //
         gsonBuilder, //
-        featureExtractor, //
+        embedder, //
         properties //
     ); //
   }
@@ -96,7 +96,7 @@ public RedisDocumentRepositoryFactory( //
       Class<? extends AbstractQueryCreator<?, ?>> queryCreator, //
       RedisMappingContext mappingContext, //
       GsonBuilder gsonBuilder, //
-      FeatureExtractor featureExtractor, //
+      Embedder embedder, //
       RedisOMProperties properties //
   ) {
     this( //
@@ -107,7 +107,7 @@ public RedisDocumentRepositoryFactory( //
         RediSearchQuery.class, //
         mappingContext, //
         gsonBuilder, //
-        featureExtractor, //
+        embedder, //
         properties //
     );
   }
@@ -123,7 +123,7 @@ public RedisDocumentRepositoryFactory( //
    * @param repositoryQueryType must not be {@literal null}.
    * @param mappingContext      must not be {@literal null}.
    * @param gsonBuilder         must not be {@literal null}.
-   * @param featureExtractor    must not be {@literal null}.
+   * @param embedder    must not be {@literal null}.
    * @param properties          must not be {@literal null}.
    */
   public RedisDocumentRepositoryFactory( //
@@ -134,7 +134,7 @@ public RedisDocumentRepositoryFactory( //
       Class<? extends RepositoryQuery> repositoryQueryType, //
       RedisMappingContext mappingContext, //
       GsonBuilder gsonBuilder, //
-      FeatureExtractor featureExtractor, //
+      Embedder embedder, //
       RedisOMProperties properties //
   ) {
 
@@ -145,7 +145,7 @@ public RedisDocumentRepositoryFactory( //
     Assert.notNull(indexer, "RediSearchIndexer must not be null!");
     Assert.notNull(queryCreator, "Query creator type must not be null!");
     Assert.notNull(repositoryQueryType, "RepositoryQueryType type must not be null!");
-    Assert.notNull(featureExtractor, "FeatureExtractor type must not be null!");
+    Assert.notNull(embedder, "FeatureExtractor type must not be null!");
     Assert.notNull(properties, "RedisOMSpringProperties type must not be null!");
 
     this.keyValueOperations = keyValueOperations;
@@ -155,7 +155,7 @@ public RedisDocumentRepositoryFactory( //
     this.repositoryQueryType = repositoryQueryType;
     this.mappingContext = mappingContext;
     this.gsonBuilder = gsonBuilder;
-    this.featureExtractor = featureExtractor;
+    this.embedder = embedder;
     this.properties = properties;
   }
 
@@ -170,7 +170,7 @@ protected Object getTargetRepository(RepositoryInformation repositoryInformation
         indexer, //
         mappingContext, //
         gsonBuilder, //
-        featureExtractor, //
+        embedder, //
         properties //
     );
   }

diff --git a/.../main/java/com/redis/om/spring/repository/support/RedisDocumentRepositoryFactoryBean.java b/.../main/java/com/redis/om/spring/repository/support/RedisDocumentRepositoryFactoryBean.java
@@ -4,7 +4,7 @@
 import com.redis.om.spring.RedisOMProperties;
 import com.redis.om.spring.indexing.RediSearchIndexer;
 import com.redis.om.spring.ops.RedisModulesOperations;
-import com.redis.om.spring.vectorize.FeatureExtractor;
+import com.redis.om.spring.vectorize.Embedder;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.data.keyvalue.core.KeyValueOperations;
 import org.springframework.data.keyvalue.repository.support.KeyValueRepositoryFactoryBean;
@@ -27,7 +27,7 @@ public class RedisDocumentRepositoryFactoryBean<T extends Repository<S, ID>, S,
   @Autowired
   private GsonBuilder gsonBuilder;
   @Autowired
-  private @Nullable FeatureExtractor featureExtractor;
+  private @Nullable Embedder embedder;
   @Autowired
   private RedisOMProperties properties;
 
@@ -49,7 +49,7 @@ protected final RedisDocumentRepositoryFactory createRepositoryFactory( //
       Class<? extends RepositoryQuery> repositoryQueryType //
   ) {
     return new RedisDocumentRepositoryFactory(operations, rmo, indexer, queryCreator, repositoryQueryType,
-        this.mappingContext, this.gsonBuilder, this.featureExtractor, this.properties);
+        this.mappingContext, this.gsonBuilder, this.embedder, this.properties);
   }
 
   @Override