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

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

# 查看知识库指定切片信息接口文档
## 一、接口概述
`/api/knowledge/point/info`接口用于获取知识库下指定切片的详细信息，涵盖所属文档、内容、处理时间等多方面内容，帮助用户深入了解特定切片的相关数据。

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

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

## 四、请求参数
|参数|类型|是否必选|默认值|参数说明|
|---|---|---|---|---|
|collection_name|string|否|--|知识库的名字|
|project|string|否|default|知识库所属项目，在【访问控制】-【资源管理】-【项目】中创建|
|resource_id|string|否|--|知识库的唯一id，可直接传该参数，或同时传`name`和`project`作为知识库的唯一标识|
|point_id|string|是|--|知识库下切片的唯一id|
|get_attachment_link|bool|否|False|是否获取切片中图片的临时下载链接|

## 五、响应消息
|参数|参数说明|
|---|---|
|code|状态码|
|message|返回信息|
|request_id|标识每个请求的唯一标识符|
|data|检索返回内容|

### data返回值
|字段|子字段|字段类型|说明|
|---|---|---|---|
|collection_name|--|string|知识库的名字|
|point_id|--|string|知识点id ，在一个知识库下唯一|
|doc_info|doc_id|string|所属文档id|
|doc_info|doc_name|string|文档名字|
|doc_info|create_time|int|创建时间|
|doc_info|doc_type|string|知识所属原始文档的类型|
|doc_info|doc_meta|string|文档的原始meta信息|
|doc_info|source|string|知识来源|
|process_time|--|int|知识处理完成的时间|
|chunk_title|--|string|该文本片的父标题，由解析模型识别，无则为空|
|content|--|string|切片内容，非结构化文件为切片内容；faq文件为答案；结构化文件为参与索引的字段和取值，以K:V对拼接，用 \n 区隔|
|chunk_id|--|int|切片在原文档中的顺序位次|
|chunk_type|--|string|切片类型|
|table_chunk_fields|--|list|结构化数据检索返回单行全量数据|
|chunk_attachment|--|list<object>|检索召回附件，chunk_type为image时有效|
|update_time|--|int|更新时间|
|chunk_source|--|string|切片的来源，取值为document或user|

### chunk_attachment返回值
|字段|字段类型|说明|
|---|---|---|
|uuid|string|附件的唯一标识|
|caption|string|图片所属标题，未识别到标题则值为"\n"|
|type|string|如image等|
|link|string|当`get_attachment_link`的值为True时返回图片的临时下载链接，有效期10分钟|

## 六、状态码说明
|状态码|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不存在|
|1002001|400|point not exist|point_id不存在|

## 七、完整示例
### （一）请求消息
```bash
curl -i -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: HMAC-SHA256 ***' \
  https://api-knowledgebase.mlp.cn-beijing.volces.com/api/knowledge/point/info \
  -d '{
    "resource_id": "xxx",
    "point_id":"test_point_id"
}'
```

### （二）响应消息
1. **执行成功返回**
```json
{
    "code":0,
    "data":{
        "collection_name":"test",
        "point_id":"_sys_auto_gen_lark_doc_id-29175896809570851-0",
        "process_time":1731054363,
        "content":"a:4\nb:5\nc:6",
        "chunk_id":0,
        "doc_info":{
            "doc_id":"_sys_auto_gen_lark_doc_id-29175896809570851",
            "doc_name":"表格",
            "create_time":1731054262,
            "doc_type":"lark_sheet",
            "doc_meta":"[{\"field_name\":\"doc_id\",\"field_type\":\"string\",\"field_value\":\"_sys_auto_gen_lark_doc_id-291758968095705851\"}]",
            "source":"lark"
        },
        "chunk_type":"structured",
        "table_chunk_fields":[{"field_name":"a","field_value":"4"},{"field_name":"b","field_value":"5"},{"field_name":"c","field_value":"6"}]
    },
    "message":"success",
    "request_id":"02173217505951900000000000000000000ffff0a00787e6d6662"
}
```
2. **执行失败返回**
```json
HTTP/1.1 400 OK
Content-Length: 43
Content-Type: application/json
{"code":1000003, "message":"invalid request：%s", "request_id": "021695029757920fd001de6666600000000000000000002569b8f"}
```