上传文件
功能介绍
上传文件至某个知识库。
URI
POST /v1/koosearch/repos/{repo_id}/files
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        repo_id  | 
      
        是  | 
      
        String  | 
      
        知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线。 获取方式: 账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知识库ID"字段的值,表示该知识库在向量数据库中存储的ID,具有唯一性。  | 
     
请求参数
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        X-Auth-Token  | 
      
        是  | 
      
        String  | 
      
        参数解释: 接口鉴权使用的Token,Token获取方式参考:3.2节 认证鉴权。 约束限制: 不涉及。  | 
     
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        file  | 
      
        是  | 
      
        File  | 
      
        需要上传的文件。  | 
     
| 
        category  | 
      
        否  | 
      
        String  | 
      
        文档目录,单值,对应目录树中的叶子节点。 建议格式为 叶子节点目录名称(目录 ID),如:专利(3166-1)。  | 
     
| 
        tags  | 
      
        否  | 
      
        Array of strings  | 
      
        文档标签,可以使用标签对文档进行自动分组,用于筛选过滤。 注意事项:
        1.建议不区分大小写,例如, `Approved` and `approved` 是同一个标签
        2.文档可以有一个或多个标签
        3.不要使用保留字符,否则查询时需要转义:```+ - = && || > < ! ( ) { } [ ] ^ " ~ * ? : \ /``` | 
     
| 
        file_extract_req  | 
      
        否  | 
      
        String  | 
      
        文档级别解析参数。 样例 {"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":["^第([零〇一二三四五六七八九十百千万1-9]{1,7})章","^第([零〇一二三四五六七八九十百千万1-9]{1,7})节","^第([零〇一二三四五六七八九十百千万1-9]{1,7})条"]}}  | 
     
| 
        chat_id  | 
      
        否  | 
      
        String  | 
      
        chatId用于上传文件对话  | 
     
响应参数
状态码:201
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        file_id  | 
      
        String  | 
      
        文件ID。  | 
     
状态码:400
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      |
| 
        error_msg  | 
      
        String  | 
      
        错误描述  | 
     
状态码:500
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      |
| 
        error_msg  | 
      
        String  | 
      
        错误描述  | 
     
请求示例
POST https://{endpoint}/v1/koosearch/repos/0ac621de-3624-454e-adcf-8c5b4cf7317c/files
 响应示例
状态码:201
上传文档接口响应体。
{
  "file_id" : "5c46f7e31c5c4587ac99ef0da0502470"
}
 状态码
| 
        状态码  | 
      
        描述  | 
     
|---|---|
| 
        201  | 
      
        上传文档接口响应体。  | 
     
| 
        400  | 
      
        请求体参数错误  | 
     
| 
        500  | 
      
        内部异常  | 
     
错误码
请参见错误码。