list_docs用于查看某个知识库下的所有文档信息,默认按照文档的上传时间从晚到早排序。
参数 | 类型 | 是否必选 | 默认值 | 参数说明 |
---|---|---|---|---|
project | string | 否 | default | 知识库所属项目,即在【访问控制】-【资源管理】-【项目】中创建的项目。 |
offset | int | 否 | 0 | 表示从结果的第几个后开始取,需要大于等于0。 |
limit | int | 否 | -1 | 表示获取多少个结果,-1表示获取所有。最大值不超过100,每次返回最多不超过100。 |
doc_type | list | 否 | 不传或字段值为null表示不筛选,空的list不会返回任何结果。 |
my_collection = viking_knowledgebase_service.get_collection("example") docs = my_collection.list_docs()
Python 调用执行上面的任务,返回Doc实例列表。Doc实例包含的属性如下表所示。
属性 | 类型 | 说明 |
---|---|---|
collection_name | string | 索引所属的collection名 |
doc_name | string | 文档名字 |
doc_id | string | 文档id |
doc_type | string | 文档类型 |
create_time | string | 创建时间 |
added_by | string | 文档添加人 |
update_time | string | 文档更新时间 |
url | string | 文档上传url路径 |
tos_path | string | 文档上传tos路径 |
point_num | int | 文档下知识点数量 |
status | string | 文档状态 |
title | string | 文档标题 |
source | string | 文档上传来源 |
fields | list | 字段列表 |