From 3cdfcae01cc4cd60b383cc2bb0e9569cb137e32b Mon Sep 17 00:00:00 2001 From: jerryjzhang Date: Mon, 11 Dec 2023 18:07:26 +0800 Subject: [PATCH] [improvement][chat]Add javadoc to Mapper related classes --- .../java/com/tencent/supersonic/chat/mapper/BaseMapper.java | 3 --- .../tencent/supersonic/chat/mapper/BaseMatchStrategy.java | 3 --- .../supersonic/chat/mapper/DatabaseMatchStrategy.java | 3 ++- .../com/tencent/supersonic/chat/mapper/EmbeddingMapper.java | 2 +- .../supersonic/chat/mapper/EmbeddingMatchStrategy.java | 3 ++- .../supersonic/chat/mapper/HanlpDictMatchStrategy.java | 4 +++- .../com/tencent/supersonic/chat/mapper/KeywordMapper.java | 5 ++--- .../com/tencent/supersonic/chat/mapper/MapperHelper.java | 4 ---- .../com/tencent/supersonic/chat/mapper/MatchStrategy.java | 3 ++- .../tencent/supersonic/chat/mapper/SearchMatchStrategy.java | 3 ++- 10 files changed, 14 insertions(+), 19 deletions(-) diff --git a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/BaseMapper.java b/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/BaseMapper.java index cdbe54d6b..fe6fe3393 100644 --- a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/BaseMapper.java +++ b/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 { diff --git a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/BaseMatchStrategy.java b/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/BaseMatchStrategy.java index 90cda628d..7d0873738 100644 --- a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/BaseMatchStrategy.java +++ b/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 implements MatchStrategy { diff --git a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/DatabaseMatchStrategy.java b/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/DatabaseMatchStrategy.java index b22f265a7..fa30547cc 100644 --- a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/DatabaseMatchStrategy.java +++ b/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 diff --git a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/EmbeddingMapper.java b/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/EmbeddingMapper.java index fbd722e99..06da3f81f 100644 --- a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/EmbeddingMapper.java +++ b/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 { diff --git a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/EmbeddingMatchStrategy.java b/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/EmbeddingMatchStrategy.java index 739dadeab..c77af9cb8 100644 --- a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/EmbeddingMatchStrategy.java +++ b/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 diff --git a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/HanlpDictMatchStrategy.java b/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/HanlpDictMatchStrategy.java index 61e6a4e7b..8c36490a5 100644 --- a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/HanlpDictMatchStrategy.java +++ b/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 HanLP to + * match schema elements. It currently supports prefix and suffix matching + * against names, values and aliases. */ @Service @Slf4j diff --git a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/KeywordMapper.java b/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/KeywordMapper.java index 55747e325..7c0a384dd 100644 --- a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/KeywordMapper.java +++ b/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. - * It includes two recognition strategies: HanlpDictMatchStrategy and DatabaseMatchStrategy. - * + * A mapper that recognizes schema elements with keyword. + * It leverages two matching strategies: HanlpDictMatchStrategy and DatabaseMatchStrategy. */ @Slf4j public class KeywordMapper extends BaseMapper { diff --git a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/MapperHelper.java b/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/MapperHelper.java index 6908b3fe6..ad7773386 100644 --- a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/MapperHelper.java +++ b/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 diff --git a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/MatchStrategy.java b/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/MatchStrategy.java index 924f0f984..bada43a64 100644 --- a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/MatchStrategy.java +++ b/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 { diff --git a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/SearchMatchStrategy.java b/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/SearchMatchStrategy.java index 88b679463..9cef830c5 100644 --- a/chat/core/src/main/java/com/tencent/supersonic/chat/mapper/SearchMatchStrategy.java +++ b/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 {