feat(Tools): Add Feishu multi-dimensional table operation function (#5213)

Co-authored-by: 黎斌 <libin.23@bytedance.com>
Co-authored-by: takatost <takatost@gmail.com>
This commit is contained in:
走在修行的大街上 2024-06-14 21:19:20 +08:00 committed by GitHub
parent e7752e8135
commit 8d1386df0f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
26 changed files with 1345 additions and 0 deletions

View File

@ -27,4 +27,5 @@
- qrcode
- dingtalk
- feishu
- feishu_base
- slack

View File

@ -0,0 +1,47 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" width="240px" height="240px" viewBox="0 0 240 240" enable-background="new 0 0 240 240" xml:space="preserve"> <image id="image0" width="240" height="240" x="0" y="0"
xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAPAAAADwCAMAAAAJixmgAAAAIGNIUk0AAHomAACAhAAA+gAAAIDo
AAB1MAAA6mAAADqYAAAXcJy6UTwAAAINUExURQAAAJ9g6qNg6qRd6KNe6aVg6J9g6p9g359a6qRd
66Ne66Re66Rd66Rd66Re7Z9g559g76Ne7aRe6qJd76Fe66Ne66Re66Vd7KNc6aRe66Nd66Re7KRd
66Nc6p9g36Re7KRf7KRe7KNe7KNc76Va6qVd66Ne66Re66Nd6qRb6KRe66Zd66Ve7KJd6aNe66Fe
7KRd6p9Y56Re66Je6qRb6qNe66Re7KNc56Jf6qNe6qRe6qFe6KNe6qRf66Rf66Ne7KNe6qRe6qRd
66Rd7KFe6aNc6qNe6qJd7Z9b6KNd659Z7KNd66Ne6aRe66Re7KNc66Nd66Ne66Jd6qNe6qNc6aJd
6qNd6qRe66Jd7KFe6qJe66Re6qNe66Jd66Jd6aRd6qRd66Va759V6qVd6qFe56Ne6KJd6KRe66Zj
67eB79Gu9eLM+OjX+uXS+dSz9bJ37s6p9LV87q9y7de49vn1/f///9q99qlo7NGu9Kxt7d/H+Pz5
/vz6/qdj68CQ8e7h+/Pq/Maa8rqG8NzC9/Pr/Myk8+DH+OXR+cyk9Pn1/ujW+u3g+7iB7+vc+r2L
8N3C9//+//bw/cmf87uG8OPM+ebR+axt7Muk8/Dm/Mif8/n0/c+p9MOV8fHm++7g+/n0/vbv/bqG
78CQ8Kxu7cCR8ePM+LqH8MCP8bV87+LM+bqF8Muk9OLL+NSy9bqF75VHsr4AAABndFJOUwAYSHCA
WDAQMJfn57+PVyAQb98/gO/mllDPr1/ebwiHn+6eLzCvf/63OL4/xkfOT58g9odfZ65Aj3fHT2+X
j3f3z7efgEjPRzi3KKd/7sZAv+6fri+P3rY3X77G5j9oxn4fGGCAbzcMFjqxAAAAAWJLR0R1qGqY
+wAAAAd0SU1FB+gGDQkfBmABjhYAAAXYSURBVHja7d35WxtFGAfwbUGDtRWKilAwFg+2VHtwqa31
qlfV1qta7/vYkDQhJFnTliQWhFYoDaVY8ECw3vffaHgefZ5CZvbZIbMz83a/35/ngfkwx+5m3iyW
hSAIgiAIgiAIgiAIgiAIQjAbNtbVa0vdNRuvjSjlNly3ydGd6zdvuaFRDbdpa7Nu7f9p3nJjU/De
m27W7bwyLbcEbW5t021cm7atQc7thm26fYw01wdHbjdmAa9Kx61NwXijt+mm8dLWHgi5cbtuGDed
t98RAPjOu3S7PBLEIBsNdjq7pIvNBjv2ju5wgR17593hAjvOPbtCBnZ27wkZWK6YAljqOqYAlrpX
kwA79t6ecIGd3r6mcIGdjv6QgaUtYypgaZOaDFjWpKYDlrRT0wE7LQMhA9v3yvgEhBBYziqmBJay
iimBpQwxKbDdFw0X2Nl8X8jAEuY0LbB9f80H58TAtT9C0AJLmNPEwL37QgaufRFTA29rCBfY2V/r
OQQ18O4HQgau+aGYGrjzQMjAdhfAVzm41idEcuBa7zwANjwAAwwwwKQCcIDg2GA8cXx1kqnBGK/5
UHpta16SqWETwZlszq1O7tMhZuv8CVZrXnKpk8aBh05xOptgDY+Y13VHsj7FysB8QSFerG5e+kzI
67qnRw0DDye4fT0+Vv3nyQp6XffzjFng0XH+Apyoaj10Rhh8dtAs8BeT3K4W0lWtx6aEwedKlMHT
Z4XB58tmgUvnuF0dr95vMjPC4IS/a7EysAeB1dV0QdB7IZs3C8zftWYvMloLz2nGVq8ZXJyYZfZ0
Ms4cmjmxbcvvZVjpvfTcl9UbV+FSmXMzPTwz6ZtbuDTntxNqn5bmp+dWZ3reo3VmzmemMzHfXcDj
IcAAA0wqAAMMMMCkAjDAAANMKgADDDDApAIwwBLB+XI6vjrp0kmB1rx4/RSN4PwC67BlfCHPbB0r
nRc4ePjq67zPXqgD82oeCuzqjIuzAl7X/eaET7E68ASvxiP3LaPGQ/BoiXyNRzEl6DXvuNSjxoNx
IB66Go91lDyErsbDNPDidyGb0h5jxqjxKMbp13hw5/RkmnGcLXxZWvI3o1XeeMSXmT0dSbGGpjjx
vZB3mV0pohPs5EeXLlTPxNOcW8viIqM1N7wbVK3gCvnywtrb/h/4RR4CDw+L/gpLlYNNCMAAAwww
qQAMMMAAkwrAAAMMMKkADDDAAJMKwIGCfxwcW5OMUGte/H9KqxIcKyerD4xyyZ+K7ObTP/s/Xiok
fzEPnE+zqzZy7OqMskhNC+dLyHrB3BKAcVZ1hkeFBDvGfWHaQ8D6SvyE2ItaXHckXvTVD0MPxNfx
0gPTDsQ96q6uztdaeNR4uPGq1ut5ccmvZoE9ypYYO+xvvwuDp/4wC+xRw8CoVlhHYZppLx/il6kU
WDUPpSVB8PKf/vqh7jrM3XjZLxDjVITwwq4U0Qp2MlmWYWSG84o4IfFyat5nL5Q+PAynT02tTiJ1
Oea/NS9//f2P7xd54PEQYIABJhWAAQYYYFIBWDSN23UTFIM3PKiboBgceUg3QTHYevgR3QbF4IFN
ug2Kwa2P6jYoBncf1G1QDO55TLdBMTj6OKldS8I/5G1v1o1QDKa1iCWAad16SADTmtMywKTmtAww
qX1aBth6Yr9uhmIwpW1LCtja86Ruh2IwoSGWA7aeIrOKJYGjXb26JWrB1qGndUsUg63+Dt0UxeBI
H41JLQ1sPfOsbotiMJGdWiKYxjKWCY4eaNHNUQu2IoeP6PaoBVMQywUTEEsGW5F9hq9j2eDK1ek5
WzdKLdg6tMNkcQBgsxey3ReVDras51+wdcO44K4AvCuD/KKh5I7+QMCW1fCSkWT76MsBgQ0lHzks
f8+6gvzKMcPI9quvBeitJPL6GyYNs/3mrmC9K+kZOPqWbQba3vl28N6VRBve2ftuRW1rhFd+97H3
3lfj/S8fdLd+WFevKx99/EkQdxwIgiAIgiAIgiAIgiAIgiBB519+T+5Fl+ldNwAAACV0RVh0ZGF0
ZTpjcmVhdGUAMjAyNC0wNi0xM1QwOTozMTowNiswMDowMPHqs70AAAAldEVYdGRhdGU6bW9kaWZ5
ADIwMjQtMDYtMTNUMDk6MzE6MDYrMDA6MDCAtwsBAAAAKHRFWHRkYXRlOnRpbWVzdGFtcAAyMDI0
LTA2LTEzVDA5OjMxOjA2KzAwOjAw16Iq3gAAAABJRU5ErkJggg==" />
</svg>

After

Width:  |  Height:  |  Size: 3.7 KiB

View File

@ -0,0 +1,8 @@
from core.tools.provider.builtin.feishu_base.tools.get_tenant_access_token import GetTenantAccessTokenTool
from core.tools.provider.builtin_tool_provider import BuiltinToolProviderController
class FeishuBaseProvider(BuiltinToolProviderController):
def _validate_credentials(self, credentials: dict) -> None:
GetTenantAccessTokenTool()
pass

View File

@ -0,0 +1,14 @@
identity:
author: Doug Lea
name: feishu_base
label:
en_US: Feishu Base
zh_Hans: 飞书多维表格
description:
en_US: Feishu Base
zh_Hans: 飞书多维表格
icon: icon.svg
tags:
- social
- productivity
credentials_for_provider:

View File

@ -0,0 +1,52 @@
import json
from typing import Any, Union
import httpx
from core.tools.entities.tool_entities import ToolInvokeMessage
from core.tools.tool.builtin_tool import BuiltinTool
class AddBaseRecordTool(BuiltinTool):
def _invoke(self, user_id: str, tool_parameters: dict[str, Any]
) -> Union[ToolInvokeMessage, list[ToolInvokeMessage]]:
url = "https://open.feishu.cn/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/records"
access_token = tool_parameters.get('Authorization', '')
if not access_token:
return self.create_text_message('Invalid parameter access_token')
app_token = tool_parameters.get('app_token', '')
if not app_token:
return self.create_text_message('Invalid parameter app_token')
table_id = tool_parameters.get('table_id', '')
if not table_id:
return self.create_text_message('Invalid parameter table_id')
fields = tool_parameters.get('fields', '')
if not fields:
return self.create_text_message('Invalid parameter fields')
headers = {
'Content-Type': 'application/json',
'Authorization': f"Bearer {access_token}",
}
params = {}
payload = {
"fields": json.loads(fields)
}
try:
res = httpx.post(url.format(app_token=app_token, table_id=table_id), headers=headers, params=params,
json=payload, timeout=30)
res_json = res.json()
if res.is_success:
return self.create_text_message(text=json.dumps(res_json))
else:
return self.create_text_message(
f"Failed to add base record, status code: {res.status_code}, response: {res.text}")
except Exception as e:
return self.create_text_message("Failed to add base record. {}".format(e))

View File

@ -0,0 +1,66 @@
identity:
name: add_base_record
author: Doug Lea
label:
en_US: Add Base Record
zh_Hans: 在多维表格数据表中新增一条记录
description:
human:
en_US: Add Base Record
zh_Hans: |
在多维表格数据表中新增一条记录详细请参考https://open.larkoffice.com/document/server-docs/docs/bitable-v1/app-table-record/create
llm: Add a new record in the multidimensional table data table.
parameters:
- name: Authorization
type: string
required: true
label:
en_US: token
zh_Hans: 凭证
human_description:
en_US: API access token parameter, tenant_access_token or user_access_token
zh_Hans: API 的访问凭证参数tenant_access_token 或 user_access_token
llm_description: API access token parameter, tenant_access_token or user_access_token
form: llm
- name: app_token
type: string
required: true
label:
en_US: app_token
zh_Hans: 多维表格
human_description:
en_US: bitable app token
zh_Hans: 多维表格的唯一标识符 app_token
llm_description: bitable app token
form: llm
- name: table_id
type: string
required: true
label:
en_US: table_id
zh_Hans: 多维表格的数据表
human_description:
en_US: bitable table id
zh_Hans: 多维表格数据表的唯一标识符 table_id
llm_description: bitable table id
form: llm
- name: fields
type: string
required: true
label:
en_US: fields
zh_Hans: 数据表的列字段内容
human_description:
en_US: The fields of the Base data table are the columns of the data table.
zh_Hans: |
要增加一行多维表格记录,字段结构拼接如下:{"多行文本":"多行文本内容","单选":"选项1","多选":["选项1","选项2"],"复选框":true,"人员":[{"id":"ou_2910013f1e6456f16a0ce75ede950a0a"}],"群组":[{"id":"oc_cd07f55f14d6f4a4f1b51504e7e97f48"}],"电话号码":"13026162666"}
当前接口支持的字段类型为:多行文本、单选、条码、多选、日期、人员、附件、复选框、超链接、数字、单向关联、双向关联、电话号码、地理位置。
不同类型字段的数据结构请参考数据结构概述https://open.larkoffice.com/document/server-docs/docs/bitable-v1/bitable-structure
llm_description: |
要增加一行多维表格记录,字段结构拼接如下:{"多行文本":"多行文本内容","单选":"选项1","多选":["选项1","选项2"],"复选框":true,"人员":[{"id":"ou_2910013f1e6456f16a0ce75ede950a0a"}],"群组":[{"id":"oc_cd07f55f14d6f4a4f1b51504e7e97f48"}],"电话号码":"13026162666"}
当前接口支持的字段类型为:多行文本、单选、条码、多选、日期、人员、附件、复选框、超链接、数字、单向关联、双向关联、电话号码、地理位置。
不同类型字段的数据结构请参考数据结构概述https://open.larkoffice.com/document/server-docs/docs/bitable-v1/bitable-structure
form: llm

View File

@ -0,0 +1,43 @@
import json
from typing import Any, Union
import httpx
from core.tools.entities.tool_entities import ToolInvokeMessage
from core.tools.tool.builtin_tool import BuiltinTool
class CreateBaseTool(BuiltinTool):
def _invoke(self, user_id: str, tool_parameters: dict[str, Any]
) -> Union[ToolInvokeMessage, list[ToolInvokeMessage]]:
url = "https://open.feishu.cn/open-apis/bitable/v1/apps"
access_token = tool_parameters.get('Authorization', '')
if not access_token:
return self.create_text_message('Invalid parameter access_token')
name = tool_parameters.get('name', '')
folder_token = tool_parameters.get('folder_token', '')
headers = {
'Content-Type': 'application/json',
'Authorization': f"Bearer {access_token}",
}
params = {}
payload = {
"name": name,
"folder_token": folder_token
}
try:
res = httpx.post(url, headers=headers, params=params, json=payload, timeout=30)
res_json = res.json()
if res.is_success:
return self.create_text_message(text=json.dumps(res_json))
else:
return self.create_text_message(
f"Failed to create base, status code: {res.status_code}, response: {res.text}")
except Exception as e:
return self.create_text_message("Failed to create base. {}".format(e))

View File

@ -0,0 +1,47 @@
identity:
name: create_base
author: Doug Lea
label:
en_US: Create Base
zh_Hans: 创建多维表格
description:
human:
en_US: Create base
zh_Hans: 在指定目录下创建多维表格
llm: A tool for create a multidimensional table in the specified directory.
parameters:
- name: Authorization
type: string
required: true
label:
en_US: token
zh_Hans: 凭证
human_description:
en_US: API access token parameter, tenant_access_token or user_access_token
zh_Hans: API 的访问凭证参数tenant_access_token 或 user_access_token
llm_description: API access token parameter, tenant_access_token or user_access_token
form: llm
- name: name
type: string
required: false
label:
en_US: name
zh_Hans: name
human_description:
en_US: Base App Name
zh_Hans: 多维表格App名字
llm_description: Base App Name
form: llm
- name: folder_token
type: string
required: false
label:
en_US: folder_token
zh_Hans: 多维表格App归属文件夹
human_description:
en_US: Base App home folder. The default is empty, indicating that Base will be created in the cloud space root directory.
zh_Hans: 多维表格App归属文件夹。默认为空表示多维表格将被创建在云空间根目录。
llm_description: Base App home folder. The default is empty, indicating that Base will be created in the cloud space root directory.
form: llm

View File

@ -0,0 +1,52 @@
import json
from typing import Any, Union
import httpx
from core.tools.entities.tool_entities import ToolInvokeMessage
from core.tools.tool.builtin_tool import BuiltinTool
class CreateBaseTableTool(BuiltinTool):
def _invoke(self, user_id: str, tool_parameters: dict[str, Any]
) -> Union[ToolInvokeMessage, list[ToolInvokeMessage]]:
url = "https://open.feishu.cn/open-apis/bitable/v1/apps/{app_token}/tables"
access_token = tool_parameters.get('Authorization', '')
if not access_token:
return self.create_text_message('Invalid parameter access_token')
app_token = tool_parameters.get('app_token', '')
if not app_token:
return self.create_text_message('Invalid parameter app_token')
name = tool_parameters.get('name', '')
fields = tool_parameters.get('fields', '')
if not fields:
return self.create_text_message('Invalid parameter fields')
headers = {
'Content-Type': 'application/json',
'Authorization': f"Bearer {access_token}",
}
params = {}
payload = {
"table": {
"name": name,
"fields": json.loads(fields)
}
}
try:
res = httpx.post(url.format(app_token=app_token), headers=headers, params=params, json=payload, timeout=30)
res_json = res.json()
if res.is_success:
return self.create_text_message(text=json.dumps(res_json))
else:
return self.create_text_message(
f"Failed to create base table, status code: {res.status_code}, response: {res.text}")
except Exception as e:
return self.create_text_message("Failed to create base table. {}".format(e))

View File

@ -0,0 +1,106 @@
identity:
name: create_base_table
author: Doug Lea
label:
en_US: Create Base Table
zh_Hans: 多维表格新增一个数据表
description:
human:
en_US: Create base table
zh_Hans: |
多维表格新增一个数据表详细请参考https://open.larkoffice.com/document/server-docs/docs/bitable-v1/app-table/create
llm: A tool for add a new data table to the multidimensional table.
parameters:
- name: Authorization
type: string
required: true
label:
en_US: token
zh_Hans: 凭证
human_description:
en_US: API access token parameter, tenant_access_token or user_access_token
zh_Hans: API 的访问凭证参数tenant_access_token 或 user_access_token
llm_description: API access token parameter, tenant_access_token or user_access_token
form: llm
- name: app_token
type: string
required: true
label:
en_US: app_token
zh_Hans: 多维表格
human_description:
en_US: bitable app token
zh_Hans: 多维表格的唯一标识符 app_token
llm_description: bitable app token
form: llm
- name: name
type: string
required: false
label:
en_US: name
zh_Hans: name
human_description:
en_US: Multidimensional table data table name
zh_Hans: 多维表格数据表名称
llm_description: Multidimensional table data table name
form: llm
- name: fields
type: string
required: true
label:
en_US: fields
zh_Hans: fields
human_description:
en_US: Initial fields of the data table
zh_Hans: |
数据表的初始字段,格式为:[{"field_name":"多行文本","type":1},{"field_name":"数字","type":2},{"field_name":"单选","type":3},{"field_name":"多选","type":4},{"field_name":"日期","type":5}]。
field_name字段名
type: 字段类型;可选值有
1:多行文本
2:数字
3:单选
4:多选
5:日期
7:复选框
11:人员
13:电话号码
15:超链接
17:附件
18:单向关联
20:公式
21:双向关联
22:地理位置
23:群组
1001:创建时间
1002:最后更新时间
1003:创建人
1004:修改人
1005:自动编号
llm_description: |
数据表的初始字段,格式为:[{"field_name":"多行文本","type":1},{"field_name":"数字","type":2},{"field_name":"单选","type":3},{"field_name":"多选","type":4},{"field_name":"日期","type":5}]。
field_name字段名
type: 字段类型;可选值有
1:多行文本
2:数字
3:单选
4:多选
5:日期
7:复选框
11:人员
13:电话号码
15:超链接
17:附件
18:单向关联
20:公式
21:双向关联
22:地理位置
23:群组
1001:创建时间
1002:最后更新时间
1003:创建人
1004:修改人
1005:自动编号
form: llm

View File

@ -0,0 +1,52 @@
import json
from typing import Any, Union
import httpx
from core.tools.entities.tool_entities import ToolInvokeMessage
from core.tools.tool.builtin_tool import BuiltinTool
class DeleteBaseRecordsTool(BuiltinTool):
def _invoke(self, user_id: str, tool_parameters: dict[str, Any]
) -> Union[ToolInvokeMessage, list[ToolInvokeMessage]]:
url = "https://open.feishu.cn/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/records/batch_delete"
access_token = tool_parameters.get('Authorization', '')
if not access_token:
return self.create_text_message('Invalid parameter access_token')
app_token = tool_parameters.get('app_token', '')
if not app_token:
return self.create_text_message('Invalid parameter app_token')
table_id = tool_parameters.get('table_id', '')
if not table_id:
return self.create_text_message('Invalid parameter table_id')
record_ids = tool_parameters.get('record_ids', '')
if not record_ids:
return self.create_text_message('Invalid parameter record_ids')
headers = {
'Content-Type': 'application/json',
'Authorization': f"Bearer {access_token}",
}
params = {}
payload = {
"records": json.loads(record_ids)
}
try:
res = httpx.post(url.format(app_token=app_token, table_id=table_id), headers=headers, params=params,
json=payload, timeout=30)
res_json = res.json()
if res.is_success:
return self.create_text_message(text=json.dumps(res_json))
else:
return self.create_text_message(
f"Failed to delete base records, status code: {res.status_code}, response: {res.text}")
except Exception as e:
return self.create_text_message("Failed to delete base records. {}".format(e))

View File

@ -0,0 +1,60 @@
identity:
name: delete_base_records
author: Doug Lea
label:
en_US: Delete Base Records
zh_Hans: 在多维表格数据表中删除多条记录
description:
human:
en_US: Delete base records
zh_Hans: |
该接口用于删除多维表格数据表中的多条记录,单次调用中最多删除 500 条记录。
llm: A tool for delete multiple records in a multidimensional table data table, up to 500 records can be deleted in a single call.
parameters:
- name: Authorization
type: string
required: true
label:
en_US: token
zh_Hans: 凭证
human_description:
en_US: API access token parameter, tenant_access_token or user_access_token
zh_Hans: API 的访问凭证参数tenant_access_token 或 user_access_token
llm_description: API access token parameter, tenant_access_token or user_access_token
form: llm
- name: app_token
type: string
required: true
label:
en_US: app_token
zh_Hans: 多维表格
human_description:
en_US: bitable app token
zh_Hans: 多维表格的唯一标识符 app_token
llm_description: bitable app token
form: llm
- name: table_id
type: string
required: true
label:
en_US: table_id
zh_Hans: 多维表格的数据表
human_description:
en_US: bitable table id
zh_Hans: 多维表格数据表的唯一标识符 table_id
llm_description: bitable table id
form: llm
- name: record_ids
type: string
required: true
label:
en_US: record_ids
zh_Hans: record_ids
human_description:
en_US: A list of multiple record IDs to be deleted, for example ["recwNXzPQv","recpCsf4ME"]
zh_Hans: 待删除的多条记录id列表示例为 ["recwNXzPQv","recpCsf4ME"]
llm_description: A list of multiple record IDs to be deleted, for example ["recwNXzPQv","recpCsf4ME"]
form: llm

View File

@ -0,0 +1,47 @@
import json
from typing import Any, Union
import httpx
from core.tools.entities.tool_entities import ToolInvokeMessage
from core.tools.tool.builtin_tool import BuiltinTool
class DeleteBaseTablesTool(BuiltinTool):
def _invoke(self, user_id: str, tool_parameters: dict[str, Any]
) -> Union[ToolInvokeMessage, list[ToolInvokeMessage]]:
url = "https://open.feishu.cn/open-apis/bitable/v1/apps/{app_token}/tables/batch_delete"
access_token = tool_parameters.get('Authorization', '')
if not access_token:
return self.create_text_message('Invalid parameter access_token')
app_token = tool_parameters.get('app_token', '')
if not app_token:
return self.create_text_message('Invalid parameter app_token')
table_ids = tool_parameters.get('table_ids', '')
if not table_ids:
return self.create_text_message('Invalid parameter table_ids')
headers = {
'Content-Type': 'application/json',
'Authorization': f"Bearer {access_token}",
}
params = {}
payload = {
"table_ids": json.loads(table_ids)
}
try:
res = httpx.post(url.format(app_token=app_token), headers=headers, params=params, json=payload, timeout=30)
res_json = res.json()
if res.is_success:
return self.create_text_message(text=json.dumps(res_json))
else:
return self.create_text_message(
f"Failed to delete base tables, status code: {res.status_code}, response: {res.text}")
except Exception as e:
return self.create_text_message("Failed to delete base tables. {}".format(e))

View File

@ -0,0 +1,48 @@
identity:
name: delete_base_tables
author: Doug Lea
label:
en_US: Delete Base Tables
zh_Hans: 删除多维表格中的数据表
description:
human:
en_US: Delete base tables
zh_Hans: |
删除多维表格中的数据表
llm: A tool for deleting a data table in a multidimensional table
parameters:
- name: Authorization
type: string
required: true
label:
en_US: token
zh_Hans: 凭证
human_description:
en_US: API access token parameter, tenant_access_token or user_access_token
zh_Hans: API 的访问凭证参数tenant_access_token 或 user_access_token
llm_description: API access token parameter, tenant_access_token or user_access_token
form: llm
- name: app_token
type: string
required: true
label:
en_US: app_token
zh_Hans: 多维表格
human_description:
en_US: bitable app token
zh_Hans: 多维表格的唯一标识符 app_token
llm_description: bitable app token
form: llm
- name: table_ids
type: string
required: true
label:
en_US: table_ids
zh_Hans: table_ids
human_description:
en_US: The ID list of the data tables to be deleted. Currently, a maximum of 50 data tables can be deleted at a time. The example is ["tbl1TkhyTWDkSoZ3","tblsRc9GRRXKqhvW"]
zh_Hans: 待删除数据表的id列表当前一次操作最多支持50个数据表示例为 ["tbl1TkhyTWDkSoZ3","tblsRc9GRRXKqhvW"]
llm_description: The ID list of the data tables to be deleted. Currently, a maximum of 50 data tables can be deleted at a time. The example is ["tbl1TkhyTWDkSoZ3","tblsRc9GRRXKqhvW"]
form: llm

View File

@ -0,0 +1,38 @@
import json
from typing import Any, Union
import httpx
from core.tools.entities.tool_entities import ToolInvokeMessage
from core.tools.tool.builtin_tool import BuiltinTool
class GetBaseInfoTool(BuiltinTool):
def _invoke(self, user_id: str, tool_parameters: dict[str, Any]
) -> Union[ToolInvokeMessage, list[ToolInvokeMessage]]:
url = "https://open.feishu.cn/open-apis/bitable/v1/apps/{app_token}"
access_token = tool_parameters.get('Authorization', '')
if not access_token:
return self.create_text_message('Invalid parameter access_token')
app_token = tool_parameters.get('app_token', '')
if not app_token:
return self.create_text_message('Invalid parameter app_token')
headers = {
'Content-Type': 'application/json',
'Authorization': f"Bearer {access_token}",
}
try:
res = httpx.get(url.format(app_token=app_token), headers=headers, timeout=30)
res_json = res.json()
if res.is_success:
return self.create_text_message(text=json.dumps(res_json))
else:
return self.create_text_message(
f"Failed to get base info, status code: {res.status_code}, response: {res.text}")
except Exception as e:
return self.create_text_message("Failed to get base info. {}".format(e))

View File

@ -0,0 +1,54 @@
identity:
name: get_base_info
author: Doug Lea
label:
en_US: Get Base Info
zh_Hans: 获取多维表格元数据
description:
human:
en_US: Get base info
zh_Hans: |
获取多维表格元数据,响应体如下:
{
"code": 0,
"msg": "success",
"data": {
"app": {
"app_token": "appbcbWCzen6D8dezhoCH2RpMAh",
"name": "mybase",
"revision": 1,
"is_advanced": false,
"time_zone": "Asia/Beijing"
}
}
}
app_token: 多维表格的 app_token;
name: 多维表格的名字;
revision: 多维表格的版本号;
is_advanced: 多维表格是否开启了高级权限。取值包括:(true-表示开启了高级权限false-表示关闭了高级权限);
time_zone: 文档时区;
llm: A tool to get Base Metadata, imported parameter is Unique Device Identifier app_token of Base, app_token is required.
parameters:
- name: Authorization
type: string
required: true
label:
en_US: token
zh_Hans: 凭证
human_description:
en_US: API access token parameter, tenant_access_token or user_access_token
zh_Hans: API 的访问凭证参数tenant_access_token 或 user_access_token
llm_description: API access token parameter, tenant_access_token or user_access_token
form: llm
- name: app_token
type: string
required: true
label:
en_US: app_token
zh_Hans: 多维表格
human_description:
en_US: bitable app token
zh_Hans: 多维表格的唯一标识符 app_token
llm_description: bitable app token
form: llm

View File

@ -0,0 +1,50 @@
import json
from typing import Any, Union
import httpx
from core.tools.entities.tool_entities import ToolInvokeMessage
from core.tools.tool.builtin_tool import BuiltinTool
class GetTenantAccessTokenTool(BuiltinTool):
def _invoke(self, user_id: str, tool_parameters: dict[str, Any]
) -> Union[ToolInvokeMessage, list[ToolInvokeMessage]]:
url = "https://open.feishu.cn/open-apis/auth/v3/tenant_access_token/internal"
app_id = tool_parameters.get('app_id', '')
if not app_id:
return self.create_text_message('Invalid parameter app_id')
app_secret = tool_parameters.get('app_secret', '')
if not app_secret:
return self.create_text_message('Invalid parameter app_secret')
headers = {
'Content-Type': 'application/json',
}
params = {}
payload = {
"app_id": app_id,
"app_secret": app_secret
}
"""
{
"code": 0,
"msg": "ok",
"tenant_access_token": "t-caecc734c2e3328a62489fe0648c4b98779515d3",
"expire": 7200
}
"""
try:
res = httpx.post(url, headers=headers, params=params, json=payload, timeout=30)
res_json = res.json()
if res.is_success:
return self.create_text_message(text=json.dumps(res_json))
else:
return self.create_text_message(
f"Failed to get tenant access token, status code: {res.status_code}, response: {res.text}")
except Exception as e:
return self.create_text_message("Failed to get tenant access token. {}".format(e))

View File

@ -0,0 +1,39 @@
identity:
name: get_tenant_access_token
author: Doug Lea
label:
en_US: Get Tenant Access Token
zh_Hans: 获取飞书自建应用的 tenant_access_token
description:
human:
en_US: Get tenant access token
zh_Hans: |
获取飞书自建应用的 tenant_access_token响应体示例:
{"code":0,"msg":"ok","tenant_access_token":"t-caecc734c2e3328a62489fe0648c4b98779515d3","expire":7200}
tenant_access_token: 租户访问凭证;
expire: tenant_access_token 的过期时间,单位为秒;
llm: A tool for obtaining a tenant access token. The input parameters must include app_id and app_secret.
parameters:
- name: app_id
type: string
required: true
label:
en_US: app_id
zh_Hans: 应用唯一标识
human_description:
en_US: app_id is the unique identifier of the Lark Open Platform application
zh_Hans: app_id 是飞书开放平台应用的唯一标识
llm_description: app_id is the unique identifier of the Lark Open Platform application
form: llm
- name: app_secret
type: secret-input
required: true
label:
en_US: app_secret
zh_Hans: 应用秘钥
human_description:
en_US: app_secret is the secret key of the application
zh_Hans: app_secret 是应用的秘钥
llm_description: app_secret is the secret key of the application
form: llm

View File

@ -0,0 +1,61 @@
import json
from typing import Any, Union
import httpx
from core.tools.entities.tool_entities import ToolInvokeMessage
from core.tools.tool.builtin_tool import BuiltinTool
class ListBaseRecordsTool(BuiltinTool):
def _invoke(self, user_id: str, tool_parameters: dict[str, Any]
) -> Union[ToolInvokeMessage, list[ToolInvokeMessage]]:
url = "https://open.feishu.cn/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/records/search"
access_token = tool_parameters.get('Authorization', '')
if not access_token:
return self.create_text_message('Invalid parameter access_token')
app_token = tool_parameters.get('app_token', '')
if not app_token:
return self.create_text_message('Invalid parameter app_token')
table_id = tool_parameters.get('table_id', '')
if not table_id:
return self.create_text_message('Invalid parameter table_id')
page_token = tool_parameters.get('page_token', '')
page_size = tool_parameters.get('page_size', '')
sort_condition = tool_parameters.get('sort_condition', '')
filter_condition = tool_parameters.get('filter_condition', '')
headers = {
'Content-Type': 'application/json',
'Authorization': f"Bearer {access_token}",
}
params = {
"page_token": page_token,
"page_size": page_size,
}
payload = {
"automatic_fields": True
}
if sort_condition:
payload["sort"] = json.loads(sort_condition)
if filter_condition:
payload["filter"] = json.loads(filter_condition)
try:
res = httpx.post(url.format(app_token=app_token, table_id=table_id), headers=headers, params=params,
json=payload, timeout=30)
res_json = res.json()
if res.is_success:
return self.create_text_message(text=json.dumps(res_json))
else:
return self.create_text_message(
f"Failed to list base records, status code: {res.status_code}, response: {res.text}")
except Exception as e:
return self.create_text_message("Failed to list base records. {}".format(e))

View File

@ -0,0 +1,108 @@
identity:
name: list_base_records
author: Doug Lea
label:
en_US: List Base Records
zh_Hans: 查询多维表格数据表中的现有记录
description:
human:
en_US: List base records
zh_Hans: |
查询多维表格数据表中的现有记录,单次最多查询 500 行记录,支持分页获取。
llm: Query existing records in a multidimensional table data table. A maximum of 500 rows of records can be queried at a time, and paging retrieval is supported.
parameters:
- name: Authorization
type: string
required: true
label:
en_US: token
zh_Hans: 凭证
human_description:
en_US: API access token parameter, tenant_access_token or user_access_token
zh_Hans: API 的访问凭证参数tenant_access_token 或 user_access_token
llm_description: API access token parameter, tenant_access_token or user_access_token
form: llm
- name: app_token
type: string
required: true
label:
en_US: app_token
zh_Hans: 多维表格
human_description:
en_US: bitable app token
zh_Hans: 多维表格的唯一标识符 app_token
llm_description: bitable app token
form: llm
- name: table_id
type: string
required: true
label:
en_US: table_id
zh_Hans: 多维表格的数据表
human_description:
en_US: bitable table id
zh_Hans: 多维表格数据表的唯一标识符 table_id
llm_description: bitable table id
form: llm
- name: page_token
type: string
required: false
label:
en_US: page_token
zh_Hans: 分页标记
human_description:
en_US: Pagination mark. If it is not filled in the first request, it means to traverse from the beginning.
zh_Hans: 分页标记,第一次请求不填,表示从头开始遍历。
llm_description: 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token下次遍历可采用该 page_token 获取查询结果。
form: llm
- name: page_size
type: number
required: false
default: 20
label:
en_US: page_size
zh_Hans: 分页大小
human_description:
en_US: paging size
zh_Hans: 分页大小,默认值为 20最大值为 100。
llm_description: The default value of paging size is 20 and the maximum value is 100.
form: llm
- name: sort_condition
type: string
required: false
label:
en_US: sort_condition
zh_Hans: 排序条件
human_description:
en_US: sort condition
zh_Hans: |
排序条件,格式为:[{"field_name":"多行文本","desc":true}]。
field_name: 字段名称;
desc: 是否倒序排序;
llm_description: |
Sorting conditions, the format is: [{"field_name":"multi-line text","desc":true}].
form: llm
- name: filter_condition
type: string
required: false
label:
en_US: filter_condition
zh_Hans: 筛选条件
human_description:
en_US: filter condition
zh_Hans: |
筛选条件,格式为:{"conjunction":"and","conditions":[{"field_name":"字段1","operator":"is","value":["文本内容"]}]}。
conjunction条件逻辑连接词
conditions筛选条件集合
field_name筛选条件的左值值为字段的名称
operator条件运算符
value目标值
llm_description: |
The format of the filter condition is: {"conjunction":"and","conditions":[{"field_name":"Field 1","operator":"is","value":["text content"]}]}.
form: llm

View File

@ -0,0 +1,46 @@
import json
from typing import Any, Union
import httpx
from core.tools.entities.tool_entities import ToolInvokeMessage
from core.tools.tool.builtin_tool import BuiltinTool
class ListBaseTablesTool(BuiltinTool):
def _invoke(self, user_id: str, tool_parameters: dict[str, Any]
) -> Union[ToolInvokeMessage, list[ToolInvokeMessage]]:
url = "https://open.feishu.cn/open-apis/bitable/v1/apps/{app_token}/tables"
access_token = tool_parameters.get('Authorization', '')
if not access_token:
return self.create_text_message('Invalid parameter access_token')
app_token = tool_parameters.get('app_token', '')
if not app_token:
return self.create_text_message('Invalid parameter app_token')
page_token = tool_parameters.get('page_token', '')
page_size = tool_parameters.get('page_size', '')
headers = {
'Content-Type': 'application/json',
'Authorization': f"Bearer {access_token}",
}
params = {
"page_token": page_token,
"page_size": page_size,
}
try:
res = httpx.get(url.format(app_token=app_token), headers=headers, params=params, timeout=30)
res_json = res.json()
if res.is_success:
return self.create_text_message(text=json.dumps(res_json))
else:
return self.create_text_message(
f"Failed to list base tables, status code: {res.status_code}, response: {res.text}")
except Exception as e:
return self.create_text_message("Failed to list base tables. {}".format(e))

View File

@ -0,0 +1,65 @@
identity:
name: list_base_tables
author: Doug Lea
label:
en_US: List Base Tables
zh_Hans: 根据 app_token 获取多维表格下的所有数据表
description:
human:
en_US: List base tables
zh_Hans: |
根据 app_token 获取多维表格下的所有数据表
llm: A tool for getting all data tables under a multidimensional table based on app_token.
parameters:
- name: Authorization
type: string
required: true
label:
en_US: token
zh_Hans: 凭证
human_description:
en_US: API access token parameter, tenant_access_token or user_access_token
zh_Hans: API 的访问凭证参数tenant_access_token 或 user_access_token
llm_description: API access token parameter, tenant_access_token or user_access_token
form: llm
- name: app_token
type: string
required: true
label:
en_US: app_token
zh_Hans: 多维表格
human_description:
en_US: bitable app token
zh_Hans: 多维表格的唯一标识符 app_token
llm_description: bitable app token
form: llm
- name: page_token
type: string
required: false
label:
en_US: page_token
zh_Hans: 分页标记
human_description:
en_US: Pagination mark. If it is not filled in the first request, it means to traverse from the beginning.
zh_Hans: 分页标记,第一次请求不填,表示从头开始遍历。
llm_description: |
Pagination token. If it is not filled in the first request, it means to start traversal from the beginning.
If there are more items in the pagination query result, a new page_token will be returned at the same time.
The page_token can be used to obtain the query result in the next traversal.
分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token下次遍历可采用该 page_token 获取查询结果。
form: llm
- name: page_size
type: number
required: false
default: 20
label:
en_US: page_size
zh_Hans: 分页大小
human_description:
en_US: paging size
zh_Hans: 分页大小,默认值为 20最大值为 100。
llm_description: The default value of paging size is 20 and the maximum value is 100.
form: llm

View File

@ -0,0 +1,47 @@
import json
from typing import Any, Union
import httpx
from core.tools.entities.tool_entities import ToolInvokeMessage
from core.tools.tool.builtin_tool import BuiltinTool
class ReadBaseRecordTool(BuiltinTool):
def _invoke(self, user_id: str, tool_parameters: dict[str, Any]
) -> Union[ToolInvokeMessage, list[ToolInvokeMessage]]:
url = "https://open.feishu.cn/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/records/{record_id}"
access_token = tool_parameters.get('Authorization', '')
if not access_token:
return self.create_text_message('Invalid parameter access_token')
app_token = tool_parameters.get('app_token', '')
if not app_token:
return self.create_text_message('Invalid parameter app_token')
table_id = tool_parameters.get('table_id', '')
if not table_id:
return self.create_text_message('Invalid parameter table_id')
record_id = tool_parameters.get('record_id', '')
if not record_id:
return self.create_text_message('Invalid parameter record_id')
headers = {
'Content-Type': 'application/json',
'Authorization': f"Bearer {access_token}",
}
try:
res = httpx.get(url.format(app_token=app_token, table_id=table_id, record_id=record_id), headers=headers,
timeout=30)
res_json = res.json()
if res.is_success:
return self.create_text_message(text=json.dumps(res_json))
else:
return self.create_text_message(
f"Failed to read base record, status code: {res.status_code}, response: {res.text}")
except Exception as e:
return self.create_text_message("Failed to read base record. {}".format(e))

View File

@ -0,0 +1,60 @@
identity:
name: read_base_record
author: Doug Lea
label:
en_US: Read Base Record
zh_Hans: 根据 record_id 的值检索多维表格数据表的记录
description:
human:
en_US: Read base record
zh_Hans: |
根据 record_id 的值检索多维表格数据表的记录
llm: Retrieve records from a multidimensional table based on the value of record_id
parameters:
- name: Authorization
type: string
required: true
label:
en_US: token
zh_Hans: 凭证
human_description:
en_US: API access token parameter, tenant_access_token or user_access_token
zh_Hans: API 的访问凭证参数tenant_access_token 或 user_access_token
llm_description: API access token parameter, tenant_access_token or user_access_token
form: llm
- name: app_token
type: string
required: true
label:
en_US: app_token
zh_Hans: 多维表格
human_description:
en_US: bitable app token
zh_Hans: 多维表格的唯一标识符 app_token
llm_description: bitable app token
form: llm
- name: table_id
type: string
required: true
label:
en_US: table_id
zh_Hans: 多维表格的数据表
human_description:
en_US: bitable table id
zh_Hans: 多维表格数据表的唯一标识符 table_id
llm_description: bitable table id
form: llm
- name: record_id
type: string
required: true
label:
en_US: record_id
zh_Hans: 单条记录的 id
human_description:
en_US: The id of a single record
zh_Hans: 单条记录的 id
llm_description: The id of a single record
form: llm

View File

@ -0,0 +1,56 @@
import json
from typing import Any, Union
import httpx
from core.tools.entities.tool_entities import ToolInvokeMessage
from core.tools.tool.builtin_tool import BuiltinTool
class UpdateBaseRecordTool(BuiltinTool):
def _invoke(self, user_id: str, tool_parameters: dict[str, Any]
) -> Union[ToolInvokeMessage, list[ToolInvokeMessage]]:
url = "https://open.feishu.cn/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/records/{record_id}"
access_token = tool_parameters.get('Authorization', '')
if not access_token:
return self.create_text_message('Invalid parameter access_token')
app_token = tool_parameters.get('app_token', '')
if not app_token:
return self.create_text_message('Invalid parameter app_token')
table_id = tool_parameters.get('table_id', '')
if not table_id:
return self.create_text_message('Invalid parameter table_id')
record_id = tool_parameters.get('record_id', '')
if not record_id:
return self.create_text_message('Invalid parameter record_id')
fields = tool_parameters.get('fields', '')
if not fields:
return self.create_text_message('Invalid parameter fields')
headers = {
'Content-Type': 'application/json',
'Authorization': f"Bearer {access_token}",
}
params = {}
payload = {
"fields": json.loads(fields)
}
try:
res = httpx.put(url.format(app_token=app_token, table_id=table_id, record_id=record_id), headers=headers,
params=params, json=payload, timeout=30)
res_json = res.json()
if res.is_success:
return self.create_text_message(text=json.dumps(res_json))
else:
return self.create_text_message(
f"Failed to update base record, status code: {res.status_code}, response: {res.text}")
except Exception as e:
return self.create_text_message("Failed to update base record. {}".format(e))

View File

@ -0,0 +1,78 @@
identity:
name: update_base_record
author: Doug Lea
label:
en_US: Update Base Record
zh_Hans: 更新多维表格数据表中的一条记录
description:
human:
en_US: Update base record
zh_Hans: |
更新多维表格数据表中的一条记录详细请参考https://open.larkoffice.com/document/server-docs/docs/bitable-v1/app-table-record/update
llm: Update a record in a multidimensional table data table
parameters:
- name: Authorization
type: string
required: true
label:
en_US: token
zh_Hans: 凭证
human_description:
en_US: API access token parameter, tenant_access_token or user_access_token
zh_Hans: API 的访问凭证参数tenant_access_token 或 user_access_token
llm_description: API access token parameter, tenant_access_token or user_access_token
form: llm
- name: app_token
type: string
required: true
label:
en_US: app_token
zh_Hans: 多维表格
human_description:
en_US: bitable app token
zh_Hans: 多维表格的唯一标识符 app_token
llm_description: bitable app token
form: llm
- name: table_id
type: string
required: true
label:
en_US: table_id
zh_Hans: 多维表格的数据表
human_description:
en_US: bitable table id
zh_Hans: 多维表格数据表的唯一标识符 table_id
llm_description: bitable table id
form: llm
- name: record_id
type: string
required: true
label:
en_US: record_id
zh_Hans: 单条记录的 id
human_description:
en_US: The id of a single record
zh_Hans: 单条记录的 id
llm_description: The id of a single record
form: llm
- name: fields
type: string
required: true
label:
en_US: fields
zh_Hans: 数据表的列字段内容
human_description:
en_US: The fields of a multidimensional table data table, that is, the columns of the data table.
zh_Hans: |
要更新一行多维表格记录,字段结构拼接如下:{"多行文本":"多行文本内容","单选":"选项1","多选":["选项1","选项2"],"复选框":true,"人员":[{"id":"ou_2910013f1e6456f16a0ce75ede950a0a"}],"群组":[{"id":"oc_cd07f55f14d6f4a4f1b51504e7e97f48"}],"电话号码":"13026162666"}
当前接口支持的字段类型为:多行文本、单选、条码、多选、日期、人员、附件、复选框、超链接、数字、单向关联、双向关联、电话号码、地理位置。
不同类型字段的数据结构请参考数据结构概述https://open.larkoffice.com/document/server-docs/docs/bitable-v1/bitable-structure
llm_description: |
要更新一行多维表格记录,字段结构拼接如下:{"多行文本":"多行文本内容","单选":"选项1","多选":["选项1","选项2"],"复选框":true,"人员":[{"id":"ou_2910013f1e6456f16a0ce75ede950a0a"}],"群组":[{"id":"oc_cd07f55f14d6f4a4f1b51504e7e97f48"}],"电话号码":"13026162666"}
当前接口支持的字段类型为:多行文本、单选、条码、多选、日期、人员、附件、复选框、超链接、数字、单向关联、双向关联、电话号码、地理位置。
不同类型字段的数据结构请参考数据结构概述https://open.larkoffice.com/document/server-docs/docs/bitable-v1/bitable-structure
form: llm