DocumentUpload - 上传文档
更新时间：2024-11-05
API访问域名
| 请求方式 | POST |
|---|---|
| base url | https://keyue.cloud.baidu.com |
| 后缀接口 | /open/v1/api/v2/task/create/llm_document_import |
| Authentication | token为API Key |
说明
请求参数
Header参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| Content-Type | string | 是 | 内容类型 | 固定值：application/json |
| token | string | 是 | API KEY | 集成-API-API Key处获取。 详细获取方式参考：准备工作 |
| uid | string | 是 | 用户ID | 鼠标移动至页面右上角账户头像即可获取。 详细获取方式参考：准备工作 |
| username | string | 是 | 用户名 | 鼠标移动至页面右上角账户头像即可获取。 详细获取方式参考：准备工作 |
Parameter参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| dirId | string | 是 | 目录Id | 上传文档到对应目录下 |
Body参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| file | file | 是 | 文档 | |
| taskExtend | string | 否 | 文档训练参数 | 为空代表"{}"：自动分段与数据清洗。有值代表：1、分段标识符split_by：换行切分punc、标点切分wrap2、分段最大长度chunk_size（200-800）3、分段重叠比overlap_proportion（0-20）4、文本预处理（删除连续空格、换行、制表符）：pre_handle_text5、文本预处理（删除目录、页眉、页脚）：pre_handle_directory |
响应参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| time | integer | 是 | 时间 | 1717469424958 |
| data | object | 是 | 数据 | 数据对象 |
| data \ id | string | 是 | 文档id | |
| data \ agentId | string | 是 | ||
| data \ agentName | string | 是 | ||
| data \ agentType | integer | 是 | ||
| data \ userId | string | 是 | uid | |
| data \ userName | string | 是 | username | |
| data \ created | string | 是 | ||
| data \ updated | string | 是 | ||
| data \ module | string | 是 | ||
| data \ taskType | string | 是 | ||
| data \ taskStatus | integer | 是 | ||
| data \ taskResult | null | 否 | ||
| data \ errorMsg | null | 否 | ||
| data \ filePath | string | 是 | 文件路径 | Ym9zXzVhMzRlZDdhLTk0MjEtNGEzNy05MzQ1LWMzNWZmODhiZjBjNg== |
| data \ fileUrl | null | 否 | 文件URL | null |
| data \ taskUrl | string | 是 | 任务URL | /api/v2/llm/document/import |
| data \ deleted | integer | 是 | 是否删除 | 0 |
| data \ reportFilePath | null | 否 | 报告文件路径 | null |
| data \ reportFileUrl | null | 否 | 报告文件URL | null |
| data \ taskExtend | string | 是 | 任务扩展 | {"split_by":"wrap","chunk_size":700,"overlap_proportion":10,"pre_handle_text":true,"pre_handle_directory":false} |
| data \ commonExtend | null | 否 | 通用扩展 | null |
| data \ tenantId | string | 是 | 租户ID | 3156952326602753 |
| data \ appName | null | 否 | 应用名称 | null |
| data \ platform | string | 是 | 平台 | NGD |
| data \ requestSource | string | 是 | 请求来源 | UNIT |
| code | integer | 是 | 状态码 | 200 |
| msg | string | 是 | 状态信息 | OK |
请求示例
curl --location 'https://keyue.cloud.baidu.com/open/v1/api/v2/task/create/llm_document_import?dirId=0' \
--header 'token: e9ed5f3c-b144-4186-ad70-5fcff1f4d94a' \
--header 'Content-Type: application/json' \
--header 'uid: cf7d9692703d45d1b5517a30ab3efa53' \
--header 'username: pnstest5' \
--form 'file=@"/Users/jiangkang/Desktop/jiangkang/照片&证件材料/话费发票/2024年3月话费.pdf"' \
--form 'taskExtend="{\"split_by\":\"wrap\",\"chunk_size\":700,\"overlap_proportion\":10,\"pre_handle_text\":true,\"pre_handle_directory\":false}"'响应示例
{
"time": 1717469424958,
"data": {
"id": "64cd68de-693b-40e1-b823-ea9df9fc4c42",
"agentId": "dc4f2aff-d70c-444e-9b2d-4ff1f569c45b",
"agentName": "啦啦啦啦",
"agentType": 1,
"userId": "cf7d9692703d45d1b5517a30ab3efa53",
"userName": "pnstest5",
"created": "2024-06-04 10:50:24",
"updated": "2024-06-04 10:50:24",
"module": "llm",
"taskType": "import",
"taskStatus": 0,
"taskResult": null,
"errorMsg": null,
"filePath": "Ym9zXzVhMzRlZDdhLTk0MjEtNGEzNy05MzQ1LWMzNWZmODhiZjBjNg==",
"fileUrl": null,
"taskUrl": "/api/v2/llm/document/import",
"deleted": 0,
"reportFilePath": null,
"reportFileUrl": null,
"taskExtend": "{\"split_by\":\"wrap\",\"chunk_size\":700,\"overlap_proportion\":10,\"pre_handle_text\":true,\"pre_handle_directory\":false}",
"commonExtend": null,
"tenantId": "3156952326602753",
"appName": null,
"platform": "NGD",
"requestSource": "UNIT"
},
"code": 200,
"msg": "OK"
}