数据集管理-详情。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| aimiaobi:GetDataset | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| WorkspaceId | string | 是 | 百炼业务空间唯一标识：获取 workspaceId | llm-xxx |
| DatasetName | string | 否 | 数据集名称，全局唯一 | businessDataset |
| DatasetId | long | 否 | 数据集 id | 1 |
返回参数
示例
正常返回示例
JSON格式
{
"Data": {
"DatasetId": 1,
"CreateUser": "xxx",
"CreateTime": "2024-11-12 21:46:24",
"DatasetType": "CustomSemanticSearch",
"DatasetName": "xxx",
"DatasetConfig": {
"SearchSourceConfigs": [
{
"DemoQuery": "可以搜索到的关键词，用来验证是否可用",
"Size": 10,
"SearchSourceRequestConfig": {
"Url": "api地址",
"Method": "请求方式",
"ConnectTimeout": 30,
"SocketTimeout": 78,
"Headers": [
{
"Name": "参数名称",
"ValueType": "参数值数据类型: 默认string",
"ValueFormat": "valueType = time 时有效",
"Value": "参数值"
}
],
"Params": [
{
"Name": "参数名称",
"ValueType": "参数值数据类型: 默认string",
"ValueFormat": "valueType = time 时有效",
"Value": "参数值"
}
],
"PathParamsEnable": true,
"Body": "请求body"
},
"SearchSourceResponseConfig": {
"JqNodes": [
{
"Key": "节点key",
"Type": "节点数据类型：string number list object base",
"Path": "节点路径",
"JqNodes": [
{
"Key": "title",
"Type": "string",
"Path": ".title",
"JqNodes": [
{
"Key": "title",
"Type": "string",
"Path": ".title"
}
]
}
]
}
]
}
}
]
},
"DatasetDescription": "xxx",
"SearchDatasetEnable": 1,
"DocumentHandleConfig": {
"DisableHandleMultimodalMedia": true
}
},
"RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
"Success": true,
"Code": "NoData",
"Message": "success",
"HttpStatusCode": 200
}错误码
访问错误中心查看更多错误码。