@re-ai/volc-knowledge/docs/参考文档/文档/info.md

火山引擎知识库接口接入SDK

# 查看知识库文档信息接口文档
## 一、接口概述
`/api/knowledge/doc/info`接口用于获取知识库下指定文档的详细信息，涵盖文档基本属性、导入方式、处理状态等内容。

## 二、前提条件
完成“签名鉴权方式”页面的注册账号、实名认证、AK/SK密钥获取和签名获取，才能调用该API接口查看文档信息。

## 三、请求接口
|参数|详情|描述|
|---|---|---|
|URI|`/api/knowledge/doc/info`|统一资源标识符|
|请求方法|POST|客户端对向量数据库服务器请求的操作类型|
|请求头|`Content-Type: application/json`<br>`Authorization: HMAC-SHA256 ***`|请求消息类型<br>鉴权|

## 四、请求参数
|参数|类型|是否必选|默认值|参数说明|
|---|---|---|---|---|
|collection_name|string|否|--|知识库名称，由英文字母、数字、下划线组成，以英文字母开头，不能为空，长度在1 - 64之间|
|project|string|否|default|知识库所属项目，在【访问控制】-【资源管理】-【项目】中创建|
|resource_id|string|否|--|知识库唯一id，可单独传该参数，或同时传name和project作为唯一标识|
|doc_id|string|是|--|所要查看文档在知识库下的id|

## 五、响应消息
|参数|参数说明|
|---|---|
|code|状态码|
|message|返回信息|
|request_id|标识每个请求的唯一标识符|
|data|包含文档详细信息，如知识库名称、文档名称、id、导入方式、类型、上传时间、上传者、更新时间、下载链接（add_type为url时）、tos目录（add_type为tos时）、meta信息、提取point数量、处理状态及失败错误码（若有）|

### failed_code报错码及处理建议
|failed_code|错误描述|处理建议|
|---|---|---|
|10001|文档下载超时|上传重试，若问题依旧联系技术支持|
|10003|url校验失败，请确认url链接|确认url链接正确后重试，若问题依旧联系技术支持|
|10005|飞书文档获取异常，请确认有效且授权|确认飞书文档权限，通过飞书开放平台OpenAPI确认|
|30001|超过知识库文件限制大小|参考配额说明，调整文档大小或申请更高配额|
|35001|超过知识库切片数量限制|参考配额说明，调整文档或申请更高配额|
|35002|FAQ文档解析为空|确保FAQ文档包含有效数据|
|35004|超过知识库FAQ文档sheet数量限制|参考配额说明，调整文档或申请更高配额|
|36003|结构化文档表头不匹配|确保上传文档每个sheet的表头与预定义知识库表结构一致|
|36004|结构化文档数据类型转换失败|确保上传文档每个sheet单元格内容格式与预定义知识库表结构数据类型一致|
|36005|超过知识库结构化文档sheet数量限制|参考配额说明，调整文档或申请更高配额|
|36006|超过知识库结构化文档有效行数限制|参考配额说明，调整文档或申请更高配额|
|36007|结构化文档解析为空|确保结构化文档包含有效数据|
|其他错误码|未知错误，请联系我们|联系技术支持|

## 六、状态码说明
|状态码|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不存在|

## 七、完整示例
### （一）请求消息
```bash
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"
}'
```

### （二）响应消息
1. **执行成功返回**
```json
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"
}
```
2. **执行失败返回**
```json
HTTP/1.1 400 OK
Content-Length: 43
Content-Type: application/json
{"code":1000003, "message":"invalid request：%s", "request_id": "021695029757920fd001de6666600000000000000000002569b8f"}
```