feat(Tools): add feishu tools (#8800)

Co-authored-by: 黎斌 <libin.23@bytedance.com>
2024-09-27 17:31:45 +08:00
parent 0603359e2d
commit c828a5dfdf
71 changed files with 2755 additions and 132 deletions
--- a/api/core/tools/utils/feishu_api_utils.py
+++ b/api/core/tools/utils/feishu_api_utils.py
@@ -1,9 +1,23 @@
 import httpx

+from core.tools.errors import ToolProviderCredentialValidationError
 from extensions.ext_redis import redis_client


+def auth(credentials):
+    app_id = credentials.get("app_id")
+    app_secret = credentials.get("app_secret")
+    if not app_id or not app_secret:
+        raise ToolProviderCredentialValidationError("app_id and app_secret is required")
+    try:
+        assert FeishuRequest(app_id, app_secret).tenant_access_token is not None
+    except Exception as e:
+        raise ToolProviderCredentialValidationError(str(e))
+
+
 class FeishuRequest:
+    API_BASE_URL = "https://lark-plugin-api.solutionsuite.cn/lark-plugin"
+
    def __init__(self, app_id: str, app_secret: str):
        self.app_id = app_id
        self.app_secret = app_secret
@@ -42,7 +56,7 @@ class FeishuRequest:
            "expire": 7200
        }
        """
-        url = "https://lark-plugin-api.solutionsuite.cn/lark-plugin/access_token/get_tenant_access_token"
+        url = f"{self.API_BASE_URL}/access_token/get_tenant_access_token"
        payload = {"app_id": app_id, "app_secret": app_secret}
        res = self._send_request(url, require_token=False, payload=payload)
        return res
@@ -63,7 +77,7 @@ class FeishuRequest:
            "msg": "创建飞书文档成功，请查看"
        }
        """
