目录
1.1 创建飞书开放平台应用
1.1.1 打开地址:飞书开放平台,点击创建应用
注:商店应用需要申请ISV资质,填写企业主体信息,个人的话,选择【创建企业自建应用】
商店应用:
企业自建应用
点击【创建】按钮创建成功后如下:
配置应用操作多维表格的权限
配置完成后需要发布应用才会生效,进入【版本管理与发布 _ 创建版本】
发布完成后,添加多维表格,并且添加应用权限
1.2 创建飞书多维表格
登录飞书 _> 新建多维表格:https://fcnm73x3rsfr.feishu.cn/drive/home
将应用添加为多维表格协作者
通过应用API向多维表格插入一条记录,进入飞书开放平台-> 权限管理 -> 进入API调试台。
点击击【相关API事件 _ API新增多条记录】跳转到API开发文档,可以打开【API调试台】进行接口调试
获取app_token(即base_id) 和 table_id
调用成功
通过飞书开放平台应用将数据写入多维表格成功
企业自建应用开发流程文档:
https://open.feishu.cn/document/home/introduction-to-custom-app-development/self-built-application-development-process
1.3 创建扣子平台插件
1.3.1 登录扣子平台:扣子
创建插件
创建工具(插件包含一个或多个工具)
添加输入参数
输入参数添加成功后,此处可以通过输入参数首字母,就是自动弹出输入参数的提示下拉框供选择
代码写完后,点此处运行
此处需要替换为自己的飞书应用id,才能获取到正确的token
飞书开放平台的app_id 和 app_secret在这里获取
返回400或403报错参考飞书开放平台API:新增多条记录 - 服务端 API - 飞书开放平台
上面标红框的部分需要替换为自己飞书多维表格的base_id和table_id,前面创建飞书多维表格流程中有标识base_id(即app_token)和table_id 的地方
以上报错403是飞书开放平台的应用没有飞书多维表格的权限,同时检查app_id和app_secret,如果这两个值不正确,也会报403
1. 需要在多维表格中将飞书应用添加为协作者
2. 需要开启飞书多维表格高级权限
前面添加的飞书应用协作者会在这里显示
再次点击运行按钮,显示成功,同时飞书多维表格会新增相应数据
扣子平台插件工具输入参数如下:
{"c_index":1,
"c_data" : "\n{\n \"人物列表\": [\n {\n \"姓名\": \"陈德修\",\n \"年龄\": \"50岁左右\",\n \"性别\": \"男\",\n \"身高\": \"\",\n \"体重\": \"\",\n \"五官特征\": \"戴着厚厚的金丝眼镜\",\n \"身形描述\": \"地中海发型\",\n \"性格标签\": \"德高望重;医者仁心\",\n \"穿着打扮\": \"医生职业装\",\n \"神态动作\": \"无奈地叹息;递诊断书—动作沉稳\"\n },\n {\n \"姓名\": \"庄子昂\",\n \"年龄\": \"18岁\",\n \"性别\": \"男\",\n \"身高\": \"\",\n \"体重\": \"\",\n \"五官特征\": \"斯文气质;眼角有泪痕—动态\",\n \"身形描述\": \"青葱少年\",\n \"性格标签\": \"循规蹈矩;情绪压抑;故作轻松\",\n \"穿着打扮\": \"艳俗花衬衫—五彩斑斓;沾消毒水味的衣服\",\n \"神态动作\": \"浑浑噩噩走路—撞倒共享单车;手颤抖握诊断书;挤苦涩笑容\"\n },\n {\n \"姓名\": \"林慕诗\",\n \"年龄\": \"约18岁\",\n \"性别\": \"女\",\n \"身高\": \"\",\n \"体重\": \"\",\n \"五官特征\": \"丹凤眼;牛奶般白皙肌肤\",\n \"身形描述\": \"颇具规模的胸脯—动态起伏\",\n \"性格标签\": \"傲娇;外冷内热\",\n \"穿着打扮\": \"\",\n \"神态动作\": \"轻抿奶茶—动作优雅;瞪丹凤眼质问\"\n },\n {\n \"姓名\": \"李黄轩\",\n \"年龄\": \"约18岁\",\n \"性别\": \"男\",\n \"身高\": \"\",\n \"体重\": \"\",\n \"五官特征\": \"\",\n \"身形描述\": \"瘦高个\",\n \"性格标签\": \"活泼;爱调侃\",\n \"穿着打扮\": \"\",\n \"神态动作\": \"大笑着调侃;揽肩膀—动作亲昵\"\n }\n ]\n}\n"
}
扣子平台插件工具代码如下:
import json
import requests
from runtime import Args
from typings.write_data_to_feishu_excel.write_data_to_feishu_excel import Input, Output
"""
Each file needs to export a function named `handler`. This function is the entrance to the Tool.
Parameters:
args: parameters of the entry function.
args.input - input parameters, you can get test input value by args.input.xxx.
args.logger - logger instance used to print logs, injected by runtime.
Remember to fill in input/output in Metadata, it helps LLM to recognize and use tool.
Return:
The return data of the function, which should match the declared output parameters.
"""
class Output:
def __init__(self, code: int, message: str, data: str):
self.code = code
self.message = message
self.data = data
# 此处handler命名不能更改
def handler(args: Args[Input])->Output:
args.logger.info(f"输入参数{args.input}")
# 检查 args.input 是否为 None
if args.input is None:
return Output(code=400, message="args.input 为 None,请检查传入的参", data="")
# 替换为实际值
token = getFeishuToken(args)
args.logger.info(f"当前token值:{token}")
base_id = "飞书多维表格的base_id"
table_id = "飞书多维表格的table_id"
characters = args.input.c_data
if not characters:
return Output(code=500, message="缺少必要参数: c_data",data="")
json_data = getCharactersData(args, characters)
args.logger.info(f"写入数据:{json_data}")
# 构造请求体
data = {
"records": json_data
# "records": [
# {
# "fields": json_obj
# }
# ]
}
# 单行数据写入API地址
#https://open.feishu.cn/open-apis/bitable/v1/apps/飞书多维表格的base_id/tables/飞书多维表格的table_id/records
# 多行数据写入,调用写入 API
url = f"https://open.feishu.cn/open-apis/bitable/v1/apps/{base_id}/tables/{table_id}/records/batch_create"
args.logger.info(f"飞书多维表格写入地址{url}")
headers = {
"Authorization": f"Bearer {token}",
"Content-Type": "application/json",
#'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36',
}
try:
response = requests.post(url, json=data , headers=headers)
response.raise_for_status()
args.logger.info(f"Data written result:{response.json()}")
except requests.exceptions.RequestException as e:
args.logger.info(f"Request error:{e}")
return Output(code=500, message="失败", data="API请求异常")
except ValueError as e:
args.logger.info(f"JSON parsing error:{e}")
return Output(code=500, message="失败", data="json数据转换异常")
except Exception as e:
args.logger.info(f"An unknown error occurred:{e}")
return Output(code=500, message="失败", data=f"An unknown error occurred:{e}")
return Output(code=200, message="成功", data=str(data))
# 解析输入的内容(示例数据是json格式)
def getCharactersData(args, input_data):
args.logger.info(f"当前输入参数:{input_data}")
json_data = []
# 如果输入是字符串则解析,否则直接使用
if isinstance(input_data, str):
# 清除输入内容中的json标识
json_data = json.loads(input_data.replace("```","").replace("json",""))
else:
# 假设已经是解析好的对象
json_data = input_data
# 强制转换为列表(确保可迭代性)(示例)
#if not isinstance(json_data, list):
# json_data = [json_data]
# 自动获取JSON键作为列名(示例)
#columns = list(flattened_data[0].keys())
# 扁平化数据结构
flattened_data = []
for index, item in enumerate(json_data["人物列表"]):
# 3.1 确保item是字典类型
#if not isinstance(item, dict):
# 非字典类型特殊处理
# item = {"raw_data": item}
# 需确保所有字段存在(防止KeyError),此处json的key名和飞书多维表格列名一致,故使用copy方法
flat_item = item.copy()
flat_item['章节'] = str(args.input.c_index)
# 若json的key名和飞书多维表格列名不一致,此处进行转换name为飞书多维表格列名,姓名为json数据的key名
# flat_item = {
# 'name': item.get('姓名', ""),
# 'age': item.get('年龄区间', ""),
# 'features': item.get('五官特征', ""),
# 'body': item.get('身形描述', ""),
# 'temperament': item.get('性格标签', ""),
# 'dress': item.get('穿着打扮', ""),
# 'look': item.get('神态动作', ""),
# 'sex': item.get('性别', ""),
# 'height': item.get('身高', ""),
# 'weight': item.get('体重', "")
# }
# 3.3 若输入的json数据存在嵌套,处理嵌套结构(示例)
if 'appearance' in item:
appearance = item.get('appearance', {})
flat_item.update({
'features': str(appearance.get('五官特征', '')),
'body': str(appearance.get('身形描述', ''))
})
# 飞书开放平台API中行数据是放在fields对象中的,多行就是多个fields对象
flattened_data.append({"fields": flat_item})
return flattened_data
# 获取访问令牌token
def getFeishuToken(args):
token_url = "https://open.feishu.cn/open-apis/auth/v3/tenant_access_token/internal"
token_response = requests.post(token_url, json={
"app_id": "飞书开放平台应用的app_id",
"app_secret": "飞书开放平台应用的app_secret"
})
#注意:令牌有效期为 2 小时,需定期刷新
#响应token:{'code': 0, 'expire': 7200, 'msg': 'ok', 'tenant_access_token': 't-g104439u6OYLPGRXP656CNK27CSDYNNNUFTMKRFT'}
res = token_response.json()
args.logger.info(f"响应token{res}")
return token_response.json()["tenant_access_token"]