Call this interface paging query specified list of documents in the knowledge base.
Parameter name | Type | Is it necessary to pass on? | Description |
|---|---|---|---|
kb_id | Array | Yes | Knowledge Base ID |
keywords | String | No | keyword |
display_name | String | No | document display name |
page | Number | Yes | page number |
page_size | Number | Yes | number of pages per page |
orderby | String | No | sort field |
desc | Boolean | No | Is it in descending order? |
folder_id | Number | No | Folder ID |
run | Array | No | running state |
create_time_start | String | No | creation start time |
create_time_end | String | No | creation end time |
created_by | Array | No | creator |
prep_task_id | String | No | Preprocessing Task ID |
date | String | No | date |
label_value_ids | Array | No | tag value ID |
is_enabled | Boolean | No | Whether to enable |
Parameter name | Type | Is it necessary to pass on? | Description |
|---|---|---|---|
code | Number | Yes | Response code: 0 = success, non-0 = failure |
msg | String | No | Code is not 0, error message is returned |
message | String | No | error message |
data | Error | Yes | Document data, see the data table below for details |
Parameter name | Type | Is it necessary to pass on? | Description |
|---|---|---|---|
total | Number | Yes | total |
page | Number | Yes | page number |
page_size | Number | Yes | number of pages per page |
item | Array | Yes | Data items, please refer to the item parameter introduction below for details |
Parameter name | Type | Is it necessary to pass on? | Description |
|---|---|---|---|
create_time | Number | No | Create timestamp |
create_date | String | No | creation time |
update_time | Number | No | Update timestamp |
update_date | String | No | update time |
id | Number | Yes | Document ID |
thumbnail | String | No | Thumbnail Base64 string |
kb_id | Number | Yes | Knowledge Base ID |
parser_id | String | Yes | Default parser ID |
parser_config | Object | No | parse configuration |
source_type | String | Yes | document source |
type | String | Yes | file extension |
created_by | String | Yes | founder |
name | String | Yes | file name |
display_name | String | No | document display name |
location | String | No | File storage location |
size | Number | No | size |
token_num | Number | Yes | Number of Tokens |
chunk_num | Number | Yes | number of slices |
character_count | Number | No | Total number of characters in the document |
avg_character_count | Number | No | segmented average characters |
progress | Number | Yes | progress |
progress_msg | String | No | process message |
task_progress_raw | String | No | Sophon raw taskProgress aggregate JSON string |
process_begin_at | String | No | Processing start time |
process_duation | Number | Yes | processing time |
run | String | No | Operating status: 1 running, 2 canceled |
status | String | No | Document Status: 0 obsolete, 1 valid |
valid_date | String | No | Effective Date |
auto_delete_on_expire | Boolean | No | Is it automatically deleted after expiration? |
labels | Array | No | Label information, see the labels table below |
category | String | No | classification |
retrieval_count | Number | No | number of searches |
versions | Array | No | version list |
folder_id | Number | No | Folder ID |
url | String | No | File URL |
downloadable | Boolean | No | Can it be downloaded? |
content_category | Array | No | List of content category names, see below for details |
quality_result | Number | No | Quality test results |
spell_check_count | Number | No | number of typos detected |
completeness_check_count | Number | No | number of integrity tests |
sensitive_word_check_count | Number | No | number of sensitive words detected |
is_enabled | Boolean | No | Whether to enable |
prep_task_id | Number | No | Preprocessing Task ID |
chunk_settings_type | String | No | The conversion slice configuration category used by the current document |
prep_file_path | String | No | Prep file path |
actions | Array | No | The current user's valid permissions to the document |
sub_docs | Array | No | See the sub_docs table below for a list of subdocuments |
Parameter name | Type | Is it necessary to pass on? | Description |
|---|---|---|---|
create_time | Number | No | Create timestamp |
create_date | String | No | creation time |
update_time | Number | No | Update timestamp |
update_date | String | No | update time |
label_id | Number | Yes | Tag ID |
label_name | String | No | label name |
label_type | String | Yes | document tag type
|
label_values | Array | No | List of label values, see label_values table below |
label_value_builder | String | No | Label Value Builder
|
prompt_version | String | No | Cue word version |
label_usage | Number | No | tag usage |
Parameter name | Type | Is it necessary to pass on? | Description |
|---|---|---|---|
id | Number | Yes | tag value ID |
value | String | No | label value |
value_usage | Number | No | tag value usage |
label_value_builder | String | No | Label Value Builder
|
Parameter name | Type | Is it necessary to pass on? | Description |
|---|---|---|---|
id | Number | Yes | Category ID |
name | String | No | Category name |
Parameter name | Type | Is it necessary to pass on? | Description |
|---|---|---|---|
id | Number | Yes | subdocument ID |
name | String | Yes | subdocument name |
chunk_num | Number | Yes | number of slices |
Parameter name | Type | Is it necessary to pass on? | Description |
|---|---|---|---|
create_time | Number | No | Create timestamp |
create_date | String | No | creation time |
update_time | Number | No | Update timestamp |
update_date | String | No | update time |
id | Number | Yes | Document ID |
thumbnail | String | No | Thumbnail Base64 string |
kb_id | Number | Yes | Knowledge Base ID |
parser_id | String | Yes | Default parser ID |
parser_config | Object | No | parse configuration |
source_type | String | Yes | document source |
type | String | Yes | file extension |
created_by | String | Yes | founder |
name | String | Yes | file name |
display_name | String | No | document display name |
location | String | No | File storage location |
size | Number | No | size |
token_num | Number | Yes | Number of Tokens |
chunk_num | Number | Yes | number of slices |
character_count | Number | No | Total number of characters in the document |
avg_character_count | Number | No | segmented average characters |
progress | Number | Yes | progress |
progress_msg | String | No | process message |
task_progress_raw | String | No | Sophon raw taskProgress aggregate JSON string |
process_begin_at | String | No | Processing start time |
process_duation | Number | Yes | processing time |
run | String | No | Operating status: 1 running, 2 canceled |
status | String | No | Document Status: 0 obsolete, 1 valid |
valid_date | String | No | Effective Date |
auto_delete_on_expire | Boolean | No | Is it automatically deleted after expiration? |
labels | Array | No | Label information, see the labels table below |
category | String | No | classification |
retrieval_count | Number | No | number of searches |
versions | Array | No | version list |
folder_id | Number | No | Folder ID |
url | String | No | File URL |
downloadable | Boolean | No | Can it be downloaded? |
content_category | Array | No | List of content category names, see below for details |
quality_result | Number | No | Quality test results |
spell_check_count | Number | No | number of typos detected |
completeness_check_count | Number | No | number of integrity tests |
sensitive_word_check_count | Number | No | number of sensitive words detected |
is_enabled | Boolean | No | Whether to enable |
prep_task_id | Number | No | Preprocessing Task ID |
chunk_settings_type | String | No | The conversion slice configuration category used by the current document |
prep_file_path | String | No | Prep file path |
actions | Array | No | The current user's valid permissions to the document |
Parameter name | Type | Is it necessary to pass on? | Description |
|---|---|---|---|
create_time | Number | No | Create timestamp |
create_date | String | No | creation time |
update_time | Number | No | Update timestamp |
update_date | String | No | update time |
label_id | Number | Yes | Tag ID |
label_name | String | No | label name |
label_type | String | Yes | document tag type
|
label_values | Array | No | List of label values, see label_values table below |
label_value_builder | String | No | Label Value Builder
|
prompt_version | String | No | Cue word version |
label_usage | Number | No | tag usage |
Parameter name | Type | Is it necessary to pass on? | Description |
|---|---|---|---|
id | Number | Yes | tag value ID |
value | String | No | label value |
value_usage | Number | No | tag value usage |
label_value_builder | String | No | Label Value Builder
|
Parameter name | Type | Is it necessary to pass on? | Description |
|---|---|---|---|
id | Number | Yes | Category ID |
name | String | No | Category name |
Parameter name | Type | Is it necessary to pass on? | Description |
|---|---|---|---|
create_time | Number | No | Create timestamp |
create_date | String | No | creation time |
update_time | Number | No | Update timestamp |
update_date | String | No | update time |
id | Number | Yes | Document ID |
thumbnail | String | No | Thumbnail Base64 string |
kb_id | Number | Yes | Knowledge Base ID |
segment_id | Number | Yes | fragment ID for structured binding |
properties | Array | No | CDP properties used by structured bindings, as detailed in the properties table below |
events | Array | No | CDP events used by structured bindings, see the events table below |
details | Array | No | See the details table below for details of the CDP business used by structured bindings |
chats | Array | No | CDP session ID used by structured binding |
source_type | String | Yes | document source |
created_by | String | Yes | founder |
name | String | Yes | file name |
display_name | String | No | document display name |
id_type_codes | Array | Yes | Type of CDP ID used by structured binding |
size | Number | No | size |
token_num | Number | Yes | Number of Tokens |
chunk_num | Number | Yes | number of slices |
progress | Number | Yes | progress |
progress_msg | String | No | process message |
process_begin_at | String | No | Processing start time |
process_duation | Number | Yes | processing time |
run | String | No | Operating status: 1 running, 2 canceled |
status | String | No | Document Status: 0 obsolete, 1 valid |
subject_id | Number | Yes | Topic ID |
valid_date | String | No | Effective Date |
labels | Array | No | Label information, see the labels table below |
content_category | Array | No | List of content category names, see below for details |
quality_result | Number | No | Quality test results |
spell_check_count | Number | No | number of typos detected |
completeness_check_count | Number | No | number of integrity tests |
sensitive_word_check_count | Number | No | number of sensitive words detected |
is_enabled | Boolean | No | Whether to enable |
actions | Array | No | The current user's valid permissions to the document |
Parameter name | Type | Is it necessary to pass on? | Description |
|---|---|---|---|
datasource_id | Number | Yes | Data Source ID |
id | Number | Yes | Metadata ID |
name | String | name |
Parameter name | Type | Is it necessary to pass on? | Description |
|---|---|---|---|
datasource_id | Number | Yes | Data Source ID |
id | Number | Yes | Metadata ID |
name | String | Yes | name |
Parameter name | Type | Is it necessary to pass on? | Description |
|---|---|---|---|
datasource_id | Number | Yes | Data Source ID |
id | Number | Yes | Metadata ID |
name | String | Yes | name |
Parameter name | Type | Is it necessary to pass on? | Description |
|---|---|---|---|
create_time | Number | No | Create timestamp |
create_date | String | No | creation time |
update_time | Number | No | Update timestamp |
update_date | String | No | update time |
label_id | Number | Yes | Tag ID |
label_name | String | No | label name |
label_type | String | Yes | document tag type
|
label_values | Array | No | List of label values, see label_values table below |
label_value_builder | String | No | Label Value Builder
|
prompt_version | String | No | Cue word version |
label_usage | Number | No | tag usage |
Parameter name | Type | Is it necessary to pass on? | Description |
|---|---|---|---|
id | Number | Yes | tag value ID |
value | String | No | label value |
value_usage | Number | No | tag value usage |
label_value_builder | String | No | Label Value Builder
|
Parameter name | Type | Is it necessary to pass on? | Description |
|---|---|---|---|
id | Number | Yes | Category ID |
name | String | No | Category name |