调用本接口批量获取知识库内文档的详细信息。
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
doc_ids | Array | 否 | 文档ID列表 |
sha256_list | Array | 否 | sha256列表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
code | Number | 是 | 响应码:0=成功,非0=失败 |
msg | String | 否 | Code非0时,返回错误信息 |
message | String | 否 | 错误信息 |
data | Array | 否 | 文档数据,详情请参见下文 data 表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
create_time | Number | 否 | 创建时间戳 |
create_date | String | 否 | 创建时间 |
update_time | Number | 否 | 更新时间戳 |
update_date | String | 否 | 更新时间 |
id | Number | 是 | 文档ID |
thumbnail | String | 否 | 缩略图 Base64 字符串 |
kb_id | Number | 是 | 知识库ID |
parser_id | String | 是 | 默认解析器ID |
parser_config | Object | 否 | 解析配置 |
source_type | String | 是 | 文档来源 |
type | String | 是 | 文件扩展名 |
created_by | String | 是 | 创建人 |
name | String | 是 | 文件名 |
display_name | String | 否 | 文档展示名称 |
location | String | 否 | 文件存储位置 |
size | Number | 否 | 大小 |
token_num | Number | 是 | Token 数量 |
chunk_num | Number | 是 | 切片数量 |
character_count | Number | 否 | 文档总字符数 |
avg_character_count | Number | 否 | 分段平均字符数 |
progress | Number | 是 | 进度 |
progress_msg | String | 否 | 处理消息 |
task_progress_raw | String | 否 | Sophon 原始 taskProgress 聚合 JSON 字符串 |
process_begin_at | String | 否 | 处理开始时间 |
process_duation | Number | 是 | 处理耗时 |
run | String | 否 | 运行状态:1 运行,2 取消 |
status | String | 否 | 文档状态:0 废弃,1 有效 |
valid_date | String | 否 | 有效日期 |
auto_delete_on_expire | Boolean | 否 | 过期后是否自动删除 |
labels | Array | 否 | 标签信息,详情请参见下文 labels 表 |
category | String | 否 | 分类 |
sha256 | String | 否 | SHA256 摘要 |
retrieval_count | Number | 否 | 检索次数 |
versions | Array | 否 | 版本列表 |
folder_id | Number | 否 | 文件夹ID |
url | String | 否 | 文件 URL |
downloadable | Boolean | 否 | 是否可下载 |
content_category | Array | 否 | 内容分类名称列表,详情请参见下文 |
quality_result | Number | 否 | 质量检测结果 |
spell_check_count | Number | 否 | 错别字检测数量 |
completeness_check_count | Number | 否 | 完整度检测数量 |
sensitive_word_check_count | Number | 否 | 敏感词检测数量 |
is_enabled | Boolean | 否 | 是否启用 |
prep_task_id | Number | 否 | 预处理任务ID |
chunk_settings_type | String | 否 | 当前文档使用的转换切片配置类别 |
prep_file_path | String | 否 | Prep 文件路径 |
actions | Array | 否 | 当前用户对文档的有效权限 |
sub_docs | Array | 否 | 子文档列表,详情请参见下文 sub_docs 表 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
create_time | Number | 否 | 创建时间戳 |
create_date | String | 否 | 创建时间 |
update_time | Number | 否 | 更新时间戳 |
update_date | String | 否 | 更新时间 |
label_id | Number | 是 | 标签ID |
label_name | String | 否 | 标签名称 |
label_type | String | 是 | 文档标签类型
|
label_values | Array | 否 | 标签值列表,详情请参见下文 label_values 表 |
label_value_builder | String | 否 | 标签值构建器
|
prompt_version | String | 否 | 提示词版本 |
label_usage | Number | 否 | 标签使用次数 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
id | Number | 是 | 标签值ID |
value | String | 否 | 标签值 |
value_usage | Number | 否 | 标签值使用次数 |
label_value_builder | String | 否 | 标签值构建器
|
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
id | Number | 是 | 分类ID |
name | String | 否 | 分类名称 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
id | Number | 是 | 子文档ID |
name | String | 是 | 子文档名称 |
chunk_num | Number | 是 | 切片数量 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
create_time | Number | 否 | 创建时间戳 |
create_date | String | 否 | 创建时间 |
update_time | Number | 否 | 更新时间戳 |
update_date | String | 否 | 更新时间 |
id | Number | 是 | 文档ID |
thumbnail | String | 否 | 缩略图 Base64 字符串 |
kb_id | Number | 是 | 知识库ID |
parser_id | String | 是 | 默认解析器ID |
parser_config | Object | 否 | 解析配置 |
source_type | String | 是 | 文档来源 |
type | String | 是 | 文件扩展名 |
created_by | String | 是 | 创建人 |
name | String | 是 | 文件名 |
display_name | String | 否 | 文档展示名称 |
location | String | 否 | 文件存储位置 |
size | Number | 否 | 大小 |
token_num | Number | 是 | Token 数量 |
chunk_num | Number | 是 | 切片数量 |
character_count | Number | 否 | 文档总字符数 |
avg_character_count | Number | 否 | 分段平均字符数 |
progress | Number | 是 | 进度 |
progress_msg | String | 否 | 处理消息 |
task_progress_raw | String | 否 | Sophon 原始 taskProgress 聚合 JSON 字符串 |
process_begin_at | String | 否 | 处理开始时间 |
process_duation | Number | 是 | 处理耗时 |
run | String | 否 | 运行状态:1 运行,2 取消 |
status | String | 否 | 文档状态:0 废弃,1 有效 |
valid_date | String | 否 | 有效日期 |
auto_delete_on_expire | Boolean | 否 | 过期后是否自动删除 |
labels | Array | 否 | 标签信息,详情请参见下文 labels 表 |
category | String | 否 | 分类 |
sha256 | String | 否 | SHA256 摘要 |
retrieval_count | Number | 否 | 检索次数 |
versions | Array | 否 | 版本列表 |
folder_id | Number | 否 | 文件夹ID |
url | String | 否 | 文件 URL |
downloadable | Boolean | 否 | 是否可下载 |
content_category | Array | 否 | 内容分类名称列表,详情请参见下文 |
quality_result | Number | 否 | 质量检测结果 |
spell_check_count | Number | 否 | 错别字检测数量 |
completeness_check_count | Number | 否 | 完整度检测数量 |
sensitive_word_check_count | Number | 否 | 敏感词检测数量 |
is_enabled | Boolean | 否 | 是否启用 |
prep_task_id | Number | 否 | 预处理任务ID |
chunk_settings_type | String | 否 | 当前文档使用的转换切片配置类别 |
prep_file_path | String | 否 | Prep 文件路径 |
actions | Array | 否 | 当前用户对文档的有效权限 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
create_time | Number | 否 | 创建时间戳 |
create_date | String | 否 | 创建时间 |
update_time | Number | 否 | 更新时间戳 |
update_date | String | 否 | 更新时间 |
label_id | Number | 是 | 标签ID |
label_name | String | 否 | 标签名称 |
label_type | String | 是 | 文档标签类型
|
label_values | Array | 否 | 标签值列表,详情请参见下文 label_values 表 |
label_value_builder | String | 否 | 标签值构建器
|
prompt_version | String | 否 | 提示词版本 |
label_usage | Number | 否 | 标签使用次数 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
id | Number | 是 | 标签值ID |
value | String | 否 | 标签值 |
value_usage | Number | 否 | 标签值使用次数 |
label_value_builder | String | 否 | 标签值构建器
|
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
id | Number | 是 | 分类ID |
name | String | 否 | 分类名称 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
create_time | Number | 否 | 创建时间戳 |
create_date | String | 否 | 创建时间 |
update_time | Number | 否 | 更新时间戳 |
update_date | String | 否 | 更新时间 |
id | Number | 是 | 文档ID |
thumbnail | String | 否 | 缩略图 Base64 字符串 |
kb_id | Number | 是 | 知识库ID |
segment_id | Number | 是 | 结构化绑定的分段ID |
properties | Array | 否 | 结构化绑定使用的 CDP 属性,详情请参见下文 properties 表 |
events | Array | 否 | 结构化绑定使用的 CDP 事件,详情请参见下文 events 表 |
details | Array | 否 | 结构化绑定使用的 CDP 业务明细,详情请参见下文 details 表 |
chats | Array | 否 | 结构化绑定使用的 CDP 对话ID |
source_type | String | 是 | 文档来源 |
created_by | String | 是 | 创建人 |
name | String | 是 | 文件名 |
display_name | String | 否 | 文档展示名称 |
id_type_codes | Array | 是 | 结构化绑定使用的 CDP ID 类型 |
size | Number | 否 | 大小 |
token_num | Number | 是 | Token 数量 |
chunk_num | Number | 是 | 切片数量 |
progress | Number | 是 | 进度 |
progress_msg | String | 否 | 处理消息 |
process_begin_at | String | 否 | 处理开始时间 |
process_duation | Number | 是 | 处理耗时 |
run | String | 否 | 运行状态:1 运行,2 取消 |
status | String | 否 | 文档状态:0 废弃,1 有效 |
subject_id | Number | 是 | 主题ID |
valid_date | String | 否 | 有效日期 |
labels | Array | 否 | 标签信息,详情请参见下文 labels 表 |
content_category | Array | 否 | 内容分类名称列表,详情请参见下文 |
quality_result | Number | 否 | 质量检测结果 |
spell_check_count | Number | 否 | 错别字检测数量 |
completeness_check_count | Number | 否 | 完整度检测数量 |
sensitive_word_check_count | Number | 否 | 敏感词检测数量 |
is_enabled | Boolean | 否 | 是否启用 |
actions | Array | 否 | 当前用户对文档的有效权限 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
datasource_id | Number | 是 | 数据源ID |
id | Number | 是 | 元数据ID |
name | String | 是 | 名称 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
datasource_id | Number | 是 | 数据源ID |
id | Number | 是 | 元数据ID |
name | String | 是 | 名称 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
datasource_id | Number | 是 | 数据源ID |
id | Number | 是 | 元数据ID |
name | String | 是 | 名称 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
create_time | Number | 否 | 创建时间戳 |
create_date | String | 否 | 创建时间 |
update_time | Number | 否 | 更新时间戳 |
update_date | String | 否 | 更新时间 |
label_id | Number | 是 | 标签ID |
label_name | String | 否 | 标签名称 |
label_type | String | 是 | 文档标签类型
|
label_values | Array | 否 | 标签值列表,详情请参见下文 label_values 表 |
label_value_builder | String | 否 | 标签值构建器
|
prompt_version | String | 否 | 提示词版本 |
label_usage | Number | 否 | 标签使用次数 |
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
id | Number | 是 | 标签值ID |
value | String | 否 | 标签值 |
value_usage | Number | 否 | 标签值使用次数 |
label_value_builder | String | 否 | 标签值构建器
|
参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
id | Number | 是 | 分类ID |
name | String | 否 | 分类名称 |