ask discord

询问discord

大火快速搜索不和谐频道

概述

ask-discord使用户可以通过语义搜索Discord消息的数据集搜索。有两个主要搜索模式：

1. RAW ：根据ANN和余弦相似性显示最相似的消息。
2. LLM ：将原始结果馈入LLM，以生成类似聊天机器人的响应。

入门

先决条件

• Docker
• OpenAI API键
• Milvus 2.4.4
• Python 3.12.3

安装

1. 克隆存储库：

   git clone https://github.com/yourusername/ask-discord.git
   cd ask-discord

2. 安装依赖项：

   pip install -r requirements.txt

3. 设置环境变量：在根目录中创建一个.env文件，并添加您的OpenAI API密钥：

    OPENAI_KEY = your_openai_api_key

4. 启动Milvus ：遵循MILVUS安装指南进行设置并启动Milvus。 （需要最近的Docker安装）

运行应用程序

1. 生成数据：使用Discord聊天出口商下载感兴趣的渠道。如果您难以获取令牌和频道ID，请阅读本指南。这不是认可，因为下载频道可能会违反Discord Tos。

2. 加载数据：确保JSON数据文件处于configs中指定的正确路径中。如果需要，请修改主文件中的路径。

3. 运行简化应用程序：

   streamlit run ask-discord.py

4. 访问应用程序：打开您的Web浏览器，然后访问http://localhost:8501 。

文档

项目文件

• ask-discord.py ：简化应用程序的主要入口点。它初始化了配置，连接到Milvus和OpenAI，并设置数据库和聊天机器人。
• load_data.py ：处理JSON DISCORD数据的加载和处理，并管理Milvus Collection。
• chatbot.py ：包含Chatbot机器人类，该类处理查询米尔弗斯并与RAW/LLM模式进行交互。

配置

配置通过ask-discord.py中的字典进行管理。其中包括：

• OPENAI_CLIENT ：OpenAI客户端实例。
• CHAT_MODEL ：用于聊天的模型（例如， gpt-4o ）。
• EMBEDDING_MODEL ：用于生成嵌入的模型。
• JSON_DATA_PATH ：JSON数据文件的路径。
• EMBEDDING_DIMENSIONS ：矢量尺寸。
• MAX_MESSAGE_LENGTH ：要考虑的消息中的字符数量最大数量。
• MIN_MESSAGE_LENGTH ：要考虑的消息中字符数量的最小数量。
• COLLECTION_NAME ：Milvus Collection的名称。
• MAX_SIMILAR_EXAMPLES ：要检索的类似消息的最大数量。
• SIMILARITY_SCORE_CUTOFF ：相似性得分的截止。

贡献

欢迎捐款！请提交拉动请求或打开问题以讨论任何更改。

执照

该项目已根据MIT许可获得许可。有关更多详细信息，请参见许可证文件。

致谢

• Discord聊天出口商