koishi-plugin-best-cave 2.1.3 → 2.2.0

package/lib/HashManager.d.ts

@@ -24,20 +24,20 @@ export declare class HashManager {
      */
     registerCommands(cave: any): void;
     /**
-     * @description 检查数据库中所有回声洞，并为没有哈希记录的历史数据生成哈希。
-     * @returns {Promise<string>} 返回一个包含操作结果的报告字符串。
+     * @description 检查数据库中所有回声洞，为没有哈希记录的历史数据生成哈希，并在此之后对所有内容进行相似度检查。
+     * @returns {Promise<string>} 一个包含操作结果的报告字符串。
      */
-    private validateAllCaves;
+    validateAllCaves(): Promise<string>;
     /**
      * @description 将图片切割为4个象限并为每个象限生成pHash。
      * @param imageBuffer - 图片的 Buffer 数据。
-     * @returns {Promise<Set<string>>} 返回一个包含最多4个唯一哈希值的集合。
+     * @returns {Promise<Set<string>>} 一个包含最多4个唯一哈希值的集合。
      */
     generateImageSubHashes(imageBuffer: Buffer): Promise<Set<string>>;
     /**
-     * @description 根据pHash（感知哈希）算法为图片生成哈希值。
-     * @param imageBuffer - 图片的 Buffer 数据。
-     * @returns {Promise<string>} 返回一个64位的二进制哈希字符串。
+     * @description 根据感知哈希（pHash）算法为图片生成哈希。
+     * @param imageBuffer 图片的 Buffer 数据。
+     * @returns 64位二进制哈希字符串。
      */
     generateImagePHash(imageBuffer: Buffer): Promise<string>;
     /**
@@ -48,30 +48,16 @@ export declare class HashManager {
      */
     calculateHammingDistance(hash1: string, hash2: string): number;
     /**
-     * @description 根据汉明距离计算图片pHash的相似度。
+     * @description 根据汉明距离计算图片或文本哈希的相似度。
      * @param hash1 - 第一个哈希字符串。
      * @param hash2 - 第二个哈希字符串。
      * @returns {number} 范围在0到1之间的相似度得分。
      */
-    calculateImageSimilarity(hash1: string, hash2: string): number;
-    /**
-     * @description 将文本分割成指定大小的“瓦片”(shingles)，用于Jaccard相似度计算。
-     * @param text - 输入的文本。
-     * @param size - 每个瓦片的大小，默认为2。
-     * @returns {Set<string>} 包含所有唯一瓦片的集合。
-     */
-    private getShingles;
+    calculateSimilarity(hash1: string, hash2: string): number;
     /**
-     * @description 为文本生成基于Shingling的哈希字符串。
+     * @description 为文本生成基于 Simhash 算法的哈希字符串。
      * @param text - 需要处理的文本。
-     * @returns {string} 由排序后的shingles组成的、用'|'分隔的哈希字符串。
-     */
-    generateTextHash(text: string): string;
-    /**
-     * @description 使用Jaccard相似度系数计算两个文本哈希的相似度。
-     * @param hash1 - 第一个文本哈希。
-     * @param hash2 - 第二个文本哈希。
-     * @returns {number} 范围在0到1之间的相似度得分。
+     * @returns {string} 64位二进制 Simhash 字符串。
      */
-    calculateTextSimilarity(hash1: string, hash2: string): number;
+    generateTextSimhash(text: string): string;
 }