SearchGram

搜索语法

SearchGram 是一款 Telegram 机器人，可改善中文、日语和韩语 (CJK) 语言的搜索体验，并提供消息备份功能。

介绍

Telegram 的搜索功能对 CJK 语言的支持很差，因为没有空格来分隔单词。

与此相关的问题几年前就已报告过，但尚未得到解决。

• tdlib/td#1004
• https://bugs.telegram.org/c/724

特征

• 支持短信搜索
• 提供 CJK 语言的拼写错误和模糊搜索
• 支持 GROUP、CHANNEL、PRIVATE、SUPERGROUP 和 BOT 过滤器
• 支持用户名/ID过滤
• 支持照片和文档的标题搜索
• 支持后台无缝同步聊天记录
• 提供分页
• 使用 WebUI 进行搜索

搜索语法

1. 全局搜索：向机器人发送任何消息
2. 聊天类型搜索： -t=GROUP keyword ，支持类型为 ["BOT", "CHANNEL", "GROUP", "PRIVATE", "SUPERGROUP"]
3. 聊天用户搜索： -u=user_id|username keyword
4. 精确匹配： -m=e keyword或直接"keyword"
5. 上述组合： -t=GROUP -u=user_id|username keyword
6. /private [username] keyword : 在私聊中搜索用户名，如果省略用户名，则在所有私聊中搜索。这也适用于所有上述搜索类型。n

命令

/start - Start the bot
/ping - Check if the bot is alive
/help - Show help message and search syntax
/delete - Delete all messages from specific chat
/bot - Search messages from bots
/channel - Search messages from channels
/group - Search messages from groups
/private - Search messages from private chats
/supergroup - Search messages from supergroups

理论

SearchGram 的工作原理是：

1. 允许多个会话，最多 10 个客户端。
2. 创建一个隐藏会话，将所有传入和传出的短信存储到 Meil​​iSearch。
3. 创建另一个机器人来查询MeiliSearch。
4. 返回整个句子以使用 Telegram 的内置搜索功能，该功能已知存在错误。

如果您在运行机器人之前担心聊天记录，

您可以放心，因为 SearchGram 提供了使用配置文件同步聊天历史记录的解决方案。

截图

系统要求

任何可以运行Python 3.8+和MeiliSearch的系统都应该能够运行SearchGram。

最好有更大的内存，这样MeiliSearch可以运行得更快。

如果您的 RAM 有限，您可以设置环境变量MEILI_MAX_INDEXING_MEMORY=800M来限制 Meil​​iSearch 中的 RAM 使用。

有关详细信息，请参阅最大索引内存

安装

注意：由于聊天历史记录应保密，因此我们不提供任何公共机器人。

请按照以下步骤在您自己的服务器上安装 SearchGram。

本指南将向您展示如何使用我们的默认搜索引擎 Meil​​iSearch 安装 SearchGram。

要了解如何在 Docker 中使用不同搜索引擎的 SearchGram，请参考 Docker.md

1. 准备工作

• 下载或克隆此存储库
• 从这里安装Python：https://www.python.org/downloads/
• 从这里安装MeiliSearch：https://github.com/meilisearch/meilisearch
• 从这里申请 APP_ID 和 APP_HASH：https://my.telegram.org/
• 通过联系 https://t.me/BotFather 获取您的机器人令牌。
• 通过联系 https://t.me/blog_update_bot 获取您的用户 ID。

2.修改环境文件

使用您喜欢的编辑器修改config.py ，例如：

 APP_ID = 176552
APP_HASH = "667276jkajhw"
TOKEN = "123456:8hjhad"
MEILI_HOST = "localhost"
OWNER_ID = "2311231"

如果您的网络访问权限有限（例如在中国），则需要设置代理。

 PROXY = { "scheme" : "socks5" , "hostname" : "localhost" , "port" : 1080 }

3. 登录客户端

打开终端（例如 cmd 或 iTerm），导航到保存代码的目录，然后：

python client.py

输入您的电话号码并登录客户端。您可以按Ctrl + C退出。

4.（可选）设置同步ID

看这里

5. 跑吧！

打开两个终端并在每个终端中运行以下命令：

python client.py
python bot.py

6.（可选）迁移

• 为所有数据添加时间戳以便更好地排序python add_timestamp.py

赞助

• 给我买杯咖啡
• 阿夫迪安
• GitHub 赞助商

条纹

如果您想使用 Stripe 向该项目捐款，请单击下面的按钮。

您可以选择最适合您的货币和付款方式。

美元（卡、Apple Pay 和 Google Pay）	瑞典克朗（卡、Apple Pay 和 Google Pay）	人民币（卡、Apple Pay、Google Pay 和支付宝）
美元	瑞典克朗	中国新年

执照

该项目已获得 GNU 通用公共许可证版本 3 的许可。