info--火山方舟大模型服务平台-火山引擎

文档中心

立即注册

导航

info

最近更新时间：2025.01.08 22:16:12首次发布时间：2024.12.16 16:46:41

概述

/api/knowledge/doc/info 接口用于查看知识库下的某个文档的信息。

前提条件

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

请求接口

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

请求参数

参数	类型	是否必选	默认值	参数说明
collection_name	string	否	--	知识库名称只能使用英文字母、数字、下划线_，并以英文字母开头，不能为空长度要求：[1, 64]
project	string	否	default	知识库所属项目即在【访问控制】-【资源管理】-【项目】中创建的项目
resource_id	string	否	--	知识库唯一 id 可选择直接传 resource_id，或同时传 name 和 project 作为知识库的唯一标识
doc_id	string	是	--	知识库下所要查看文档的 id

响应消息

参数	参数说明
code	状态码
message	返回信息
request_id	标识每个请求的唯一标识符
data	{ "collection_name": "demo_0802_max_doc", // 知识库的名字 "doc_name": "demo5998.docx", // 文档名称 "doc_id": "_sys_auto_gen_doc_id-7640337689828908158", // 文档id "add_type": "tos", // 文档的导入方式 "doc_type": "docx", // 文档的类型 "create_time": 1722582241526, // 文档的上传时间 "added_by": "adder@bytedance.com", // 文档的上传者 "update_time": 1722607238013, // 文档的更新时间 "url": // 文档的下载链接（add_type为url时会带有这个字段） "tos_path": "doc-5000/doc-5000-01/demo5998.docx", // 文档所在的tos目录（add_type为tos时会带有这个字段） "meta": // 文档的meta信息，需用户在添加文档时主动添加，若为空则不返回该参数 "point_num": 3, // 文档提取出的point数量 "status": { "process_status": 0, // 文档的处理状态，0表示处理完成，1表示处理失败，5表示删除中，其他表示处理中 "failed_code": // 文档处理失败的错误码，若为空则不返回该参数，具体含义见下方说明 } }

failed_code说明

failed_code	错误描述	处理建议
10001	文档下载超时	请上传重试。如果问题仍然存在，请联系我们
10002	未知错误，请联系我们	未知错误，请联系我们
10003	url 校验失败，请确认 url 链接	请确认 url 链接正确后重试。如果问题仍然存在，请联系我们
10004	未知错误，请联系我们	未知错误，请联系我们
10005	飞书文档获取异常，请确认有效且授权	请确认飞书文档权限问题，通过飞书开放平台 OpenAPI 飞书开放平台确认权限
2000x	未知错误，请联系我们	未知错误，请联系我们
2100x	未知错误，请联系我们	未知错误，请联系我们
30001	超过知识库文件限制大小	超过知识库配额限制。配额说明参考
35001	超过知识库切片数量限制	超过知识库配额限制。配额说明参考
35002	FAQ 文档解析为空	FAQ 文档解析结果为空，切片数为 0。请确保文档中包含有效数据
35004	超过知识库 FAQ 文档 sheet 数量限制	超过知识库配额限制。配额说明参考
35200	未知错误，请联系我们	未知错误，请联系我们
3620x	未知错误，请联系我们	未知错误，请联系我们
36003	结构化文档表头不匹配	结构化文档表头不匹配，请确保上传文档中每个 sheet 的表头与预定义的知识库表结构完全一致
36004	结构化文档数据类型转换失败	结构化文档数据类型转换失败，请确保上传文档中每个 sheet 的单元格的内容格式与预定义的知识库表结构数据类型完全一致
36005	超过知识库结构化文档 sheet 数量限制	超过知识库配额限制。配额说明参考
36006	超过知识库结构化文档有效行数限制	超过知识库配额限制。配额说明参考
36007	结构化文档解析为空	结构化文档解析结果为空，切片数为 0。请确保文档中包含有效数据
4000x	未知错误，请联系我们	未知错误，请联系我们
50001	未知错误，请联系我们	未知错误，请联系我们
6000x	未知错误，请联系我们	未知错误，请联系我们
7000x	未知错误，请联系我们	未知错误，请联系我们
8000x	未知错误，请联系我们	未知错误，请联系我们
10000000x	未知错误，请联系我们	未知错误，请联系我们
11000x	未知错误，请联系我们	未知错误，请联系我们
99999	未知错误，请联系我们	未知错误，请联系我们

状态码说明

状态码	http状态码	返回信息	状态码说明
0	200	success	成功
1000001	401	unauthorized	鉴权失败
1000002	403	no permission	权限不足
1000003	400	invalid request：%s	非法参数
1000005	400	collection not exist	collection不存在
1001001	400	doc not exist	doc不存在

完整示例

请求消息

curl -i -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: HMAC-SHA256 ***' \
  https://api-knowledgebase.mlp.cn-beijing.volces.com/api/knowledge/doc/info \
  -d '{
    "collection_name": "test_collection_name"，
    "project": "",
    "doc_id": "test123"
}'

响应消息

执行成功返回：

HTTP/1.1 200 OK
Content-Length: 43
Content-Type: application/json
 
{
    "code":0,
    "data":{
        "collection_name": "test_collection_name",
        "doc_name": "张某某盗窃案",
        "doc_id": "test0123",
        "add_type": "url",
        "doc_type": "pdf",
        "create_time": 1711367027047,
        "added_by": "xiejianqiao.1027@bytedance.com",
        "update_time": 1711367030802,
        "url": "https://fwh-my-test-bucket.tos-cn-beijing.volces.com/%E6%96%B0%E6%A9%99%E7%A7%91%E6%8A%80/%E5%91%A8%E6%9D%A8%E7%9B%97%E7%AA%83%E6%A1%88.pdf?X-Tos-Algorithm=TOS4-HMAC-SHA256\u0026X-Tos-Content-Sha256=UNSIGNED-PAYLOAD\u0026X-Tos-Credential=AKTP0UZNtgnE7Lfth5eB2z0Z9qy2gyewikK9nbStjHp0OY%2F20240325%2Fcn-beijing%2Ftos%2Frequest\u0026X-Tos-Date=20240325T114024Z\u0026X-Tos-Expires=3600\u0026X-Tos-SignedHeaders=host\u0026X-Tos-Security-Token=nCgdqdEROend3.ChsKBzNzX056d3cSEGBgA9av-UtVs7ClfMkXS4oQk8WFsAYYo-GFsAYgle7V6QcoAjCSkLEJOhx6aGFpeXVqaWEuMDMyMkBieXRlZGFuY2UuY29tQgN0b3NSHHpoYWl5dWppYS4wMzIyQGJ5dGVkYW5jZS5jb21YBGAB.Nur_XCwZ_1LHmSsfeWGjDUn8SEOo3c6op5hx3lUgLZuxtHN_sqs-Kd0KbKw-51CT6wXKQo3AbmidScqVTu6gLQ\u0026X-Tos-Signature=5c3dff2f8cd67daae99476d54188033cc32932d87f1ff85f4f1afd5862fa35cd",
        "point_num": 53,
        "status" :{
            "process_status":0
        }
    },
    "message":"success",
    "request_id":"02171136054666600000000000000000000ffff0a0060163f95e1"
}

执行失败返回：

HTTP/1.1 400 OK
Content-Length: 43
Content-Type: application/json
 
{"code":1000003, "message":"invalid request：%s", "request_id": "021695029757920fd001de6666600000000000000000002569b8f"}