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

文档中心

立即注册

导航

list

最近更新时间：2024.12.16 16:46:53首次发布时间：2024.12.16 16:46:53

概述

/api/knowledge/point/list 接口用于查看知识库下的切片信息，默认按照point_id从小到大排序。

前提条件

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

请求接口

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

请求参数

参数	类型	是否必选	默认值	参数说明
collection_name	string	否		知识库的名字。
project	string	否	default	知识库所属项目，即在【访问控制】-【资源管理】-【项目】中创建的项目。
resource_id	string	否		知识库的唯一id。可选择直接传resource_id，或同时传name和project作为知识库的唯一标识。
offset	int	否	0	表示从结果的第几个后开始取，需要大于等于0。
limit	int	否	-1	表示获取多少个结果，-1表示获取所有。最大值不超过100，每次返回最多不超过100。
doc_ids	list	否		对doc进行筛选，不传或为null表示不筛选doc，传入的size为0将返回空结果。限制list长度，最大长度为100。

响应消息

参数	参数说明
code	状态码
message	返回信息
request_id	标识每个请求的唯一标识符
data	知识点的详细列表 { "collection_name": 知识库的名字 "total_num": 总共有多少个结果 "count" : 本次返回的结果数量 "point_list": [ { "collection_name": 知识库的名字 "point_id": 知识点id //在一个知识库下唯一 "doc_info": { "doc_id": 所属文档id "doc_name": 文档名字 "create_time": 创建时间 "doc_type": 知识所属原始文档的类型 "doc_meta": 文档的原始meta信息 "source": 知识来源（所属文档的来源，url即为url的链接，tos为tos的目录） "title"：知识所属文档的标题 } "process_time": 知识处理完成的时间 "chunk_title": 该文本片的父标题，是由解析模型识别出来的上一层级的标题。若没有上一层级标题则为空 "content": 原始文本加工后的知识内容 } ] }

状态码说明

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

完整示例

请求消息

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

响应消息

执行成功返回：

{
    "code": 0,
    "data": {
        "collection_name": "api0828",
        "total_num": 1,
        "count": 1,
        "point_list": [
            {
                "collection_name": "api0828",
                "point_id": "_sys_auto_gen_doc_id-17691607628519396693-0",
                "process_time": 1724848725,
                "content": "讲解模块:讲解模块：xxxxxx\n子模块:子模块：xxxxx\n问题示例:问题示例：xxxxxx\n记忆化 —— 讲解要点:\n□ 要点1\n□ 要点2\n□ 要点3",
                "chunk_id": 0,
                "doc_info": {
                    "doc_id": "_sys_auto_gen_doc_id-17691607628519396693",
                    "doc_name": "演示表格.xlsx",
                    "create_time": 1724848720,
                    "doc_type": "xlsx",
                    "source": "tos_fe"
                },
                "chunk_type": "structured",
                "table_chunk_fields": [
                    {
                        "field_name": "讲解模块",
                        "field_value": "讲解模块：xxxxxx"
                    },
                    {
                        "field_name": "子模块",
                        "field_value": "子模块：xxxxx"
                    },
                    {
                        "field_name": "问题示例",
                        "field_value": "问题示例：xxxxxx"
                    },
                    {
                        "field_name": "记忆化 —— 讲解要点",
                        "field_value": "□ 要点1\n□ 要点2\n□ 要点3"
                    }
                ]
            }
        ]
    },
    "message": "success",
    "request_id": "02172484891424400000000000000000000ffff0a00705414b331"
}

执行失败返回：

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