Uploading Files

repo_id

Yes

String

Knowledge base ID. The value is a string of 1 to 64 characters and can contain only digits, letters, hyphens (-), and underscores (_).

How to obtain:

Log in to the KooSearch experience platform. In the navigation tree on the left, choose Knowledge Bases to view knowledge base IDs. Each knowledge base has a unique ID stored in the vector database.

X-Auth-Token

Yes

String

Parameter description:

Token used for API authentication. For how to obtain the token, see section 3.2 "Authentication."

Constraints:

N/A.

file

Yes

File

Files to be uploaded.

category

No

String

Document directory, which corresponds to the leaf nodes in the directory tree. This parameter has only one value.

The recommended format is "leaf node directory name (directory ID)", for example, patent (3166-1).

tags

No

Array of strings

Document tags. You can use tags to automatically group documents for filtering.

Precautions:
        1. You are advised to use case-insensitive tags. For example, `Approved` and `approved` are the same tag.
        2. A document can have one or more tags.
        Do not use reserved characters (```+ - = && || > <!). Otherwise, you will need to escape them in queries. ( ) { } [ ] ^ " ~ * ? : \ /```

file_extract_req

No

String

Document-level parsing parameter.

The following is an example:

{"mode":1,"language":"CHINESE","parse_conf":{"ocr_enabled":true,"image_enabled":true,"image_conf":"IMAGE","header_footer_enabled":false,"catalog_enabled":false},"split_conf":{"split_mode":"RULE","chunk_size":500,"separators":[". ",". ","! ","! ","? ","?"],"title_level":3,"combine_title":true,"merge_titles":true,"rule_regexs":["^Chapter ([1-9]{1,7})","^Section ([1-9]{1,7}),"^Clause([1-9]{1,7})"]}}

chat_id

No

String

chatId is used to upload the files of a chat

file_id

String

File ID.

error_code

String

Error Code

error_msg

String

Error description

error_code

String

Error Code

error_msg

String

Error description

201

Response body of the API for uploading documents.

400

Incorrect request body parameter

500

Internal error