# 上传文档接口 - UploadFiles #### 功能介绍 上传文件至某个知识库。 #### URI POST /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/files 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-koosearch/koosearch_06_0022.html)。 **约束限制：** 不涉及 **取值范围：** 1～64个字符，只能包含数字、字母、中划线和下划线，且必须以字母开头。 **默认取值：** 不涉及 | | application_id | 是 | String | **参数解释：** 应用ID，获取方法请参见[获取应用ID](https://support.huaweicloud.com/api-koosearch/koosearch_06_0021.html)。 **约束限制：** 字符串 **取值范围：** 1～64个字符，只能包含数字、字母、中划线和下划线，且必须以字母开头。 **默认取值：** 不涉及 | | repo_id | 是 | String | **参数解释：** 知识库ID。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性。 **约束限制：** 不涉及 **取值范围：** 1～64个字符，只能包含数字、字母、中划线和下划线。 **默认取值：** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 接口鉴权使用的Token，Token获取方式参考：[获取IAM用户Token](https://support.huaweicloud.com/api-koosearch/koosearch_06_0009.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表3FormData参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | file | 是 | File | **参数解释：** 上传的文件。 **约束限制：** 支持格式为 .doc, .docx, .pdf, .pptx, .ppt, .xlsx, .xls, .csv, .wps, .png, .jpg, .jpeg, .bmp, .gif, .tiff, .tif, .webp, .pcx, .ico, .psd, .dps, .et, .txt, .ofd, .md 的多个文档，单个文档不能超过128MB（超过60MB建议通过API上传）。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | category | 否 | String | **参数解释：** 文档目录，单值，对应目录树中的叶子节点。 建议格式为 *叶子节点目录名称(目录 ID)* ，如：*专利（3166-1）*。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | tags | 否 | Array of strings | **参数解释：** 文档标签，可以使用标签对文档进行自动分组，用于筛选过滤。 **约束限制：** 25.2.T1版本增加URL常用特殊字符：:/.?\&=@#%+\~!$'(),;\*\[\] 等特殊字符。 注意事项： 1. 建议不区分大小写，例如， *Approved* and *approved* 是同一个标签 2. 文档可以有一个或多个标签 **取值范围：** 只能包含1到255位英文字母、中文、数字以及URL特殊字符（ : - _ / . ? \& = @ # % + \~ ! $ ' ( ) , ; \*\[\] ）；并且以字母、数字或者中文开头。 **默认取值：** 不涉及 | | file_extract_req | 否 | String | **参数解释：** 文档级别解析参数, 表单传递数据. 样例 {"mode":1,"language":"CHINESE","parse_conf":{"ocr_enabled":true," mllm_model":"mllm6","image_enabled":true,"image_conf":"IMAGE","header_footer_enabled":false," footnote_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":\["\^第(\[零〇一二三四五六七八九十百千万1-9\]{1,7})章","\^第(\[零〇一二三四五六七八九十百千万1-9\]{1,7})节","\^第(\[零〇一二三四五六七八九十百千万1-9\]{1,7})条"\]}}。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | chat_id | 否 | String | **参数解释：** 对话的chatId。 **约束限制：** 不涉及 **取值范围：** 长度不能超过64个字符。 **默认取值：** 不涉及 | | expire_time | 否 | String | **参数解释：** 过期时间戳。 **约束限制：** 不涉及 **取值范围：** 长度13位时间戳。 **默认取值：** 不涉及 | #### 响应参数 **状态码：201** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | file_id | String | **参数解释：** 文档ID。 **取值范围：** 不涉及 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** [错误码](https://support.huaweicloud.com/api-koosearch/ErrorCode.html)。 **取值范围：** 不涉及 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及 | **状态码：500** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** [错误码](https://support.huaweicloud.com/api-koosearch/ErrorCode.html)。 **取值范围：** 不涉及 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及 | #### 请求示例 上传文件至知识库。 ``` /v1/b25446daeb1a41a7953c5deba2b2677a/applications/0ac621de-3624-454e-adcf-8c5b4cf7317c/uni-search/111/files ------WebKitFormBoundaryySBcwS9WWatb5PUY Content-Disposition: form-data; name="file"; filename="file .docx" Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document ------WebKitFormBoundaryySBcwS9WWatb5PUY-- ``` #### 响应示例 **状态码：201** 上传文档接口响应体。 ``` { "file_id" : "5c46f7e31c5c4587ac99ef0da0502470" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 201 | 上传文档接口响应体。 | | 400 | 请求体参数错误。 | | 500 | 内部异常。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-koosearch/ErrorCode.html)。