取得指定知識庫中的檔案，以及它們的概要資訊。
介面說明
- RAM 使用者（子帳號）需要首先取得阿里雲百煉的 API 權限（需要
AliyunBailianDataFullAccess，已包括 sfm:ListIndexFiles 權限點），並加入一個業務空間後，方可呼叫本介面。阿里雲帳號（主帳號）可直接呼叫無須授權。建議您透過最新版阿里雲百煉 SDK來呼叫本介面。 - 呼叫本介面前，請確保您的知識庫已經建立完成且未被刪除（即知識庫 ID
IndexId有效）。 - 本介面具有冪等性。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
授權資訊
下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：
- 操作：是指具體的許可權點。
- 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
-
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指雲產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。
操作 | 存取層級 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
sfm:ListIndexFiles | list | *All Resource
| 無 | 無 |
請求文法
路徑參數
名稱 | 類型 | 必填 | 描述 | 樣本值 |
|---|---|---|---|---|
| WorkspaceId | string | 是 | 知識庫所屬的業務空間 ID。取得方式請參見如何使用業務空間。 | llm-3z7uw7fwz0vexxxx |
請求參數
名稱 | 類型 | 必填 | 描述 | 樣本值 |
|---|---|---|---|---|
| IndexId | string | 是 | 知識庫 ID，即 CreateIndex 介面返回的 | 79c0alxxxx |
| DocumentStatus | string | 否 | 即透過檔案匯入狀態對介面返回的檔案列表進行過濾。取值範圍：
預設值為空，即不使用檔案匯入狀態對結果進行過濾。 枚舉值：
| FINISH |
| DocumentName | string | 否 | 即透過檔案名稱（不含副檔名）對介面返回的檔案列表進行過濾。預設值為空，即不使用檔案名稱對結果進行過濾。 | product-overview |
| EnableNameLike | string | 否 | 是否開啟檔案名稱的模糊比對，與
預設值為 false。 枚舉值：
| false |
| PageNumber | integer | 否 | 指定要查詢的頁碼。起始值為 1。預設值為 1。 | 1 |
| PageSize | integer | 否 | 指定分頁查詢時每頁展示的檔案數量。最大值不限。 預設值為 10。 | 10 |
返回參數
名稱 | 類型 | 描述 | 樣本值 |
|---|---|---|---|
object | Schema of Response | ||
| RequestId | string | 請求 ID。 | 35A267BF-xxxx-54DB-8394-AA3B0742D833 |
| Code | string | 錯誤狀態碼。 | InvalidParameter |
| Message | string | 錯誤資訊。 | Required parameter(%s) missing or invalid, please check the request parameters. |
| Success | boolean | 介面呼叫是否成功，可能值：
| true |
| Data | object | 介面業務資料欄位。 | |
| Documents | array<object> | 返回知識庫中的檔案列表，按文件匯入時間倒序排序（與控制台一致）。 | |
object | 檔案物件。 | ||
| SourceId | string | cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx | |
| Id | string | 檔案 ID。 | doc_c134aa2073204a5d936d870bf960f56axxxxxxxx |
| Name | string | 檔案名稱。 | product-overview |
| Size | integer | 檔案大小，單位位元組 Byte。 | 996765 |
| DocumentType | string | 檔案格式類型。可能值為： pdf、docx、doc、txt、md、pptx、ppt、png、jpg、jpeg、bmp、gif、EXCEL。 | |
| Status | string | 檔案匯入狀態。可能值為：
枚舉值：
| RUNNING |
| Code | string | 檔案匯入錯誤狀態碼。 | 110002 |
| Message | string | 檔案匯入錯誤資訊。 | check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid |
| GmtModified | integer | 檔案匯入知識庫的時間，採用 Unix timestamp 格式。 | 1744856423000 |
| IndexId | string | 知識庫 ID。 | pno97txxxx |
| TotalCount | integer | 返回結果的總筆數。 | 2437 |
| PageNumber | integer | 返回指定的頁碼。 | 1 |
| PageSize | integer | 返回指定的每頁筆數。 | 10 |
| Status | string | 介面返回的狀態碼。 | 200 |
樣本
正常返回樣本
JSON格式