[improvement][chat]Add javadoc to Mapper related classes

chat/core/src/main/java/com/tencent/supersonic/chat/mapper/BaseMapper.java

@@ -19,9 +19,6 @@ import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.beans.BeanUtils;
 
-/**
- * base Mapper
- */
 @Slf4j
 public abstract class BaseMapper implements SchemaMapper {
 

chat/core/src/main/java/com/tencent/supersonic/chat/mapper/BaseMatchStrategy.java

@@ -19,9 +19,6 @@ import org.apache.commons.lang3.StringUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
-/**
- * Base Match Strategy
- */
 @Service
 @Slf4j
 public abstract class BaseMatchStrategy<T> implements MatchStrategy<T> {

chat/core/src/main/java/com/tencent/supersonic/chat/mapper/DatabaseMatchStrategy.java

@@ -22,7 +22,8 @@ import org.springframework.stereotype.Service;
 import org.springframework.util.CollectionUtils;
 
 /**
- * Fuzzy Name Match Strategy
+ * DatabaseMatchStrategy uses SQL LIKE operator to match schema elements.
+ * It currently supports fuzzy matching against names and aliases.
  */
 @Service
 @Slf4j

chat/core/src/main/java/com/tencent/supersonic/chat/mapper/EmbeddingMapper.java

@@ -15,7 +15,7 @@ import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
 
 /***
- * A mapper that recognize elements through embedding.
+ * A mapper that recognizes schema elements with vector embedding.
  */
 @Slf4j
 public class EmbeddingMapper extends BaseMapper {

chat/core/src/main/java/com/tencent/supersonic/chat/mapper/EmbeddingMatchStrategy.java

@@ -25,7 +25,8 @@ import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
 /**
- * match strategy implement
+ * EmbeddingMatchStrategy uses vector database to perform
+ * similarity search against the embeddings of schema elements.
  */
 @Service
 @Slf4j

chat/core/src/main/java/com/tencent/supersonic/chat/mapper/HanlpDictMatchStrategy.java

@@ -21,7 +21,9 @@ import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
 /**
- * match strategy implement
+ * HanlpDictMatchStrategy uses <a href="https://www.hanlp.com/">HanLP</a> to
+ * match schema elements. It currently supports prefix and suffix matching
+ * against names, values and aliases.
  */
 @Service
 @Slf4j

chat/core/src/main/java/com/tencent/supersonic/chat/mapper/KeywordMapper.java

@@ -21,9 +21,8 @@ import lombok.extern.slf4j.Slf4j;
 import org.springframework.util.CollectionUtils;
 
 /***
- * A mapper that recognize elements through keyword.
+ * A mapper that recognizes schema elements with keyword.
- * It includes two recognition strategies: HanlpDictMatchStrategy and DatabaseMatchStrategy.
+ * It leverages two matching strategies: HanlpDictMatchStrategy and DatabaseMatchStrategy.
- *
  */
 @Slf4j
 public class KeywordMapper extends BaseMapper {

chat/core/src/main/java/com/tencent/supersonic/chat/mapper/MapperHelper.java

@@ -19,10 +19,6 @@ import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
-/**
- * Mapper helper
- */
-
 @Data
 @Service
 @Slf4j

chat/core/src/main/java/com/tencent/supersonic/chat/mapper/MatchStrategy.java

@@ -7,7 +7,8 @@ import java.util.Map;
 import java.util.Set;
 
 /**
- * match strategy
+ * MatchStrategy encapsulates a concrete matching algorithm
+ * executed during query or search process.
  */
 public interface MatchStrategy<T> {
 

chat/core/src/main/java/com/tencent/supersonic/chat/mapper/SearchMatchStrategy.java

@@ -18,7 +18,8 @@ import org.apache.commons.lang3.StringUtils;
 import org.springframework.stereotype.Service;
 
 /**
- * match strategy implement
+ * SearchMatchStrategy encapsulates a concrete matching algorithm
+ * executed during search process.
  */
 @Service
 public class SearchMatchStrategy extends BaseMatchStrategy<HanlpMapResult> {