Slack 中的 ChatGPT

:warning: OpenAI 官方的 Slack 集成 (integration) 现已可用！您可能想先尝试一下：https://my.slack.com/marketplace/A097V82EGG2-chatgpt

介绍一款变革性的应用，专为 Slack 用户设计，旨在增强您与 ChatGPT 的沟通！ 此应用通过 Slack 频道实现与 ChatGPT 的无缝交互，利用人工智能技术优化您的规划和写作流程。

您可以通过安装实时演示来发现应用的功能：https://bit.ly/chat-gpt-in-slack。 请注意，该实时演示由 @seratch 个人托管。 对于企业 Slack 工作区，我们强烈建议按照以下指南将应用部署在您自己的基础设施上。

如果您正在寻找在 Slack 下一代托管平台 上运行的示例应用，请查看 https://github.com/seratch/chatgpt-on-deno 🙌

工作原理

您可以像在网站上一样的方式与 ChatGPT 进行交互。

在同一线程中交流时，机器人会记住您已经说过的内容：

考虑这个现实场景：让机器人生成一封用于与管理层沟通的商务邮件：

使用 ChatGPT，您最初不需要提出措辞完美的问题。收到机器人的初始回复后调整细节是一个很好的方法：

这听起来是不是很酷？😎

三种支持的界面

有三种界面可供使用。当您想在 Slack 工作区与他人分享对话时，始终使用频道线程 (threads) 是最佳选择。如果您希望私下使用 ChatGPT，其他界面则更方便。

1. 在频道线程中与机器人交谈
2. 在 1:1 直接消息 (DM) 中与机器人交谈
3. 在您的主页标签页 (Home tab) 发送提示词 (prompts)

在频道线程中与机器人交谈

这是使用此应用最常见的方式。您只需在线程的初始消息中提到机器人，就可以随时开始与 ChatGPT Bot 的对话。在线程内，您不再需要提及机器人：

在 1:1 直接消息 (DM) 中与机器人交谈

您可以使用与机器人的 1:1 直接消息 (DM) 私下寻求帮助。无需提及机器人。直接在 DM 中发送消息即可：

在您的主页标签页发送提示词

在主页标签页上，除了 OpenAI API 密钥 (API key) 和模型配置外，您还可以使用快速校对器和自由提示词发送对话框。这些功能非常便捷，即使从移动设备也可以快速向 OpenAI 发送查询。

以下是主页标签页上的校对示例：

您也可以仅通过向 DALL-E 3 模型提供提示词来生成图像：

若要询问其他问题，您可以改用从头开始的模态窗口 (modal)：

在本地机器上运行应用

要在本地机器上运行此应用，您只需要遵循以下步骤：

• 使用 manifest-dev.yml 文件创建一个新的 Slack 应用
• 将应用安装到您的 Slack 工作区
• 在 https://platform.openai.com/account/api-keys 获取您的 OpenAI API 密钥
• 启动应用

# Create an app-level token with connections:write scope
export SLACK_APP_TOKEN=xapp-1-...
# Install the app into your workspace to grab this token
export SLACK_BOT_TOKEN=xoxb-...
# Visit https://platform.openai.com/account/api-keys for this token
export OPENAI_API_KEY=sk-...

# Optional: gpt-3.5-turbo and newer ones are currently supported (default: gpt-3.5-turbo)
export OPENAI_MODEL=gpt-4o
# Optional: Model temperature between 0 and 2 (default: 1.0)
export OPENAI_TEMPERATURE=1
# Optional: You can adjust the timeout seconds for OpenAI calls (default: 30)
export OPENAI_TIMEOUT_SECONDS=60
# Optional: You can include priming instructions for ChatGPT to fine tune the bot purpose
export OPENAI_SYSTEM_TEXT="You proofread text. When you receive a message, you will check
for mistakes and make suggestion to improve the language of the given text"
# Optional: When the string is "true", this app translates ChatGPT prompts into a user's preferred language (default: true)
export USE_SLACK_LANGUAGE=true
# Optional: Adjust the app's logging level (default: DEBUG)
export SLACK_APP_LOG_LEVEL=INFO
# Optional: When the string is "true", translate between OpenAI markdown and Slack mrkdwn format (default: false)
export TRANSLATE_MARKDOWN=true
# Optional: When the string is "true", perform some basic redaction on prompts sent to OpenAI (default: false)
export REDACTION_ENABLED=true
# Optional: When the string is "true", this app shares image files with OpenAI (default: false)
export IMAGE_FILE_ACCESS_ENABLED=true

# To use Azure OpenAI, set the following optional environment variables according to your environment
# default: None
export OPENAI_API_TYPE=azure
# default: https://api.openai.com/v1
export OPENAI_API_BASE=https://YOUR_RESOURCE_NAME.openai.azure.com
# default: None
export OPENAI_API_VERSION=2023-05-15
# default: None
export OPENAI_DEPLOYMENT_ID=YOUR-DEPLOYMENT-ID

