ListIndices - 查詢索引列表 -

擷取指定業務空間下一個或多個知識庫的詳細資料。

介面說明

RAM 使用者（子帳號）需要首先擷取阿里雲百鍊的 API 許可權（需要AliyunBailianDataFullAccess，已包括 sfm:ListIndex 許可權點），然後才能調用本介面。阿里雲帳號（主帳號）可直接調用無須授權。建議您通過最新版阿里雲百鍊 SDK來調用本介面。
本介面具有等冪性。

限流說明： 本介面頻繁調用會被限流，頻率請勿超過 10 次/秒。如遇限流，請稍後重試。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

sfm:ListIndex

list

*全部資源

*

無

請求文法

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

請求參數

名稱	類型	必填	描述	樣本值
IndexName	string	否	知識庫的名稱。支援通過名稱尋找知識庫。長度為 1~20 個字元，支援 Unicode 中 letter 分類下的字元（其中包括英文、中文和數字等）。可以包含半形冒號（:）、底線（_）、半形句號（.）或者短劃線（-）。預設值為空白，即查詢指定業務空間下的所有知識庫。	idx_status_score
PageNumber	string	否	指定要查詢的頁碼。起始值為 1。預設值為 1。	1
PageSize	string	否	指定分頁查詢時每頁展示的知識庫數量。最大值不限。預設值為 10。	10
WorkspaceId	string	是	知識庫所屬的業務空間 ID。擷取方式請參見如何使用業務空間。	llm-3shx2gu255oq6xxxx

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	17204B98-xxxx-4F9A-8464-2446A84821CA
Data	object	返回資料。
PageNumber	integer	返回指定的頁碼。	1
PageSize	integer	返回指定的每頁條數。	10
TotalCount	integer	返回結果的總條數。	48
Indices	array<object>	知識庫列表。
	object	知識庫對象。
Id	string	知識庫 ID，即 CreateIndex 介面返回的`Data.Id`。	lecxr5xxxx
Name	string	知識庫名稱。	XXXX產品清單
Description	string	知識庫描述。	清單中產品主要面向海外客戶。
StructureType	string	知識庫的向量儲存類型。可能值： UNSTRUCTURED：非結構化資料。	UNSTRUCTURED
ChunkSize	integer	分段預估長度。可能值範圍[1-2048]。	5
OverlapSize	integer	分段重疊長度。可能值範圍[0-1024]。	10
Separator	string	分句標識符。如果有多個分句標識符，則用｜分隔。可能值： \n：換行，：中文逗號 ,：英文逗號。：中文句號 .：英文句號！:中文歎號 !：英文歎號；：中文分號 ;：英文分號？：中文問號 ?：英文問號	\n
EmbeddingModelName	string	Embedding 模型名稱。可能值： text-embedding-v2：text-embedding-v2 模型。	conv-rewrite-qwen-1.8b
RerankModelName	string	Rank 模型名稱。可能值： gte-rerank-hybrid：官方排序。 gte-rerank：gte-rerank 排序。	gte-rerank-hybrid
RerankMinScore	string	相似性閾值。範圍[0.01-1.00]。	0.01
SourceType	string	阿里雲百鍊應用資料的資料類型。對於非結構化知識庫，可能值： DATA_CENTER_CATEGORY：類目類型。 DATA_CENTER_FILE：文件類型。對於結構化知識庫，可能值： DATA_CENTER_STRUCTURED_TABLE：資料表類型。	DATA_CENTER_FILE
DocumentIds	array	文檔 ID 列表。
	string	文檔 ID。	file_8c67b438043848199ffaa903d29addd4_xxxxxxxx
SinkType	string	知識庫的向量儲存類型。可能值： ES：內建的向量資料庫。 BUILT_IN：內建的向量資料庫。 ADB：AnalyticDB for PostgreSQL 資料庫。	BUILT_IN
SinkInstanceId	string	知識庫的向量儲存的執行個體 ID。	gp-bp1gq62t1788yxxxx
SinkRegion	string	知識庫的向量儲存的執行個體地區。	cn-hangzhou
ConfgModel	string
EnableRewrite	boolean
Code	string	錯誤狀態代碼。	Index.InvalidParameter
Message	string	錯誤資訊。	Required parameter(%s) missing or invalid, please check the request parameters.
Success	boolean	介面調用是否成功，可能值： true：成功。 false：失敗。	true
Status	string	介面返回的狀態代碼。	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",
        "ConfgModel": "",
        "EnableRewrite": true
      }
    ]
  },
  "Code": "Index.InvalidParameter",
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Success": true,
  "Status": "200"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。