CreatePredefinedDocument - 创建预定义文档_大模型服务平台百炼(Model Studio)-阿里云帮助中心

根据业务场景灵活构建文档块。

接口说明

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

前提条件

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

获取到 workspaceId：获取 workspace 标识。

调试

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

调试

授权信息

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

请求语法

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

请求参数

名称	类型	必填	描述	示例值
workspaceId	string	是	路径参数，业务空间 id	llm-xxxxx
body	object	否	请求体。
chunks	array<object>	否	文档块列表
	object	否
chunkMeta	object	否	文档块元信息	{"a": "1"}
chunkOrder	integer	否	顺序，可以不填	1
chunkText	string	否	文档块文本	这是一段测试文本
chunkType	string	否	文档块类型	text
libraryId	string	否	文档库 id	a1b2c3
metadata	object	否	元数据	{"a": "1"}
title	string	否	文档标题	测试文档

返回参数

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

示例

正常返回示例

JSON格式

{
  "cost": 0,
  "data": "1782981430906818562",
  "dataType": "null",
  "errCode": "0",
  "message": "ok",
  "requestId": "0a06dfe617018288881568684e2937",
  "success": true,
  "time": "2024-04-24 11:54:34"
}

错误码

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