查询数据集文档列表
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| aimiaobi:ListDatasetDocuments | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| WorkspaceId | string | 是 | 百炼业务空间唯一标识：获取 workspaceId | xxxx |
| Query | string | 否 | 搜索条件 | 搜索条件 |
| DatasetId | long | 否 | 数据集唯一标识 | 1 |
| DatasetName | string | 否 | 数据集名称 | 数据集名称 |
| Status | integer | 否 | 文档索引构建状态 | 100 |
| DocType | string | 否 | 文档类型 | text |
| DatasetDescription | string | 否 | 描述 | xx |
| IncludeFields | array | 否 | 包括字段 | |
| IncludeField | string | 否 | 包括字段 | content |
| ExcludeFields | array | 否 | 排除字段 | |
| ExcludeField | string | 否 | 排除字段 | content |
| PageNumber | integer | 否 | 当前页码 | 1 |
| PageSize | integer | 否 | 每页条数：默认 10 | 10 |
返回参数
示例
正常返回示例
JSON格式
{
"Data": [
{
"DocUuid": "内部文档唯一ID",
"Url": "https://xxx/xx",
"Content": "xx",
"Summary": "xx",
"Title": "xx",
"PubTime": "2022-01-01 00:00:00",
"SourceFrom": "来源",
"DisableHandleMultimodalMedia": false,
"MultimodalMedias": [
{
"MediaId": "多模态数据唯一标识",
"MediaType": "多模态数据类型",
"FileUrl": "图片或视频文件地址"
}
],
"DocId": "xx",
"DocType": "text",
"Status": 100,
"CategoryUuid": "xx",
"Extend1": "xx",
"Extend2": "xx",
"Extend3": "xx"
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 100,
"RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
"Success": true,
"Code": "NoData",
"Message": "success",
"HttpStatusCode": 200
}错误码
访问错误中心查看更多错误码。