Slack GPT

Slack GPT机器人

该存储库包含一个基于C＃的Slack GPT机器人，该机器人使用OpenAI的GPT模型来回答用户的问题。该实现基于Slack Sockets API，这意味着无需在服务器上托管机器人。该机器人可以在任何机器上运行。

您喜欢这个工具吗？给我们访问:) https://prographers.com/

特征

• 与OpenAI的GPT-4集成以回答问题
• 以螺纹格式维护对话上下文
• 插座模式与Slack集成
• 将长消息拆分为多条消息，并且不会破坏代码块格式
• 控制机器人行为的参数
• Docker支持
• 完整的文档
• 自定义预定义和动态命令
• 上下文，整个线程-context的系统消息

依赖性

• .NET 8.0
• Openai
• Slacknet
• Slacknet.aspnetcore
• Octokit.net
• newtonsoft.net
• 人物
• LitedB

获取OpenAI API键

1. 前往Openai仪表板
2. 单击“创建新的秘密键”按钮。
3. 复制秘密，然后将其放入appsettings.json中的OpenAIKey变量中。

注意：使用OpenAI API需要一个付费/试用帐户。您可以在此处找到有关定价的更多信息。

在Slack中配置权限

在运行Slack GPT机器人之前，您需要为Slack Bot配置适当的权限。请按照以下步骤设置必要的权限：

1. 创建Slack App
2. 转到您的Slack API仪表板，然后单击为此机器人创建的应用程序。
3. 在左侧边栏中，单击“ Oauth＆Permissions”。
4. 在“范围”部分中，您将找到两种类型的范围：“ bot nodken范围”和“用户令牌示波器”。在“机器人令牌范围”下添加以下范围：
   • app_mentions:read ：允许机器人阅读提及事件。
   • chat:write ：允许机器人发送消息。
   • groups:history ：允许机器人在私人渠道中读取消息。
   • channels:history ：允许机器人在公共渠道中读取消息。
   • 请注意，根据机器人的位置，可能需要其他权限。
5. 滚动到“工作区的OAuth令牌”，然后单击“安装应用程序到工作区”按钮。这将产生SlackBotToken 。
6. 在左侧栏中，单击“套接字模式”并启用它。提示您“生成应用程序级令牌以启用套接字模式”。生成一个名为SlackAppToken的令牌并添加connections:write范围。
7. 在“套接字模式”页面的“功能受影响”部分中，单击“事件订阅”，然后切换“启用事件”为“”。将app_mention事件与app_mentions:read在切换的“订阅机器人事件”部分中的范围。

用法

1. 运行项目

dotnet run --project Slack-GPT-Socket

或有关如何托管它的更多信息，请参见#Docker。

2. 邀请机器人进入所需的松弛频道。
3. 在消息中提及机器人并提出问题。机器人将以答案做出回应。您可以继续在同一线程中提及机器人以继续对话。

您可以使用模型的名称启动消息，而没有参数：例如：

@GPT-4 Turbo今天好吗？

将使用GPT-3.5-Turbo而不是默认GPT-4模型。有关更多别名，请参见GPTCLIENT。

内置参数

有一些内置参数。使用/gpt help查看它们。您可以在appsettings.json文件中修改参数，也可以根据请求进行修改。

有关默认值或appsettings.Example.json的更多信息，请参见GPTDEFAULTS.CS。

自定义参数

预定义命令

您可以将自己的自定义参数添加到bot中，以最大程度地减少每个已评估的请求的键入。为此，请将其定义添加到appsettings.json中的GptCommands部分。例如：

 "GptCommands" : {
    "Commands" :  [
      {
        "Command" : " -refactor " ,
        "Description" : " Tells GPT to refactor provided code " ,
        "Prompt" : " Given the following code, refactor it to be more readable and maintainable. Please provide code documentation for all members in the code and comments where appropriate. "
      },
      {
      "Command" : " -prographers " ,
      "Description" : " A command to add infomation about Prographers " ,
      "Prompt" : " Prographers is software-house company that specializes in 3D product configurators. Prographers exists since 2016 and currently hires around 20 people. Prographers solutions focus on Web applications that are used by companies to configure their products. Applications produced are focusing on high-quality graphics and design, resulting in great products that customers awe. Prographers is located in Warsaw, Poland. "
      }
  }

用法：

@gpt -4-编写者您对著作作者有什么了解？

@gpt -4 -refactor public class Foo { public void Bar() { Console.WriteLine("Hello World"); } }

动态命令

以类似的方式，您可以创建动态命令。为此，请调用/gpt commands add -command "prompt" "description" -global命令，带有命令名称和提示。

• -command如何调用此命令。例如： -prographers
• -prompt将用于此命令的提示。例如： Prographers is software-house company...
• -description命令的描述。例如： A command to add infomation about Prographers这是可选的。
• -global标志将使所有用户可用。否则，它将适用于创建它的用户。

使用/gpt commands help查看有关命令的更多信息。

Docker

您可以使用以下命令启动Docker容器：

docker run -v ./appsettings.json:/app/appsettings.json --restart always ghcr.io/prographers/slack-gpt:latest

您也可以使用docker-compose.yml文件来启动脱离的容器。 Docker Compose将自动从GitHub容器注册表中拉出图像，并在发生这种情况时启动容器。它将使用watch望塔来做到这一点。

docker-compose up -d

请记住，将AppSettings.json文件与两种情况的命令相同的目录中。

安全

这两个图像均未在任何端口上暴露，也无法从外部访问。访问容器的唯一方法是通过Slack API。该容器还作为非根用户运行，无法访问主机系统。

限制和提示

• 该机器人将从消息中删除它，因此不会包含在提示中。这是为了防止递归电话。
• 该机器人只会响应从提及开始的消息。
• 在机器人拥有的频道中提到的提及将被忽略。 （将来可能会更改。）必须邀请他进入频道。
• 所有命令都是不敏感的。
• bot只会从以提及开始的消息和他自己的消息来构建一个线程。
• 编辑消息将触发新响应，就像发送新消息一样。
• 在线程中编辑消息时，机器人将响应已编辑的消息。它将忽略编辑消息后所做的任何线程。
• 删除消息是重新进行线程的一种方法。因此，在编辑消息时，更容易跟踪对话。
• 在Slack客户端重新加载后，由机器人生成的短暂消息将消失。您可以在设置中禁用它们。

从源本地运行

• 克隆存储库

git clone https://github.com/Prographers/Slack-GPT.git
cd Slack-GPT

• 还原Nuget软件包

dotnet restore

截屏

通知消息！

---

线程支持！

---

错误消息！