feat: 添加向量距离FunctionFragmentBuilder实现 (#99)

Author: goten7

hsweb-easy-orm-rdb/src/main/java/org/hswebframework/ezorm/rdb/supports/postgres/PostgresqlSchemaMetadata.java

@@ -54,7 +54,8 @@ public RDBTableMetadata newTable(String name) {
                 column.addFeature(PostgresqlEnumInFragmentBuilder.notIn);
             }
             if (column.getValueCodec() instanceof VectorType) {
-                PostgresqlVectorFragmentBuilder.ALL.values().forEach(column::addFeature);
+                addFeature(new PostgresqlVectorDistanceFunctionFragmentBuilder());
+                PostgresqlVectorDistanceTermFragmentBuilder.ALL.values().forEach(column::addFeature);
             }
         });
         return metadata;

hsweb-easy-orm-rdb/src/main/java/org/hswebframework/ezorm/rdb/supports/postgres/PostgresqlVectorDistanceFunctionFragmentBuilder.java

@@ -0,0 +1,36 @@
+package org.hswebframework.ezorm.rdb.supports.postgres;
+
+import lombok.Getter;
+import org.hswebframework.ezorm.rdb.metadata.RDBColumnMetadata;
+import org.hswebframework.ezorm.rdb.operator.builder.fragments.EmptySqlFragments;
+import org.hswebframework.ezorm.rdb.operator.builder.fragments.PrepareSqlFragments;
+import org.hswebframework.ezorm.rdb.operator.builder.fragments.SqlFragments;
+import org.hswebframework.ezorm.rdb.operator.builder.fragments.function.FunctionFragmentBuilder;
+
+import java.util.Map;
+
+@Getter
+public class PostgresqlVectorDistanceFunctionFragmentBuilder implements FunctionFragmentBuilder {
+
+    public static final String function_id = "vector_distance";
+    public static final String opt_term_type_key = "termType";
+    public static final String opt_vector_value_key = "vectorValue";
+
+    private final String function = function_id;
+
+    private final String name = "向量距离";
+
+    @Override
+    public SqlFragments create(String columnFullName, RDBColumnMetadata metadata, Map<String, Object> opts) {
+        VectorTermType termType = VectorTermType.of(opts.getOrDefault(opt_term_type_key, VectorTermType.vector_ip));
+        Float[] array = VectorType.toFloatArray(opts.get(opt_vector_value_key));
+        if (array == null || termType == null) {
+            return EmptySqlFragments.INSTANCE;
+        }
+
+        String vectorColumn = VectorUtils.getVectorDistanceColumn(columnFullName, termType, array);
+        return PrepareSqlFragments.of(vectorColumn);
+    }
+
+
+}

…res/PostgresqlVectorFragmentBuilder.java …qlVectorDistanceTermFragmentBuilder.javahsweb-easy-orm-rdb/src/main/java/org/hswebframework/ezorm/rdb/supports/postgres/PostgresqlVectorFragmentBuilder.java renamed to hsweb-easy-orm-rdb/src/main/java/org/hswebframework/ezorm/rdb/supports/postgres/PostgresqlVectorDistanceTermFragmentBuilder.java hsweb-easy-orm-rdb/src/main/java/org/hswebframework/ezorm/rdb/supports/postgres/PostgresqlVectorFragmentBuilder.java renamed to hsweb-easy-orm-rdb/src/main/java/org/hswebframework/ezorm/rdb/supports/postgres/PostgresqlVectorDistanceTermFragmentBuilder.java

@@ -10,26 +10,26 @@
 import java.util.HashMap;
 import java.util.Map;
 
