更新文档,用于更新文档的标题、元数据等信息。
接口说明
前提条件
- 已开通阿里云百炼服务和通义点金服务。
- 获取到 workspaceId:获取 workspace 标识。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
-
资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dianjin:UpdateDocument | none | *全部资源 * |
| 无 |
请求语法
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| workspaceId | string | 是 | 路径参数,业务空间 id | llm-xxxxx |
| body | object | 否 | 请求体参数。 | |
| docId | string | 是 | 文档 id | 123 |
| libraryId | string | 是 | 文档库 id | abc123 |
| meta | object | 否 | 文档 meta 数据 | { "businessId": "12321" } |
| title | string | 否 | 文档标题 | test |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object | 返回结果 | ||
| cost | long | 耗时 | null |
| data | string | 返回数据 | null |
| dataType | string | 数据类型 | null |
| errCode | string | 错误码 | 0 |
| message | string | 错误信息 | ok |
| requestId | string | 请求 id | eb2b6139-ddf1-91a0-a47f-df7617ae9032 |
| success | boolean | 是否成功 | true |
| time | string | 时间戳 | 2024-04-24 11:54:34 |
示例
正常返回示例
JSON格式