数据集管理-更新。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| aimiaobi:UpdateDataset | update | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| WorkspaceId | string | 是 | 百炼业务空间唯一标识：获取 workspaceId | xxxx |
| DatasetId | long | 否 | 数据集 id | 1 |
| DatasetDescription | string | 否 | 数据集描述 | 企业自定义数据集 |
| SearchDatasetEnable | integer | 否 | 数据集搜索开关 | 3 |
| DatasetConfig | object | 否 | 三方搜索数据集配置 | |
| SearchSourceConfigs | array<object> | 否 | 三方搜索：api 定义 | |
| SearchSourceConfig | object | 否 | ||
| DemoQuery | string | 否 | 可以搜索到的关键词，用来验证是否可用 | 可以搜索到的关键词，用来验证是否可用 |
| Size | integer | 否 | 默认请求、响应数据条数限制 | 10 |
| SearchSourceRequestConfig | object | 否 | api 请求配置 | |
| Url | string | 否 | api 地址 | api地址 |
| Method | string | 否 | 请求方式 | 请求方式 |
| ConnectTimeout | integer | 否 | 连接超时时间：单位毫秒 | 3000 |
| SocketTimeout | integer | 否 | 读超时时间：单位毫秒 | 3000 |
| Headers | array<object> | 否 | http 请求头 | |
| Header | object | 否 | http 请求头 | |
| Name | string | 否 | 参数名称 | 参数名称 |
| ValueType | string | 否 | 参数值数据类型: 默认 string | 参数值数据类型: 默认string |
| ValueFormat | string | 否 | valueType = time 时有效 | valueType = time 时有效 |
| Value | string | 否 | 参数值 | 参数值 |
| Params | array<object> | 否 | 请求 path 参数 | |
| Param | object | 否 | 请求 path 参数 | |
| Name | string | 否 | 参数名称 | 参数名称 |
| ValueType | string | 否 | 参数值数据类型: 默认 string | 参数值数据类型: 默认string |
| ValueFormat | string | 否 | valueType = time 时有效 | valueType = time 时有效 |
| Value | string | 否 | 参数值 | 参数值 |
| PathParamsEnable | boolean | 否 | 是否开启 pathParam | true |
| Body | string | 否 | 请求 body | {} |
| SearchSourceResponseConfig | object | 否 | api 响应配置 | |
| JqNodes | array<object> | 否 | 节点配置 | |
| JqNode | object | 否 | ||
| Key | string | 否 | 节点 key | 节点key |
| Type | string | 否 | 节点数据类型：string number list object base | 节点数据类型：string number list object base |
| Path | string | 否 | 节点路径 | 节点路径 |
| JqNodes | array<object> | 否 | 子节点配置 | |
| JqNode | object | 否 | 子节点配置 | |
| Key | string | 否 | 节点 key | title |
| Type | string | 否 | type 类型 | string |
| Path | string | 否 | 节点路径 | .title |
| JqNodes | array<object> | 否 | 子节点配置 | |
| object | 否 | 子节点配置 | ||
| Key | string | 否 | 节点 key | title |
| Type | string | 否 | type 类型 | string |
| Path | string | 否 | 节点路径 | .title |
返回参数
示例
正常返回示例
JSON格式
{
"Data": {
"DatasetId": 1,
"CreateUser": "xxx",
"CreateTime": "2024-11-12 21:46:24",
"DatasetType": "CustomSemanticSearch",
"DatasetName": "xxx",
"DatasetDescription": "xxx",
"SearchDatasetEnable": 1,
"NewsArticleResults": [
{
"Data": [
{
"PubTime": "2024-11-12 15:12:14",
"Source": "央视网",
"Title": "文章标题",
"Content": "文章内容",
"Url": "https://www.example.com/aaa.docx",
"Summary": "文章摘要"
}
],
"Current": 1,
"Size": 10,
"Total": 100,
"Code": "NoData",
"Message": "success"
}
]
},
"RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
"Success": true,
"Code": "NoData",
"Message": "success",
"HttpStatusCode": 200
}错误码
访问错误中心查看更多错误码。