文档提交

接口描述

将文档上传接口返回的文件信息，加上默认/自定义提取拆分规则后提交到RAG。

基础信息

请求地址	`/doc/document/document-submit`
请求域名	• 办公网域名：`http://jiuwen-api.vmic.xyz/v1` • IDC域名：`http://jiuwen-api.vivo.lan:8080/v1`
请求方法	POST

请求参数

请求体参数（Request Body）

参数名	类型	说明
`files`	list	数组（必输），upload接口上传的文件信息的集合- `file_name`：str（必输），文档名- `file_id`：str（必输），upload返回的文档ID- `source_name`：str（非必需），源文件名- `source_link`：str（非必需），文件来源url- `document_theme`：str（非必输），文档标题
`open_id`	string	字符串（非必输），如果未传该参数,页面显示文件上传人为知识库创建人
`chunk_strategy`	object	对象（非必输），文档拆分策略- `chunk_type`：int（必输），默认0，输入1则会要求上送下面的自定义规则- `separator`：str（非必输），拆分文档标志- `max_tokens`：int（非必输），拆分段最大长度- `remove_extra_spaces`：int（非必输），替换掉连续的空格、换行符和制表符- `remove_urls_emails`：int（非必输），删除所有 URL 和电子邮箱地址

返回参数

内容较多，详见下方示例

示例

Request

curl --location --request POST '${props?.api_base_url}/doc/document/document-submit' \
--header 'Authorization: Bearer ENTER-YOUR-SECRET-KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
        "files":[{
            "file_name": "胡鹏的简历.pdf", //必输,
            "file_id": "24496", //必输，上传接口返回的文件ID,
            "source_name": "1",
            "source_link": "https://www.baidu.com",
            "document_theme": "文档xxx" 
         }],
        "chunk_strategy": {  //可选
          "chunk_type": 1, //0-默认，1-自定义
          "separator":"？", //自定义时必输
          "max_tokens":51, //自定义时必输
          "remove_extra_spaces": false, //自定义时必输
          "remove_urls_emails": false //自定义时必输
          } 
}'

Response

{
  "documents": [
      {
        "file_name": "胡鹏-Java .pdf",
        "document_id": null,
        "document_theme": "文档xxx",
        "source_name": "文档xxx",
        "source_link": "http://jiuwen-test.vmic.xyz/open-api/attachment/view/24496",
        "file_id": "81a5e916e89d4fc1"
      }
  ],
  "batch": "20250327151514334857"
}

文档提交

On this page