文档列表
接口说明
此接口支持多页读取，每次读取量建议控制在50个以内。
请求方式
- 请求方法: POST
- 请求 URL: /v1/ctai/ctai_doc_list
- Content-Type: application/json
请求参数
{
"ctdoc_id": "test_doc_id",
"doc_type": "doc",
"filter_keywords": "test",
"sort_type": "test_id",
"page": "1",
"page_rows": "10"
}
| 参数 | 类型 | 必需 | 参数说明 |
|---|---|---|---|
| ctdoc_id | string | 否 | 文档 id，多个用英文逗号分隔。 |
| doc_type | string | 否 | 文档类型，多个用英文逗号分隔。可选类型： doc：文件类型的文档 url：URL 类型的文档 |
| filter_keywords | string | 否 | 搜索关键字，从文件类型文档的文档名称，或者 URL 类型文档的 url 中模糊搜索。 |
| sort_type | string | 否 | 排序方式，默认是 create_time_asc create_time_asc 按照创建时间由旧到新排序 create_time_desc 按照创建时间由新到旧排序 |
| page | string | 否 | 分页参数，第几页，从 1 开始，默认是 1 |
| page_rows | string | 否 | 分页参数，每页多少条，默认是 1，建议50以内。 |
应答业务参数
{
"total_count": "8",
"ctai_doc_list": [
{
"ctdoc_id": "test_doc_id",
"ctai_doc": {
"doc_type": "doc",
"doc_url": "http://test.com/a.html",
"doc_name": "test_name",
"process_status": "end_succ",
"process_code": "0",
"create_time": "1680010349",
"update_time": "1680010352"
},
// 其他文档信息对象
}
]
}
| 参数 | 类型 | 参数说明 |
|---|---|---|
| total_count | string | 总文档数量，用于分页。 |
| ctai_doc_list | array | 文档列表 |
| ctdoc_id | string | 文档 id |
| ctai_doc | object | 文档信息对象 |
| doc_type | string | 文档类型，取值如下： doc：文件类型的文档 url：URL 类型的文档 |
| doc_url | string | 仅 url 类型的文档有效。URL 类型文档的 url 地址 |
| doc_name | string | 仅 doc 类型的文档有效。文档名称 |
| doc_file_url | string | 文档下载 url |
| process_status | string | 文档处理状态，取值如下： end_succ：处理完成-成功 end_fail：处理完成-失败 其他：正在处理中（正在生成索引等处理） |
| process_code | string | 文档处理错误代码，0 是成功 |
| create_time | string | 创建时间，整数时间戳，单位是秒 |
| update_time | string | 最后修改时间，整数时间戳，单位是秒 |