file/search--向量数据库VikingDB-火山引擎

文档中心

导航

file/search

最近更新时间：2024.11.21 16:50:01首次发布时间：2024.11.21 16:50:01

概述

/api/knowledge/lark/file/search 用于查阅文件夹/wiki分页。更多信息可参考可通过飞书开放平台OpenAPIhttps://open.larkoffice.com/document/server-docs/docs/faq。

前提条件

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

请求接口

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

请求参数

参数	类型	是否必填	默认值	参数说明
file_type	string	否	folder	集合类型 folder-文件夹(我的空间) wiki-知识库
data_type	string	是	--	数据类型 unstructured_data-非结构化文档 structured_data-结构化文档
parent_token	string	否	--	父节点token 从请求response获取，如果是第一次请求不填
query	string	否	--	关键词搜索仅支持 wiki 搜索关键词

响应消息

参数	参数说明
code	状态码
message	返回信息
request_id	标识每个请求的唯一标识符
data	{ "items": [ "title": "文档标题", "parent_token": "xxx", "obj_type": "docx", "obj_token": "xxx", "has_child": true/false ] }

完整示例

请求消息

request
{
    "file_type": "wiki",
    "data_type": "unstructured_data",
    "parent_token": "xxx",
    "query": "标题"
}

响应消息

response
{
    "message": "success",
    "code": 0,
    "request_id": "xx",
    "data": {
        "items": [
            "title": "文档标题",
            "parent_token": "xxx",
            "obj_type": "docx",
            "obj_token": "xxx",
            "has_child": true/false,
            "obj_create_time": "1642402428"
        ]
    }
}