UploadDocument - 上传文档_大模型服务平台百炼(Model Studio)-阿里云帮助中心

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

接口说明

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

前提条件

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

获取到 workspaceId：获取 workspace 标识。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求语法

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

请求参数

名称	类型	必填	描述	示例值
workspaceId	string	是	路径参数，业务空间 id	llm-xxxxx
body	object	否	请求体。
data	string	否	文件元数据，可以用作召回时的筛选	{\"cateogry\": \"报告\"}
fileName	string	是	完整文件名（包含后缀）	test.pdf
fileUrl	string	是	文件 Oss 地址。如果文件为非公开读，fileUrl 需要携带签名参数。如果使用 sdk 进行文件上传，可以直接上传文件，无需提供 oss 地址，具体参考 sdk 使用说明文档。	https://oss-xxx.hangzhou.com/test.pdf
libraryId	string	是	文档库 id	sjdhbcsj

返回参数

名称	类型	描述	示例值
	object	返回结果
cost	long	耗时	null
data	string	返回数据	1782981430906818562
dataType	string	数据类型	null
errCode	string	错误码	0
message	string	错误信息	ok
requestId	string	请求 id	ff3fef67-48d9-4379-a237-9ba8143fe739
success	boolean	是否成功	true
time	string	时间戳	2024-04-24 11:54:34

示例

正常返回示例

JSON格式

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

错误码

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