doc/auth--向量数据库VikingDB-火山引擎

文档中心

导航

doc/auth

最近更新时间：2024.11.21 16:49:52首次发布时间：2024.11.21 16:49:52

概述

/api/knowledge/lark/doc/auth 检查用户身份有飞书链接权限，获取文档相关信息，判断当前火山账号绑定的飞书账号是否有该飞书文档的「导出」权限，并解析文档原信息。更多信息可参考可通过飞书开放平台OpenAPIhttps://open.larkoffice.com/document/server-docs/docs/faq。

前提条件

完成“对接指南“页面的注册账号、实名认证、AK/SK 密钥获取和签名获取后，可调用 API 接口实现知识库的创建功能。

请求接口

URI	/api/knowledge/lark/doc/auth	统一资源标识符
请求方法	POST	客户端对向量数据库服务器请求的操作类型
请求头	Content-Type: application/json	请求消息类型
请求头	Authorization: HMAC-SHA256 ***	鉴权

请求参数

参数	类型	是否必填	默认值	参数说明
lark_url	string	是	--	飞书文档链接支持 wiki 、docs 、电子表格等等
data_type	string	是	--	数据类型 unstructured_data - 非结构化文档：只可上传电子表格 structured_data - 结构化文档：只可上传 docx

响应消息

参数	参数说明
code	状态码
message	返回信息
request_id	标识每个请求的唯一标识符
data	{ "title": "文档标题", // 若data不为空，则有权限，为空则无权限 "parent_token": "xxx", "obj_type": "docx", "obj_token": "xxx", "has_child": true/false, }

完整示例

请求消息

request
{
    "lark_url": "https://bytedance.larkoffice.com/docx/RkS8dIRQgolVVcxgbiXcrW50nWf",
    "data_type": "unstructured_data"
}

响应消息

response
{
    "message": "success",
    "code": 0,
    "request_id": "xx",
    "data": {
        "title": "文档",// 名称  
        "parent_token": "xxx",// 父token
        "obj_type": "docx",
        "obj_token": "xxx",
        "has_child": true/false// 是否有子文件
    }
}
抛出异常例如未绑定，属于无权限