UploadDocument - 上传文档

上传文档至文档库,会对文档进行解析、分块、构建索引等一系列操作。

接口说明

请确保在使用该接口前,已充分了解通义点金产品的收费方式和价格。

前提条件

已开通 百炼服务和通义点金服务。

获取到 workspaceId:获取 workspace 标识

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dianjin:UploadDocumentnone
*全部资源
*

请求语法

POST /{workspaceId}/api/library/document/upload HTTP/1.1

请求参数

名称类型必填描述示例值
workspaceIdstring

路径参数,业务空间 id

llm-xxxxx
bodyobject

请求体。

datastring

文件元数据,可以用作召回时的筛选

{\"cateogry\": \"报告\"}
fileNamestring

完整文件名(包含后缀)。目前支持 pdf, doc, docx, markdown, ppt, pptx。文件大小限制 100MB,pdf, doc, docx, ppt, pptx 文件页数限制 500 页。

test.pdf
fileUrlstring

文件 Oss 地址。如果文件为非公开读,fileUrl 需要携带签名参数。

如果使用 sdk 进行文件上传,可以直接上传文件,无需提供 oss 地址,具体参考 sdk 使用说明文档。

https://oss-xxx.hangzhou.com/test.pdf
libraryIdstring

文档库 id

sjdhbcsj

返回参数

名称类型描述示例值
object

返回结果

costlong

耗时

null
datastring

返回数据

1782981430906818562
dataTypestring

数据类型

null
errCodestring

错误码

0
messagestring

错误信息

ok
requestIdstring

请求 id

ff3fef67-48d9-4379-a237-9ba8143fe739
successboolean

是否成功

true
timestring

时间戳

2024-04-24 11:54:34

示例

正常返回示例

JSON格式

{
  "cost": 0,
  "data": 1782981430906818600,
  "dataType": null,
  "errCode": 0,
  "message": "ok",
  "requestId": "ff3fef67-48d9-4379-a237-9ba8143fe739",
  "success": true,
  "time": "2024-04-24 11:54:34"
}

错误码

访问错误中心查看更多错误码。