(improvement)(common) Add description for sys parameter (#407)

Co-authored-by: jolunoluo

chat/core/src/main/java/com/tencent/supersonic/chat/responder/execute/SimilarMetricExecuteResponder.java

@@ -6,6 +6,7 @@ import com.tencent.supersonic.chat.api.pojo.SchemaElementType;
 import com.tencent.supersonic.chat.api.pojo.SemanticParseInfo;
 import com.tencent.supersonic.chat.api.pojo.request.ExecuteQueryReq;
 import com.tencent.supersonic.chat.api.pojo.response.QueryResult;
+import com.tencent.supersonic.common.pojo.QueryType;
 import com.tencent.supersonic.common.util.ContextUtils;
 import com.tencent.supersonic.common.util.embedding.EmbeddingUtils;
 import com.tencent.supersonic.common.util.embedding.Retrieval;
@@ -31,7 +32,8 @@ public class SimilarMetricExecuteResponder implements ExecuteResponder {
     }
 
     private void fillSimilarMetric(SemanticParseInfo parseInfo) {
-        if (CollectionUtils.isEmpty(parseInfo.getMetrics()) || parseInfo.getMetrics().size() >= METRIC_RECOMMEND_SIZE) {
+        if (!parseInfo.getQueryType().equals(QueryType.METRIC)
+                && parseInfo.getMetrics().size() > METRIC_RECOMMEND_SIZE) {
             return;
         }
         List<String> metricNames = Collections.singletonList(parseInfo.getMetrics().iterator().next().getName());

chat/core/src/main/java/com/tencent/supersonic/chat/service/impl/QueryServiceImpl.java

@@ -164,7 +164,7 @@ public class QueryServiceImpl implements QueryService {
                     .type(CostType.POSTPROCESSOR.getType()).build());
         });
 
-        //6. responders
+        //6. responder
         parseResponders.forEach(parseResponder -> {
             long startTime = System.currentTimeMillis();
             parseResponder.fillResponse(parseResult, queryCtx, chatCtx);

common/src/main/java/com/tencent/supersonic/common/pojo/Parameter.java

@@ -12,6 +12,7 @@ public class Parameter {
     private String name;
     private String value;
     private String comment;
+    private String description;
     private String dataType;
     private String module;
     private List<Object> candidateValues;
@@ -24,4 +25,13 @@ public class Parameter {
         this.module = module;
     }
 
+    public Parameter(String name, String value, String comment, String description, String dataType, String module) {
+        this.name = name;
+        this.value = value;
+        this.comment = comment;
+        this.description = description;
+        this.dataType = dataType;
+        this.module = module;
+    }
+
 }

common/src/main/java/com/tencent/supersonic/common/pojo/SysParameter.java

@@ -1,13 +1,13 @@
 package com.tencent.supersonic.common.pojo;
 
 import com.google.common.collect.Lists;
+import lombok.Data;
+import org.apache.commons.lang3.StringUtils;
+import org.springframework.util.CollectionUtils;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Map;
 import java.util.stream.Collectors;
-import lombok.Data;
-import org.apache.commons.lang3.StringUtils;
-import org.springframework.util.CollectionUtils;
 
 @Data
 public class SysParameter {
@@ -50,7 +50,7 @@ public class SysParameter {
                 "模型名称", "list", "大语言模型相关配置");
         parameter.setCandidateValues(Lists.newArrayList("gpt3.5", "gpt3.5-16k"));
         parameters.add(parameter);
-        parameters.add(new Parameter("llm.api.key", "sk-afdasdasd",
+        parameters.add(new Parameter("llm.api.key", "sk-secret",
                 "模型密钥", "string", "大语言模型相关配置"));
         parameters.add(new Parameter("llm.temperature", "0.0",
                 "温度值", "number", "大语言模型相关配置"));
@@ -89,11 +89,13 @@ public class SysParameter {
 
         //skip config
         parameters.add(new Parameter("query.text.length.threshold", "10",
-                "文本长短阈值", "number", "是否跳过当前parser相关配置"));
+                "文本长短阈值", "文本超过该阈值为长文本", "number", "是否跳过当前parser相关配置"));
-        parameters.add(new Parameter("short.text.threshold", "5",
+        parameters.add(new Parameter("short.text.threshold", "0.5",
-                "短文本匹配阈值", "number", "是否跳过当前parser相关配置"));
+                "短文本匹配阈值", "如果是短文本, 若query得分/文本长度>该阈值, 则跳过当前parser",
+                "number", "是否跳过当前parser相关配置"));
         parameters.add(new Parameter("long.text.threshold", "0.8",
-                "长文本匹配阈值", "number", "是否跳过当前parser相关配置"));
+                "长文本匹配阈值", "如果是长文本, 若query得分/文本长度>该阈值, 则跳过当前parser",
+                "number", "是否跳过当前parser相关配置"));
     }
 
 }