根据业务场景灵活构建文档块。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dianjin:CreatePredefinedDocument | create | *全部资源 * |
| 无 |
请求语法
POST /{workspaceId}/api/library/document/createPredefinedDocument HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| workspaceId | string | 是 | 路径参数，业务空间 id | llm-xxxxx |
| body | object | 否 | 请求体。 | |
| chunks | array<object> | 否 | 文档块列表 | |
| Chunk | object | 否 | ||
| chunkMeta | object | 否 | 文档块元信息 | {"a": "1"} |
| chunkOrder | integer | 否 | 顺序，可以不填 | 1 |
| chunkText | string | 否 | 文档块文本 | 这是一段测试文本 |
| chunkType | string | 否 | 文档块类型 | text |
| libraryId | string | 否 | 文档库 id | a1b2c3 |
| metadata | object | 否 | 元数据 | {"a": "1"} |
| title | string | 否 | 文档标题 | 测试文档 |
返回参数
示例
正常返回示例
JSON格式
{
"cost": 0,
"data": "1782981430906818562",
"dataType": "null",
"errCode": "0",
"message": "ok",
"requestId": "0a06dfe617018288881568684e2937",
"success": true,
"time": "2024-04-24 11:54:34"
}错误码
访问错误中心查看更多错误码。