diff --git a/auth/api/src/main/java/com/tencent/supersonic/auth/api/authentication/adaptor/UserAdaptor.java b/auth/api/src/main/java/com/tencent/supersonic/auth/api/authentication/adaptor/UserAdaptor.java index 33c4cbe6a..f9254640c 100644 --- a/auth/api/src/main/java/com/tencent/supersonic/auth/api/authentication/adaptor/UserAdaptor.java +++ b/auth/api/src/main/java/com/tencent/supersonic/auth/api/authentication/adaptor/UserAdaptor.java @@ -7,6 +7,9 @@ import com.tencent.supersonic.auth.api.authentication.request.UserReq; import java.util.List; import java.util.Set; +/** + * UserAdaptor defines some interfaces for obtaining user and organization information + */ public interface UserAdaptor { List getUserNames(); diff --git a/auth/authentication/src/main/java/com/tencent/supersonic/auth/authentication/adaptor/DefaultUserAdaptor.java b/auth/authentication/src/main/java/com/tencent/supersonic/auth/authentication/adaptor/DefaultUserAdaptor.java index 9d5893343..81bf282e0 100644 --- a/auth/authentication/src/main/java/com/tencent/supersonic/auth/authentication/adaptor/DefaultUserAdaptor.java +++ b/auth/authentication/src/main/java/com/tencent/supersonic/auth/authentication/adaptor/DefaultUserAdaptor.java @@ -16,6 +16,9 @@ import java.util.List; import java.util.Set; import java.util.stream.Collectors; +/** + * DefaultUserAdaptor provides a default method to obtain user and organization information + */ public class DefaultUserAdaptor implements UserAdaptor { private List getUserDOList() { diff --git a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/ModelClusterMapper.java b/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/ModelClusterMapper.java index 596eb47ae..f00abbb21 100644 --- a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/ModelClusterMapper.java +++ b/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/ModelClusterMapper.java @@ -19,7 +19,9 @@ import java.util.Set; import java.util.stream.Collectors; /*** - * A mapper that forms a cluster from connectable models + * ModelClusterMapper build a cluster from + * connectable data models based on model-rela configuration + * and generate SchemaModelClusterMapInfo */ public class ModelClusterMapper implements SchemaMapper { diff --git a/chat/core/src/main/java/com/tencent/supersonic/chat/parser/QueryTypeParser.java b/chat/core/src/main/java/com/tencent/supersonic/chat/parser/QueryTypeParser.java index 348ff54c8..e351c8066 100644 --- a/chat/core/src/main/java/com/tencent/supersonic/chat/parser/QueryTypeParser.java +++ b/chat/core/src/main/java/com/tencent/supersonic/chat/parser/QueryTypeParser.java @@ -26,7 +26,7 @@ import java.util.Set; import java.util.stream.Collectors; /** - * QueryTypeParser resolves query type as either METRIC or TAG, or OTHER. + * QueryTypeParser resolves query type as either METRIC or TAG, or ID. */ @Slf4j public class QueryTypeParser implements SemanticParser { diff --git a/chat/core/src/main/java/com/tencent/supersonic/chat/parser/plugin/PluginParser.java b/chat/core/src/main/java/com/tencent/supersonic/chat/parser/plugin/PluginParser.java index 61581c5db..51d0109e5 100644 --- a/chat/core/src/main/java/com/tencent/supersonic/chat/parser/plugin/PluginParser.java +++ b/chat/core/src/main/java/com/tencent/supersonic/chat/parser/plugin/PluginParser.java @@ -27,6 +27,10 @@ import java.util.List; import java.util.Map; import java.util.Set; + +/** + * PluginParser defines the basic process and common methods for recalling plugins. + */ public abstract class PluginParser implements SemanticParser { @Override diff --git a/chat/core/src/main/java/com/tencent/supersonic/chat/parser/plugin/embedding/EmbeddingRecallParser.java b/chat/core/src/main/java/com/tencent/supersonic/chat/parser/plugin/embedding/EmbeddingRecallParser.java index 36a40378e..c5fd712c7 100644 --- a/chat/core/src/main/java/com/tencent/supersonic/chat/parser/plugin/embedding/EmbeddingRecallParser.java +++ b/chat/core/src/main/java/com/tencent/supersonic/chat/parser/plugin/embedding/EmbeddingRecallParser.java @@ -13,16 +13,20 @@ import com.tencent.supersonic.common.config.EmbeddingConfig; import com.tencent.supersonic.common.util.ContextUtils; import com.tencent.supersonic.common.util.embedding.Retrieval; import com.tencent.supersonic.common.util.embedding.RetrieveQueryResult; -import java.util.Comparator; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.stream.Collectors; import lombok.extern.slf4j.Slf4j; import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.tuple.Pair; import org.springframework.util.CollectionUtils; +import java.util.Comparator; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.stream.Collectors; + +/** + * EmbeddingRecallParser is an implementation of a recall plugin based on Embedding + */ @Slf4j public class EmbeddingRecallParser extends PluginParser { diff --git a/chat/core/src/main/java/com/tencent/supersonic/chat/parser/plugin/function/FunctionCallParser.java b/chat/core/src/main/java/com/tencent/supersonic/chat/parser/plugin/function/FunctionCallParser.java index ebbbe469d..f0a45a32d 100644 --- a/chat/core/src/main/java/com/tencent/supersonic/chat/parser/plugin/function/FunctionCallParser.java +++ b/chat/core/src/main/java/com/tencent/supersonic/chat/parser/plugin/function/FunctionCallParser.java @@ -13,16 +13,20 @@ import com.tencent.supersonic.chat.service.PluginService; import com.tencent.supersonic.chat.utils.ComponentFactory; import com.tencent.supersonic.common.util.ContextUtils; import com.tencent.supersonic.common.util.JsonUtil; -import java.util.List; -import java.util.Objects; -import java.util.Optional; -import java.util.Set; -import java.util.stream.Collectors; import lombok.extern.slf4j.Slf4j; import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.tuple.Pair; import org.springframework.util.CollectionUtils; +import java.util.List; +import java.util.Objects; +import java.util.Optional; +import java.util.Set; +import java.util.stream.Collectors; + +/** + * FunctionCallParser is an implementation of a recall plugin based on FunctionCall + */ @Slf4j public class FunctionCallParser extends PluginParser { diff --git a/chat/core/src/main/java/com/tencent/supersonic/chat/processor/execute/DimensionRecommendProcessor.java b/chat/core/src/main/java/com/tencent/supersonic/chat/processor/execute/DimensionRecommendProcessor.java index 8a89650c8..974f48381 100644 --- a/chat/core/src/main/java/com/tencent/supersonic/chat/processor/execute/DimensionRecommendProcessor.java +++ b/chat/core/src/main/java/com/tencent/supersonic/chat/processor/execute/DimensionRecommendProcessor.java @@ -20,7 +20,8 @@ import java.util.Set; import java.util.stream.Collectors; /** - * DimensionRecommendProcessor obtains metric recommended dimensions + * DimensionRecommendProcessor recommend some dimensions + * related to metrics based on configuration */ public class DimensionRecommendProcessor implements ExecuteResultProcessor { diff --git a/chat/core/src/main/java/com/tencent/supersonic/chat/processor/execute/SimilarMetricProcessor.java b/chat/core/src/main/java/com/tencent/supersonic/chat/processor/execute/MetricRecommendProcessor.java similarity index 95% rename from chat/core/src/main/java/com/tencent/supersonic/chat/processor/execute/SimilarMetricProcessor.java rename to chat/core/src/main/java/com/tencent/supersonic/chat/processor/execute/MetricRecommendProcessor.java index 5f593231d..4a47a8373 100644 --- a/chat/core/src/main/java/com/tencent/supersonic/chat/processor/execute/SimilarMetricProcessor.java +++ b/chat/core/src/main/java/com/tencent/supersonic/chat/processor/execute/MetricRecommendProcessor.java @@ -24,9 +24,9 @@ import java.util.Set; import java.util.stream.Collectors; /** - * SimilarMetricQueryResponder fills recommended metrics based on embedding similarity. + * MetricRecommendProcessor fills recommended metrics based on embedding similarity. */ -public class SimilarMetricProcessor implements ExecuteResultProcessor { +public class MetricRecommendProcessor implements ExecuteResultProcessor { private static final int METRIC_RECOMMEND_SIZE = 5; diff --git a/chat/core/src/main/java/com/tencent/supersonic/chat/processor/parse/SimilarQueryProcessor.java b/chat/core/src/main/java/com/tencent/supersonic/chat/processor/parse/QueryRecommendProcessor.java similarity index 96% rename from chat/core/src/main/java/com/tencent/supersonic/chat/processor/parse/SimilarQueryProcessor.java rename to chat/core/src/main/java/com/tencent/supersonic/chat/processor/parse/QueryRecommendProcessor.java index 06c917f35..dd5625b7d 100644 --- a/chat/core/src/main/java/com/tencent/supersonic/chat/processor/parse/SimilarQueryProcessor.java +++ b/chat/core/src/main/java/com/tencent/supersonic/chat/processor/parse/QueryRecommendProcessor.java @@ -22,8 +22,11 @@ import java.util.Set; import java.util.concurrent.CompletableFuture; import java.util.stream.Collectors; +/** + * MetricRecommendProcessor fills recommended query based on embedding similarity. + */ @Slf4j -public class SimilarQueryProcessor implements ParseResultProcessor { +public class QueryRecommendProcessor implements ParseResultProcessor { @Override public void process(ParseResp parseResp, QueryContext queryContext, ChatContext chatContext) { diff --git a/launchers/chat/src/main/resources/META-INF/spring.factories b/launchers/chat/src/main/resources/META-INF/spring.factories index 5f535b7e9..a2c86adb8 100644 --- a/launchers/chat/src/main/resources/META-INF/spring.factories +++ b/launchers/chat/src/main/resources/META-INF/spring.factories @@ -40,4 +40,4 @@ com.tencent.supersonic.chat.postprocessor.PostProcessor=\ com.tencent.supersonic.chat.postprocessor.RespBuildPostProcessor com.tencent.supersonic.chat.processor.execute.ExecuteResultProcessor=\ - com.tencent.supersonic.chat.processor.execute.SimilarMetricProcessor \ No newline at end of file + com.tencent.supersonic.chat.processor.execute.MetricRecommendProcessor \ No newline at end of file diff --git a/launchers/standalone/src/main/resources/META-INF/spring.factories b/launchers/standalone/src/main/resources/META-INF/spring.factories index c36956023..34d5cc68d 100644 --- a/launchers/standalone/src/main/resources/META-INF/spring.factories +++ b/launchers/standalone/src/main/resources/META-INF/spring.factories @@ -28,7 +28,7 @@ com.tencent.supersonic.chat.processor.parse.ParseResultProcessor=\ com.tencent.supersonic.chat.processor.parse.SqlInfoProcessor, \ com.tencent.supersonic.chat.processor.parse.TimeCostProcessor, \ com.tencent.supersonic.chat.processor.parse.RespBuildProcessor, \ - com.tencent.supersonic.chat.processor.parse.SimilarQueryProcessor + com.tencent.supersonic.chat.processor.parse.QueryRecommendProcessor com.tencent.supersonic.chat.api.component.SemanticInterpreter=\ com.tencent.supersonic.knowledge.semantic.LocalSemanticInterpreter @@ -43,7 +43,7 @@ com.tencent.supersonic.auth.api.authentication.adaptor.UserAdaptor=\ com.tencent.supersonic.auth.authentication.adaptor.DefaultUserAdaptor com.tencent.supersonic.chat.processor.execute.ExecuteResultProcessor=\ - com.tencent.supersonic.chat.processor.execute.SimilarMetricProcessor,\ + com.tencent.supersonic.chat.processor.execute.MetricRecommendProcessor,\ com.tencent.supersonic.chat.processor.execute.DimensionRecommendProcessor com.tencent.supersonic.common.util.embedding.S2EmbeddingStore=\ diff --git a/launchers/standalone/src/test/resources/META-INF/spring.factories b/launchers/standalone/src/test/resources/META-INF/spring.factories index 5548aed41..a806c5383 100644 --- a/launchers/standalone/src/test/resources/META-INF/spring.factories +++ b/launchers/standalone/src/test/resources/META-INF/spring.factories @@ -42,7 +42,7 @@ com.tencent.supersonic.chat.postprocessor.PostProcessor=\ com.tencent.supersonic.chat.processor.execute.ExecuteResultProcessor=\ - com.tencent.supersonic.chat.processor.execute.SimilarMetricProcessor + com.tencent.supersonic.chat.processor.execute.MetricRecommendProcessor com.tencent.supersonic.common.util.embedding.S2EmbeddingStore=\