-public class PostgresqlVectorFragmentBuilder extends AbstractTermFragmentBuilder {
-    public static final Map<VectorTermType, PostgresqlVectorFragmentBuilder> ALL = new HashMap<>();
+public class PostgresqlVectorDistanceTermFragmentBuilder extends AbstractTermFragmentBuilder {
+    public static final Map<VectorTermType, PostgresqlVectorDistanceTermFragmentBuilder> ALL = new HashMap<>();
 
     static {
         for (VectorTermType value : VectorTermType.values()) {
-            ALL.put(value, new PostgresqlVectorFragmentBuilder(value));
+            ALL.put(value, new PostgresqlVectorDistanceTermFragmentBuilder(value));
         }
     }
 
     private final VectorTermType type;
 
-    public PostgresqlVectorFragmentBuilder(VectorTermType type) {
-        super(type.name(), "向量查询");
+    public PostgresqlVectorDistanceTermFragmentBuilder(VectorTermType type) {
+        super(type.name(), "向量距离查询");
         this.type = type;
     }
 
     @Override
     public SqlFragments createFragments(String columnFullName, RDBColumnMetadata column, Term term) {
         VectorQueryParam vectorTerm = VectorQueryParam.of(term.getValue());
-        String vectorColumn = VectorUtils.getVectorColumn(columnFullName, type, vectorTerm.getVector());
+        String vectorColumn = VectorUtils.getVectorDistanceColumn(columnFullName, type, vectorTerm.getVector());
         return createTermFragments(column, vectorColumn, vectorTerm.getTerm(type, term.getColumn()));
     }
 

hsweb-easy-orm-rdb/src/main/java/org/hswebframework/ezorm/rdb/supports/postgres/VectorTermType.java

@@ -2,6 +2,7 @@
 
 import lombok.AllArgsConstructor;
 import lombok.Getter;
+import reactor.util.annotation.Nullable;
 
 @Getter
 @AllArgsConstructor
@@ -45,9 +46,20 @@ public Float toSqlValue(int alpha, Float value) {
     /**
      * 将统一 distance（0~1）转换为 SQL 条件值
      *
-     * @param alpha 该l2模型距离分布的中位数
+     * @param alpha    该l2模型距离分布的中位数
      * @param distance 距离 （0~1） 0最相似
      * @return 值
      */
     public abstract Float toSqlValue(int alpha, Float distance);
+
+    @Nullable
+    public static VectorTermType of(Object value) {
+        if (value instanceof VectorTermType) {
+            return (VectorTermType) value;
+        }
+        if (value instanceof String) {
+            return VectorTermType.valueOf((String) value);
+        }
+        return null;
+    }
 }

hsweb-easy-orm-rdb/src/main/java/org/hswebframework/ezorm/rdb/supports/postgres/VectorType.java

@@ -9,6 +9,7 @@
 import org.hswebframework.ezorm.rdb.metadata.RDBColumnMetadata;
 import org.hswebframework.ezorm.rdb.metadata.dialect.DataTypeBuilder;
 import org.postgresql.util.PGobject;
+import reactor.util.annotation.Nullable;
 
 import java.lang.reflect.Array;
 import java.math.BigDecimal;
@@ -64,9 +65,6 @@ private Float[] toFloat(Object data) {
         if (data == null) {
             return null;
         }
-        if (data instanceof Float[] values) {
-            return values;
-        }
         if (data instanceof Vector vector) {
             return toFloatArray(vector.getVector());
         }
@@ -76,6 +74,7 @@ private Float[] toFloat(Object data) {
         return toFloatArray(data);
     }
 
+    @Nullable
     public static Float[] toFloatArray(Object value) {
         if (value == null) {
             return null;

hsweb-easy-orm-rdb/src/main/java/org/hswebframework/ezorm/rdb/supports/postgres/VectorUtils.java

@@ -16,7 +16,7 @@ public class VectorUtils {
      * @param vector         目标向量值
      * @return 向量距离计算字段
      */
-    public static String getVectorColumn(String columnFullName, VectorTermType type, Float[] vector) {
+    public static String getVectorDistanceColumn(String columnFullName, VectorTermType type, Float[] vector) {
         return PrepareSqlFragments
             .of(columnFullName)
             .addSql(type.getOperation(),"?")