添加文档到数据集。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
aimiaobi:AddDatasetDocument | create | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
WorkspaceId | string | 是 | 百炼业务空间唯一标识:获取 workspaceId | llm-xx |
DatasetId | long | 否 | 数据集唯一标识 | 1 |
DatasetName | string | 否 | 数据集名称 | 数据集名称 |
Document | object | 是 | 文档 | |
DocUuid | string | 否 | 内部文档唯一 ID | 内部文档唯一ID |
Url | string | 否 | 文章 URL | xxx |
Content | string | 否 | 内容 | xxx |
Summary | string | 否 | 文章摘要 | 文章摘要 |
Title | string | 否 | 文档标题 | xxxxx@xxxxx.com |
PubTime | string | 否 | 发布时间 | 2024-12-09 13:35:40 |
SourceFrom | string | 否 | 来源 | 来源 |
MultimodalIndexName | string | 否 | 模型名称 todo 商业化 仅个别账号可传入 | 模型名称 todo 商业化 仅个别账号可传入 |
DisableHandleMultimodalMedia | boolean | 否 | 当前记录是否落多模态索引库 | false |
MultimodalMedias | array<object> | 否 | 多模态信息 | |
MultimodalMedia | object | 否 | 多模态信息 | |
MediaId | string | 否 | 多模态数据唯一标识 | 多模态数据唯一标识 |
MediaType | string | 否 | 多模态数据类型 | 多模态数据类型 |
FileUrl | string | 否 | 图片或视频文件地址 | 图片或视频文件地址 |
DocId | string | 否 | 业务文档唯一 ID | 业务文档唯一ID |
DocType | string | 否 | 文档类型 | 文档类型 |
Extend1 | string | 否 | 扩展字段 1 | 扩展字段1 |
Extend2 | string | 否 | 扩展字段 2 | 扩展字段2 |
Extend3 | string | 否 | 扩展字段 3 | 扩展字段3 |
返回参数
示例
正常返回示例
JSON
格式
{
"Data": {
"DocUuid": "8df2d69d63a247b6b52ff455b2d426b6",
"DocId": "文档业务唯一标识",
"Status": 1,
"ErrorCode": "Success",
"ErrorMessage": "错误信息"
},
"RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
"Success": true,
"Code": "NoData",
"Message": "success",
"HttpStatusCode": 200
}
错误码
访问错误中心查看更多错误码。