查询知识库列表 - Knowledge Studio

GET

/api/v1/indices/rag/index/list

cURL

curl -G "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/index/list" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -d "page_number=1" \
  -d "page_size=20"

{
  "code": "Success",
  "status_code": 200,
  "data": {
    "page_number": 1,
    "total_count": 1,
    "rows": [
      {
        "id": "your_kb_id",
        "name": "my-knowledge-base",
        "description": "示例知识库",
        "dataType": "unstructured",
        "structureType": "unstructured",
        "knowledgeType": null,
        "embeddingModelName": "text-embedding-v4",
        "embeddingDimension": null,
        "multimodalEmbeddingModelName": null,
        "rerankModelName": "qwen3-rerank",
        "rerankMinScore": 0.2,
        "rerankTopN": null,
        "rerankMode": null,
        "rerankInstruct": null,
        "chunkSize": 600,
        "overlapSize": 100,
        "separator": null,
        "chunkMode": null,
        "sourceType": "DATA_CENTER_CATEGORY",
        "docIds": [
          "cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
          "cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx"
        ],
        "columns": null,
        "enableRewrite": true,
        "connectorId": null,
        "sparseSimilarityTopK": null,
        "denseSimilarityTopK": null
      }
    ],
    "page_size": 20
  },
  "success": true,
  "message": "success",
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "SUCCESS"
}

调用前请确保已获取 API Key 和业务空间 ID，详见鉴权说明。

Authorizations

string

header

required

DashScope API Key，在控制台 API Key 页面获取。

Query Parameters

integer

default1

页码，从 1 开始。

Required range:x >= 1

integer

default10

每页返回的知识库数量。

Required range:1 <= x <= 100

string

按知识库名称模糊过滤，返回名称包含该值的知识库；不传时返回业务空间下所有知识库。长度 1~20 字符，支持 Unicode letter 分类字符（含英文、中文、数字等），可含半角冒号(:)、下划线(_)、半角句号(.)或短划线(-)。

Required range:length: 1–20

Response

200-application/json

string

响应码，成功时为 Success。

integer

HTTP 状态码。

string

请求唯一标识，排查问题时请提供此 ID。

object

Show child attributes

integer

当前页码。

integer

知识库总数。

object[]

知识库列表。

Show child attributes

string

知识库唯一标识。

string

知识库名称。

string

知识库描述信息。

string

数据类型，如 unstructured。

string

结构类型：unstructured（非结构化）或 structured（结构化）。

string

知识库类型。

string

向量嵌入模型，如 text-embedding-v4。

integer

向量维度。

string

多模态嵌入模型名称（图片/音视频知识库）。

integer

切片大小（字符数）。

integer

切片重叠大小（字符数）。

string

切片分隔符。

string

切片模式。

string

重排序模型，如 qwen3-rerank。为空表示未启用。

number

重排序最低分数阈值。

integer

重排序返回数量。

string

重排序模式。

string

自定义重排序指令。

string

数据源类型，如 DATA_CENTER_CATEGORY。

string[]

关联的类目/文档 ID 列表。

object[]

列信息，结构化知识库时返回。

Show child attributes

boolean

是否参与知识库检索。为 true 时表示允许知识库在此列数据中进行搜索。

object

数据查询或图片问答类知识库的索引配置信息。

string

关联的连接器 ID。

boolean

是否启用查询改写。

integer

稀疏检索 TopK。

integer

稠密检索 TopK。

string

知识库场景。

string

所属业务空间 ID。

boolean

切片是否保留标题层级信息。

boolean

是否开启视觉文本解析。

integer

切片重叠长度。

unknown[]

关联的类目 ID 列表。

unknown[]

结构化知识库关联的表 ID 列表。

object

数据源配置。

string

向量存储类型，默认 DEFAULT。

string

自建向量存储实例 ID，使用默认存储时为空。

string

向量存储所在地域。

unknown[]

元数据抽取列配置。

string

知识库标签。

string

知识库创建方式。

boolean

是否开启数据同步。

string

数据源编码，结构化知识库使用。

string

关联的数据表名，结构化知识库使用。

string

关联的数据库名，结构化知识库使用。

string

渠道类型。

integer

当前每页条数（与请求一致）。

boolean

请求是否成功。

string

提示信息，成功时为 success。

string

请求状态：SUCCESS 或 FAILED。