Преглед на файлове

feat(Tools): add discord incoming webhook for sending messages (#7852)

ice yao преди 6 месеца
родител
ревизия
415d27c8bf

+ 7 - 0
api/core/tools/provider/builtin/discord/_assets/icon.svg

@@ -0,0 +1,7 @@
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+
<!-- Uploaded to: SVG Repo, www.svgrepo.com, Transformed by: SVG Repo Mixer Tools -->
+<svg width="80px" height="80px" viewBox="0 -28.5 256 256" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" preserveAspectRatio="xMidYMid" fill="#000000">
+
<g id="SVGRepo_bgCarrier" stroke-width="0"/>
+
<g id="SVGRepo_tracerCarrier" stroke-linecap="round" stroke-linejoin="round"/>
+
<g id="SVGRepo_iconCarrier"> <g> <path d="M216.856339,16.5966031 C200.285002,8.84328665 182.566144,3.2084988 164.041564,0 C161.766523,4.11318106 159.108624,9.64549908 157.276099,14.0464379 C137.583995,11.0849896 118.072967,11.0849896 98.7430163,14.0464379 C96.9108417,9.64549908 94.1925838,4.11318106 91.8971895,0 C73.3526068,3.2084988 55.6133949,8.86399117 39.0420583,16.6376612 C5.61752293,67.146514 -3.4433191,116.400813 1.08711069,164.955721 C23.2560196,181.510915 44.7403634,191.567697 65.8621325,198.148576 C71.0772151,190.971126 75.7283628,183.341335 79.7352139,175.300261 C72.104019,172.400575 64.7949724,168.822202 57.8887866,164.667963 C59.7209612,163.310589 61.5131304,161.891452 63.2445898,160.431257 C105.36741,180.133187 151.134928,180.133187 192.754523,160.431257 C194.506336,161.891452 196.298154,163.310589 198.110326,164.667963 C191.183787,168.842556 183.854737,172.420929 176.223542,175.320965 C180.230393,183.341335 184.861538,190.991831 190.096624,198.16893 C211.238746,191.588051 232.743023,181.531619 254.911949,164.955721 C260.227747,108.668201 245.831087,59.8662432 216.856339,16.5966031 Z M85.4738752,135.09489 C72.8290281,135.09489 62.4592217,123.290155 62.4592217,108.914901 C62.4592217,94.5396472 72.607595,82.7145587 85.4738752,82.7145587 C98.3405064,82.7145587 108.709962,94.5189427 108.488529,108.914901 C108.508531,123.290155 98.3405064,135.09489 85.4738752,135.09489 Z M170.525237,135.09489 C157.88039,135.09489 147.510584,123.290155 147.510584,108.914901 C147.510584,94.5396472 157.658606,82.7145587 170.525237,82.7145587 C183.391518,82.7145587 193.761324,94.5189427 193.539891,108.914901 C193.539891,123.290155 183.391518,135.09489 170.525237,135.09489 Z" fill="#5865F2" fill-rule="nonzero"> </path> </g> </g>
+
</svg>

+ 9 - 0
api/core/tools/provider/builtin/discord/discord.py

@@ -0,0 +1,9 @@
+from typing import Any
+
+from core.tools.provider.builtin.discord.tools.discord_webhook import DiscordWebhookTool
+from core.tools.provider.builtin_tool_provider import BuiltinToolProviderController
+
+
+class DiscordProvider(BuiltinToolProviderController):
+    def _validate_credentials(self, credentials: dict[str, Any]) -> None:
+        DiscordWebhookTool()

+ 16 - 0
api/core/tools/provider/builtin/discord/discord.yaml

@@ -0,0 +1,16 @@
+identity:
+  author: Ice Yao
+  name: discord
+  label:
+    en_US: Discord
+    zh_Hans: Discord
+    pt_BR: Discord
+  description:
+    en_US: Discord Webhook
+    zh_Hans: Discord Webhook
+    pt_BR: Discord Webhook
+  icon: icon.svg
+  tags:
+    - social
+    - productivity
+credentials_for_provider:

+ 49 - 0
api/core/tools/provider/builtin/discord/tools/discord_webhook.py

@@ -0,0 +1,49 @@
+from typing import Any, Union
+
+import httpx
+
+from core.tools.entities.tool_entities import ToolInvokeMessage
+from core.tools.tool.builtin_tool import BuiltinTool
+
+
+class DiscordWebhookTool(BuiltinTool):
+    def _invoke(self, user_id: str, tool_parameters: dict[str, Any]
+                ) -> Union[ToolInvokeMessage, list[ToolInvokeMessage]]:
+        """
+            Incoming Webhooks
+            API Document:
+                https://discord.com/developers/docs/resources/webhook#execute-webhook
+        """
+
+        content = tool_parameters.get('content', '')
+        if not content:
+            return self.create_text_message('Invalid parameter content')
+
+        webhook_url = tool_parameters.get('webhook_url', '')
+
+        if not webhook_url.startswith('https://discord.com/api/webhooks/'):
+            return self.create_text_message(
+                f'Invalid parameter webhook_url ${webhook_url}, \
+                    not a valid Discord webhook URL')
+
+        headers = {
+            'Content-Type': 'application/json',
+        }
+        params = {}
+        payload = {
+            "content": content,
+        }
+
+        try:
+            res = httpx.post(webhook_url, headers=headers,
+                             params=params, json=payload)
+            if res.is_success:
+                return self.create_text_message(
+                    "Text message was sent successfully")
+            else:
+                return self.create_text_message(
+                    f"Failed to send the text message, \
+                        status code: {res.status_code}, response: {res.text}")
+        except Exception as e:
+            return self.create_text_message(
+                "Failed to send message through webhook. {}".format(e))

+ 40 - 0
api/core/tools/provider/builtin/discord/tools/discord_webhook.yaml

@@ -0,0 +1,40 @@
+identity:
+  name: discord_webhook
+  author: Ice Yao
+  label:
+    en_US: Incoming Webhook to send message
+    zh_Hans: 通过入站Webhook发送消息
+    pt_BR: Incoming Webhook to send message
+  icon: icon.svg
+description:
+  human:
+    en_US: Sending a message on Discord via the Incoming Webhook
+    zh_Hans: 通过入站Webhook在Discord上发送消息
+    pt_BR: Sending a message on Discord via the Incoming Webhook
+  llm: A tool for sending messages to a chat on Discord.
+parameters:
+  - name: webhook_url
+    type: string
+    required: true
+    label:
+      en_US: Discord Incoming Webhook url
+      zh_Hans: Discord入站Webhook的url
+      pt_BR: Discord Incoming Webhook url
+    human_description:
+      en_US: Discord Incoming Webhook url
+      zh_Hans: Discord入站Webhook的url
+      pt_BR: Discord Incoming Webhook url
+    form: form
+  - name: content
+    type: string
+    required: true
+    label:
+      en_US: content
+      zh_Hans: 消息内容
+      pt_BR: content
+    human_description:
+      en_US: Content to sent to the channel or person.
+      zh_Hans: 消息内容文本
+      pt_BR: Content to sent to the channel or person.
+    llm_description: Content of the message
+    form: llm