ListIndices - 查询索引列表

获取指定业务空间下一个或多个知识库的详细信息。

接口说明

本接口具有幂等性。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
sfm:ListIndexlist
*全部资源
*

请求语法

GET /{WorkspaceId}/index/list_indices HTTP/1.1

请求参数

名称类型必填描述示例值
IndexNamestring

知识库的名称。支持通过名称查找知识库。长度为 1~20 个字符,支持 Unicode 中 letter 分类下的字符(其中包括英文、中文和数字等)。可以包含半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。

默认值为空,即查询指定业务空间下的所有知识库。

idx_status_score
PageNumberstring

指定要查询的页码。起始值为 1。默认值为 1。

1
PageSizestring

指定分页查询时每页展示的知识库数量。最大值不限。 默认值为 10。

10
WorkspaceIdstring

知识库所属的业务空间 ID。在百炼的控制台首页,单击页面左上角业务空间详情图标获取。

llm-3shx2gu255oq6xxxx

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

17204B98-xxxx-4F9A-8464-2446A84821CA
Dataobject

返回数据。

PageNumberinteger

返回指定的页码。

1
PageSizeinteger

返回指定的每页条数。

10
TotalCountinteger

返回结果的总条数。

48
Indicesarray<object>

知识库列表。

rowsobject

知识库对象。

Idstring

知识库 ID,即 CreateIndex 接口返回的Data.Id

lecxr5xxxx
Namestring

知识库名称。

XXXX产品清单
Descriptionstring

知识库描述。

清单中产品主要面向海外客户。
StructureTypestring

知识库的向量存储类型。可能值:

  • UNSTRUCTURED:非结构化数据。
UNSTRUCTURED
ChunkSizeinteger

分段预估长度。可能值范围[1-2048]。

5
OverlapSizeinteger

分段重叠长度。可能值范围[0-1024]。

10
Separatorstring

分句标识符。如果有多个分句标识符,则用 | 分隔。可能值:

  • \n:换行
  • ,:中文逗号
  • ,:英文逗号
  • 。:中文句号
  • .:英文句号
  • !:中文叹号
  • !:英文叹号
  • ;:中文分号
  • ;:英文分号
  • ?:中文问号
  • ?:英文问号
\n
EmbeddingModelNamestring

Embedding 模型名称。可能值:

  • text-embedding-v2:text-embedding-v2 模型。
conv-rewrite-qwen-1.8b
RerankModelNamestring

Rank 模型名称。可能值:

  • gte-rerank-hybrid:官方排序。
  • gte-rerank:gte-rerank 排序。
gte-rerank-hybrid
RerankMinScorestring

相似度阈值。范围[0.01-1.00]。

0.01
SourceTypestring

百炼数据管理的数据类型。对于非结构化知识库,可能值:

  • DATA_CENTER_CATEGORY:类目类型。
  • DATA_CENTER_FILE:文档类型。

对于结构化知识库,可能值:

  • DATA_CENTER_STRUCTURED_TABLE:数据表类型。
DATA_CENTER_FILE
DocumentIdsarray

文档 ID 列表。

docIdsstring

文档 ID。

file_8c67b438043848199ffaa903d29addd4_xxxxxxxx
SinkTypestring

知识库的向量存储类型。可能值:

  • ES:内置的向量数据库。
  • BUILT_IN:内置的向量数据库。
  • ADB:AnalyticDB for PostgreSQL 数据库。
BUILT_IN
SinkInstanceIdstring

知识库的向量存储的实例 ID。

gp-bp1gq62t1788yxxxx
SinkRegionstring

知识库的向量存储的实例地域。

cn-hangzhou
Codestring

错误状态码。

Index.InvalidParameter
Messagestring

错误信息。

Required parameter(%s) missing or invalid, please check the request parameters.
Successboolean

接口调用是否成功,可能值:

  • true:成功。
  • false:失败。
true
Statusstring

接口返回的状态码。

200

示例

正常返回示例

JSON格式

{
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 48,
    "Indices": [
      {
        "Id": "lecxr5xxxx",
        "Name": "XXXX产品清单",
        "Description": "清单中产品主要面向海外客户。",
        "StructureType": "UNSTRUCTURED",
        "ChunkSize": 5,
        "OverlapSize": 10,
        "Separator": "\\n",
        "EmbeddingModelName": "conv-rewrite-qwen-1.8b",
        "RerankModelName": "gte-rerank-hybrid",
        "RerankMinScore": "0.01",
        "SourceType": "DATA_CENTER_FILE",
        "DocumentIds": [
          "file_8c67b438043848199ffaa903d29addd4_xxxxxxxx"
        ],
        "SinkType": "BUILT_IN",
        "SinkInstanceId": "gp-bp1gq62t1788yxxxx",
        "SinkRegion": "cn-hangzhou"
      }
    ]
  },
  "Code": "Index.InvalidParameter",
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Success": true,
  "Status": "200"
}

错误码

访问错误中心查看更多错误码。