-        url = "https://lark-plugin-api.solutionsuite.cn/lark-plugin/document/create_document"
+        url = f"{self.API_BASE_URL}/document/create_document"
        payload = {
            "title": title,
            "content": content,
@@ -72,13 +86,13 @@ class FeishuRequest:
        res = self._send_request(url, payload=payload)
        return res.get("data")

-    def write_document(self, document_id: str, content: str, position: str = "start") -> dict:
-        url = "https://lark-plugin-api.solutionsuite.cn/lark-plugin/document/write_document"
+    def write_document(self, document_id: str, content: str, position: str = "end") -> dict:
+        url = f"{self.API_BASE_URL}/document/write_document"
        payload = {"document_id": document_id, "content": content, "position": position}
        res = self._send_request(url, payload=payload)
        return res

-    def get_document_content(self, document_id: str, mode: str, lang: int = 0) -> dict:
+    def get_document_content(self, document_id: str, mode: str = "markdown", lang: str = "0") -> dict:
        """
        API url: https://open.larkoffice.com/document/server-docs/docs/docs/docx-v1/document/raw_content
        Example Response:
@@ -95,45 +109,404 @@ class FeishuRequest:
            "mode": mode,
            "lang": lang,
        }
-        url = "https://lark-plugin-api.solutionsuite.cn/lark-plugin/document/get_document_content"
-        res = self._send_request(url, method="get", params=params)
+        url = f"{self.API_BASE_URL}/document/get_document_content"
+        res = self._send_request(url, method="GET", params=params)
        return res.get("data").get("content")

-    def list_document_blocks(self, document_id: str, page_token: str, page_size: int = 500) -> dict:
+    def list_document_blocks(
+        self, document_id: str, page_token: str, user_id_type: str = "open_id", page_size: int = 500
+    ) -> dict:
        """
        API url: https://open.larkoffice.com/document/server-docs/docs/docs/docx-v1/document/list
        """
-        url = "https://lark-plugin-api.solutionsuite.cn/lark-plugin/document/list_document_blocks"
        params = {
+            "user_id_type": user_id_type,
            "document_id": document_id,
            "page_size": page_size,
            "page_token": page_token,
        }
-        res = self._send_request(url, method="get", params=params)
+        url = f"{self.API_BASE_URL}/document/list_document_blocks"
+        res = self._send_request(url, method="GET", params=params)
        return res.get("data")

    def send_bot_message(self, receive_id_type: str, receive_id: str, msg_type: str, content: str) -> dict:
        """
        API url: https://open.larkoffice.com/document/server-docs/im-v1/message/create
        """
-        url = "https://lark-plugin-api.solutionsuite.cn/lark-plugin/message/send_bot_message"
+        url = f"{self.API_BASE_URL}/message/send_bot_message"
        params = {
            "receive_id_type": receive_id_type,
        }
        payload = {
            "receive_id": receive_id,
            "msg_type": msg_type,
-            "content": content,
+            "content": content.strip('"').replace(r"\"", '"').replace(r"\\", "\\"),
        }
        res = self._send_request(url, params=params, payload=payload)
        return res.get("data")

    def send_webhook_message(self, webhook: str, msg_type: str, content: str) -> dict:
-        url = "https://lark-plugin-api.solutionsuite.cn/lark-plugin/message/send_webhook_message"
+        url = f"{self.API_BASE_URL}/message/send_webhook_message"
        payload = {
            "webhook": webhook,
            "msg_type": msg_type,
-            "content": content,
+            "content": content.strip('"').replace(r"\"", '"').replace(r"\\", "\\"),
        }
        res = self._send_request(url, require_token=False, payload=payload)
        return res
+
+    def get_chat_messages(
+        self,
+        container_id: str,
+        start_time: str,
+        end_time: str,
+        page_token: str,
+        sort_type: str = "ByCreateTimeAsc",
+        page_size: int = 20,
+    ) -> dict:
+        """
+        API url: https://open.larkoffice.com/document/server-docs/im-v1/message/list
+        """
+        url = f"{self.API_BASE_URL}/message/get_chat_messages"
+        params = {
+            "container_id": container_id,
+            "start_time": start_time,
+            "end_time": end_time,
+            "sort_type": sort_type,
+            "page_token": page_token,
+            "page_size": page_size,
+        }
+        res = self._send_request(url, method="GET", params=params)
+        return res.get("data")
+
+    def get_thread_messages(
+        self, container_id: str, page_token: str, sort_type: str = "ByCreateTimeAsc", page_size: int = 20
+    ) -> dict:
+        """
+        API url: https://open.larkoffice.com/document/server-docs/im-v1/message/list
+        """
+        url = f"{self.API_BASE_URL}/message/get_thread_messages"
+        params = {
+            "container_id": container_id,
+            "sort_type": sort_type,
+            "page_token": page_token,
+            "page_size": page_size,
+        }
+        res = self._send_request(url, method="GET", params=params)
+        return res.get("data")
+
+    def create_task(self, summary: str, start_time: str, end_time: str, completed_time: str, description: str) -> dict:
+        # 创建任务
+        url = f"{self.API_BASE_URL}/task/create_task"
+        payload = {
+            "summary": summary,
+            "start_time": start_time,
+            "end_time": end_time,
+            "completed_at": completed_time,
+            "description": description,
+        }
+        res = self._send_request(url, payload=payload)
+        return res.get("data")
+
+    def update_task(
+        self, task_guid: str, summary: str, start_time: str, end_time: str, completed_time: str, description: str
+    ) -> dict:
+        # 更新任务
+        url = f"{self.API_BASE_URL}/task/update_task"
+        payload = {
+            "task_guid": task_guid,
+            "summary": summary,
+            "start_time": start_time,
+            "end_time": end_time,
+            "completed_time": completed_time,
+            "description": description,
+        }
+        res = self._send_request(url, method="PATCH", payload=payload)
+        return res.get("data")
+
+    def delete_task(self, task_guid: str) -> dict:
+        # 删除任务
+        url = f"{self.API_BASE_URL}/task/delete_task"
+        payload = {
+            "task_guid": task_guid,
+        }
+        res = self._send_request(url, method="DELETE", payload=payload)
+        return res
+
+    def add_members(self, task_guid: str, member_phone_or_email: str, member_role: str) -> dict:
+        # 删除任务
+        url = f"{self.API_BASE_URL}/task/add_members"
+        payload = {
+            "task_guid": task_guid,
+            "member_phone_or_email": member_phone_or_email,
+            "member_role": member_role,
+        }
+        res = self._send_request(url, payload=payload)
+        return res
+
+    def get_wiki_nodes(self, space_id: str, parent_node_token: str, page_token: str, page_size: int = 20) -> dict:
+        # 获取知识库全部子节点列表
+        url = f"{self.API_BASE_URL}/wiki/get_wiki_nodes"
+        payload = {
+            "space_id": space_id,
+            "parent_node_token": parent_node_token,
+            "page_token": page_token,
+            "page_size": page_size,
+        }
+        res = self._send_request(url, payload=payload)
+        return res.get("data")
+
+    def get_primary_calendar(self, user_id_type: str = "open_id") -> dict:
+        url = f"{self.API_BASE_URL}/calendar/get_primary_calendar"
+        params = {
+            "user_id_type": user_id_type,
+        }
+        res = self._send_request(url, method="GET", params=params)
+        return res.get("data")
+
+    def create_event(
+        self,
+        summary: str,
+        description: str,
+        start_time: str,
+        end_time: str,
+        attendee_ability: str,
+        need_notification: bool = True,
+        auto_record: bool = False,
+    ) -> dict:
+        url = f"{self.API_BASE_URL}/calendar/create_event"
+        payload = {
+            "summary": summary,
+            "description": description,
+            "need_notification": need_notification,
+            "start_time": start_time,
+            "end_time": end_time,
+            "auto_record": auto_record,
+            "attendee_ability": attendee_ability,
+        }
+        res = self._send_request(url, payload=payload)
+        return res.get("data")
+
+    def update_event(
+        self,
+        event_id: str,
+        summary: str,
+        description: str,
+        need_notification: bool,
+        start_time: str,
+        end_time: str,
+        auto_record: bool,
+    ) -> dict:
+        url = f"{self.API_BASE_URL}/calendar/update_event/{event_id}"
+        payload = {}
+        if summary:
+            payload["summary"] = summary
+        if description:
+            payload["description"] = description
+        if start_time:
+            payload["start_time"] = start_time
+        if end_time:
+            payload["end_time"] = end_time
+        if need_notification:
+            payload["need_notification"] = need_notification
+        if auto_record:
+            payload["auto_record"] = auto_record
+        res = self._send_request(url, method="PATCH", payload=payload)
+        return res
+
+    def delete_event(self, event_id: str, need_notification: bool = True) -> dict:
+        url = f"{self.API_BASE_URL}/calendar/delete_event/{event_id}"
+        params = {
+            "need_notification": need_notification,
+        }
+        res = self._send_request(url, method="DELETE", params=params)
+        return res
+
+    def list_events(self, start_time: str, end_time: str, page_token: str, page_size: int = 50) -> dict:
+        url = f"{self.API_BASE_URL}/calendar/list_events"
+        params = {
+            "start_time": start_time,
+            "end_time": end_time,
+            "page_token": page_token,
+            "page_size": page_size,
+        }
+        res = self._send_request(url, method="GET", params=params)
+        return res.get("data")
+
+    def search_events(
+        self,
+        query: str,
+        start_time: str,
+        end_time: str,
+        page_token: str,
+        user_id_type: str = "open_id",
+        page_size: int = 20,
+    ) -> dict:
+        url = f"{self.API_BASE_URL}/calendar/search_events"
+        payload = {
+            "query": query,
+            "start_time": start_time,
+            "end_time": end_time,
+            "page_token": page_token,
+            "user_id_type": user_id_type,
+            "page_size": page_size,
+        }
+        res = self._send_request(url, payload=payload)
+        return res.get("data")
+
+    def add_event_attendees(self, event_id: str, attendee_phone_or_email: str, need_notification: bool = True) -> dict:
+        # 参加日程参会人
+        url = f"{self.API_BASE_URL}/calendar/add_event_attendees"
+        payload = {
+            "event_id": event_id,
+            "attendee_phone_or_email": attendee_phone_or_email,
+            "need_notification": need_notification,
+        }
+        res = self._send_request(url, payload=payload)
+        return res.get("data")
+
+    def create_spreadsheet(
+        self,
+        title: str,
+        folder_token: str,
+    ) -> dict:
+        # 创建电子表格
+        url = f"{self.API_BASE_URL}/spreadsheet/create_spreadsheet"
+        payload = {
+            "title": title,
+            "folder_token": folder_token,
+        }
+        res = self._send_request(url, payload=payload)
+        return res.get("data")
+
+    def get_spreadsheet(
+        self,
+        spreadsheet_token: str,
+        user_id_type: str = "open_id",
+    ) -> dict:
+        # 获取电子表格信息
+        url = f"{self.API_BASE_URL}/spreadsheet/get_spreadsheet"
+        params = {
+            "spreadsheet_token": spreadsheet_token,
+            "user_id_type": user_id_type,
+        }
+        res = self._send_request(url, method="GET", params=params)
+        return res.get("data")
+
+    def list_spreadsheet_sheets(
+        self,
+        spreadsheet_token: str,
+    ) -> dict:
+        # 列出电子表格的所有工作表
+        url = f"{self.API_BASE_URL}/spreadsheet/list_spreadsheet_sheets"
+        params = {
+            "spreadsheet_token": spreadsheet_token,
+        }
+        res = self._send_request(url, method="GET", params=params)
+        return res.get("data")
+
+    def add_rows(
+        self,
+        spreadsheet_token: str,
+        sheet_id: str,
+        sheet_name: str,
+        length: int,
+        values: str,
+    ) -> dict:
+        # 增加行,在工作表最后添加
+        url = f"{self.API_BASE_URL}/spreadsheet/add_rows"
+        payload = {
+            "spreadsheet_token": spreadsheet_token,
+            "sheet_id": sheet_id,
+            "sheet_name": sheet_name,
+            "length": length,
+            "values": values,
+        }
+        res = self._send_request(url, payload=payload)
+        return res.get("data")
+
+    def add_cols(
+        self,
+        spreadsheet_token: str,
+        sheet_id: str,
+        sheet_name: str,
+        length: int,
+        values: str,
+    ) -> dict:
+        #  增加列,在工作表最后添加
+        url = f"{self.API_BASE_URL}/spreadsheet/add_cols"
+        payload = {
+            "spreadsheet_token": spreadsheet_token,
+            "sheet_id": sheet_id,
+            "sheet_name": sheet_name,
+            "length": length,
+            "values": values,
+        }
+        res = self._send_request(url, payload=payload)
+        return res.get("data")
+
+    def read_rows(
+        self,
+        spreadsheet_token: str,
+        sheet_id: str,
+        sheet_name: str,
+        start_row: int,
+        num_rows: int,
+        user_id_type: str = "open_id",
+    ) -> dict:
+        # 读取工作表行数据
+        url = f"{self.API_BASE_URL}/spreadsheet/read_rows"
+        params = {
+            "spreadsheet_token": spreadsheet_token,
+            "sheet_id": sheet_id,
+            "sheet_name": sheet_name,
+            "start_row": start_row,
+            "num_rows": num_rows,
+            "user_id_type": user_id_type,
+        }
+        res = self._send_request(url, method="GET", params=params)
+        return res.get("data")
+
+    def read_cols(
+        self,
+        spreadsheet_token: str,
+        sheet_id: str,
+        sheet_name: str,
+        start_col: int,
+        num_cols: int,
+        user_id_type: str = "open_id",
+    ) -> dict:
+        # 读取工作表列数据
+        url = f"{self.API_BASE_URL}/spreadsheet/read_cols"
+        params = {
+            "spreadsheet_token": spreadsheet_token,
+            "sheet_id": sheet_id,
+            "sheet_name": sheet_name,
+            "start_col": start_col,
+            "num_cols": num_cols,
+            "user_id_type": user_id_type,
+        }
+        res = self._send_request(url, method="GET", params=params)
+        return res.get("data")
+
+    def read_table(
+        self,
+        spreadsheet_token: str,
+        sheet_id: str,
+        sheet_name: str,
+        num_range: str,
+        query: str,
+        user_id_type: str = "open_id",
+    ) -> dict:
+        # 自定义读取行列数据
+        url = f"{self.API_BASE_URL}/spreadsheet/read_table"
+        params = {
+            "spreadsheet_token": spreadsheet_token,
+            "sheet_id": sheet_id,
+            "sheet_name": sheet_name,
+            "range": num_range,
+            "query": query,
+            "user_id_type": user_id_type,
+        }
+        res = self._send_request(url, method="GET", params=params)
+        return res.get("data")