# 上传文档 - CreateDocument #### 功能介绍 该接口用于上传文档。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-metastudio/metastudio_02_0002.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-metastudio/metastudio_02_0071.html)。 #### URI POST /v1/{project_id}/wise-brain-manager/document 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-metastudio/metastudio_02_0006.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | knowledge_library_id | 是 | String | 知识库ID | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | 用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取。 响应消息头中X-Subject-Token的值。 | | Authorization | 否 | String | 使用AK/SK方式认证时必选，携带的鉴权信息。 | | X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必选，请求的发生时间。 | | X-Project-Id | 否 | String | 使用AK/SK方式认证时必选，携带项目ID信息。 | | X-App-UserId | 否 | String | 第三方用户ID。不允许输入中文。 | 表4FormData参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | file | 是 | File | 文档文件。 | #### 响应参数 **状态码：200** 表5响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-Request-Id | String | 请求ID。 | 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | document_id | String | 文档ID。 | | knowledge_library_id | String | 知识库ID。 | | file_name | String | 文档名称。 | | file_size | Long | 文档大小，单位字节 **取值范围：** 0\~1048576000 | | file_type | String | 文档类型。 | | split_type | Integer | 分段类型 - 1: 自动分段 - 2: 手动分段 **取值范围：** 1\~64 | | chunk_size | Integer | 分段长度。 **取值范围：** 1\~512 | | chunk_type | String | 分段策略，如果添加多个策略用逗号隔开。 取值示例： - title：用标题把一段话分割为多个段落。 - separator：用分隔符把一段话分割为多个段落。 | | separators | Array of strings | 分隔符 | | create_time | String | 文档创建时间。格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。 | | update_time | String | 文档更新时间。格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。 | | document_task_info | [DocumentTaskInfo] object | 文档分段任务信息。 | 表7DocumentTaskInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | task_id | String | 任务ID | | task_status | String | 任务状态 | | task_process | String | 任务进度 | | task_result | String | 任务结果 | | fail_reason | String | 失败原因 | | create_time | String | 任务创建时间。格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。 | | begin_time | String | 任务开始时间。格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。 | | end_time | String | 任务结束时间。格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。 | | update_time | String | 任务更新时间。格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 ``` POST https://metastudio.cn-north-4.myhuaweicloud.com/v1/70b76xxxxxx34253880af501cdxxxxxx/wise-brain-manager/document-upload/af482f19fa934279831844ddeb13eaab { "file" : "商品价格表.xlsx", "knowledge_library_id" : "af482f19fa934279831844ddeb13eaab" } ``` #### 响应示例 **状态码：200** 处理成功返回。 ``` { "document_id" : "2c908105922c344801923126ddf7001f", "knowledge_library_id" : "af.xlsx482f19fa934279831844ddeb13eaab", "file_name" : "商品价格表", "file_type" : "xlsx", "split_type" : 1, "chunk_size" : 10, "create_time" : "2023-09-01T06:34:21Z", "update_time" : "2023-09-01T06:34:21Z", "document_task_info" : { "task_id" : "2c97e0818c565a34018c565b4f980025", "task_status" : 1, "task_result" : 1, "fail_reason" : "file format not support", "create_time" : "2023-12-01T08:13:17Z", "begin_time" : "2023-12-01T08:13:17Z", "end_time" : "2023-12-01T08:13:17Z", "update_time" : "2023-12-01T08:13:17Z" } } ``` **状态码：400** 请求传参异常，包含错误码及对应描述。 ``` { "error_code" : "MSS.00000003", "error_msg" : "Invalid parameter" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 处理成功返回。 | | 400 | 请求传参异常，包含错误码及对应描述。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-metastudio/ErrorCode.html)。