# Experimental: You can try out the Function Calling feature (default: None)
export OPENAI_FUNCTION_CALL_MODULE_NAME=tests.function_call_example

python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
python main.py

使用 .env 进行凭据加载

如果您更喜欢使用 .env 文件来为本地开发加载环境变量 (env variables)，您可以将 .env.example 文件重命名为 .env：

cp .env.example .env

Then, replace the values in .env file with your own API keys and tokens:

OPENAI_API_KEY=sk-your-openai-key
SLACK_BOT_TOKEN=xoxb-your-slack-bot-token
SLACK_APP_TOKEN=xapp-1-your-slack-app-token

为公司工作区运行应用

信息安全是企业的首要任务。

此应用已开源！因此请随意 fork（复刻）它，并将其部署到您管理的基础设施上。完成上述本地开发流程后，您可以使用位于根目录的 Dockerfile（Docker 构建文件）来部署该应用。

Dockerfile 旨在通过 Socket Mode（套接字模式）与 Slack 建立 WebSocket（Web 套接字协议）连接。这意味着无需提供用于与 Slack 通信的公共 URL。

贡献

永远欢迎贡献！:raised_hands: 当您对本项目代码进行修改时，请牢记以下几点：

• 修改应用时，请避免任何可能导致破坏性变更的行为。如果因安全等关键原因必须进行此类更改，请在进行重大修改前在 GitHub Issues 中发起讨论。
• 有机会的话，请编写一些单元测试。特别是当您触及内部工具模块（例如 app/markdown.py 等）并添加/编辑不调用任何 Web API 的代码时，编写测试应该相对容易。
• 提交更改前，请确保运行 ./validate.sh。该脚本会运行 black（代码格式化工具）、flake8 和 pytype（静态代码分析器）。

相关项目

• iwamot/collmbo: @iwamot 的分支项目，除了 OpenAI 外，还通过利用 LiteLLM 支持其他 LLM（大语言模型）提供商。

许可证

MIT 许可证

ChatGPT-in-Slack 快速上手指南

注意：OpenAI 官方已推出 Slack 集成应用，如需快速体验可先尝试 官方版本。本指南适用于需要自定义部署或私有化部署的开发者。

环境准备

• 操作系统：Windows / macOS / Linux
• 运行环境：Python 3.8+
• 依赖工具：Git, pip
• 账号服务：
  • Slack 工作区（Workspace）
  • OpenAI 账户（需配置 API Key）
• 网络要求：确保本地网络可访问 Slack API 及 OpenAI 服务接口（中国大陆用户可能需要配置网络代理）。

安装步骤

1. 创建 Slack 应用

在 Slack 开发者平台创建一个新应用，使用项目提供的 manifest-dev.yml 文件进行配置，并将应用安装到你的工作区。

2. 获取凭证

• OpenAI API Key：前往 OpenAI 控制台 获取。
• Slack 令牌：
  • SLACK_APP_TOKEN：创建具有 connections:write 范围的应用级令牌。
  • SLACK_BOT_TOKEN：安装应用后获取的 Bot 令牌。

3. 配置环境变量

推荐使用 .env 文件加载凭证。在项目根目录复制示例文件并修改内容：

cp .env.example .env

编辑 .env 文件填入你的密钥：

OPENAI_API_KEY=sk-your-openai-key
SLACK_BOT_TOKEN=xoxb-your-slack-bot-token
SLACK_APP_TOKEN=xapp-1-your-slack-app-token

4. 启动应用

创建虚拟环境并安装依赖后运行主程序：

# 创建虚拟环境
python -m venv .venv
source .venv/bin/activate

# 安装依赖
pip install -r requirements.txt

# 启动应用
python main.py

(可选配置)：如需调整模型、温度或启用特定功能，可在启动前设置环境变量，例如：

export OPENAI_MODEL=gpt-4o
export OPENAI_TEMPERATURE=1

基本使用

安装完成后，你可以通过以下三种方式与 ChatGPT 交互：

1. 频道对话线程（推荐）

在 Slack 频道的任意消息线程中提及机器人即可开始对话。一旦在初始消息中提及，后续回复无需再次提及。

示例：在输入框输入 @ChatGPT 帮我写一封给经理的业务邮件

2. 一对一私聊 (DM)

直接与机器人建立私聊会话。无需提及机器人，直接发送消息即可。

适用场景：处理敏感信息或私人咨询。

3. 首页标签页 (Home Tab)

在 Slack 的 Home 标签页中，除了常规对话外，还支持快捷校对和图像生成功能。

• 文本校对：利用内置 Proofreader 功能检查语法错误。
• 图像生成：向 DALL-E 3 模型发送提示词生成图片。
• 高级提问：使用 Modal 模态框发起复杂查询。