ListIndexFileDetails查詢知識庫文檔詳情-大模型服務平台百鍊-阿里雲 - Alibaba Cloud Model Studio

擷取指定知識庫中的檔案，以及它們的詳細資料。

介面說明

RAM 使用者（子帳號）需要首先擷取阿里雲百鍊的 API 許可權（需要AliyunBailianDataFullAccess，已包括 sfm:ListIndexFiles 許可權點），然後才能調用本介面。阿里雲帳號（主帳號）可直接調用無須授權。建議您通過最新版阿里雲百鍊 SDK來調用本介面。
調用本介面前，請確保您的知識庫已經建立完成且未被刪除（即知識庫 IDIndexId有效）。
本介面具有等冪性。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

sfm:ListIndexFileDetails

list

*全部資源

*

無

請求文法

POST /{WorkspaceId}/index/list_index_file_detail HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
WorkspaceId	string	是	知識庫所屬的業務空間 ID。擷取方式請參見如何使用業務空間。	llm-3z7uw7fwz0vexxxx

請求參數

名稱	類型	必填	描述	樣本值
IndexId	string	否	知識庫 ID，即 CreateIndex 介面返回的`Data.Id`。	79c0alxxxx
DocumentStatus	string	否	即通過檔案匯入狀態對介面返回的檔案清單進行過濾。取值範圍： INSERT_ERROR：檔案匯入失敗。 RUNNING：檔案匯入中。 DELETED：檔案已刪除。 FINISH：檔案匯入成功。預設值為空白，即不使用檔案匯入狀態對結果進行過濾。枚舉值： INSERT_ERROR : 檔案匯入失敗 RUNNING : 檔案匯入中 DELETED : 檔案已刪除 FINISH : 檔案匯入成功	FINISH
DocumentName	string	否	即通過檔案名稱對介面返回的檔案詳情列表進行過濾。預設值為空白，即不使用檔案名稱對結果進行過濾。	翻譯平台營運文檔
PageNumber	integer	否	指定要查詢的頁碼。起始值為 1。預設值為 1。	1
PageSize	integer	否	指定分頁查詢時每頁展示的檔案數量，最大值 10。	10
EnableNameLike	string	否	是否開啟檔案名稱的模糊比對，與`DocumentName`參數配合使用。取值範圍： true：根據檔案名稱對介面返回的檔案清單進行模糊比對。 false：預設根據檔案名稱進行精確匹配。預設值為 false。枚舉值： true : 開啟 false : 不開啟	false

返回參數

名稱	類型	描述	樣本值
	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：成功。 false：失敗。	true
Data	object	介面業務資料欄位。
Documents	array<object>	返回知識庫中的檔案清單，按檔案匯入時間倒序排序（與控制台一致）。
	object	檔案對象。
Status	string	檔案匯入狀態。可能值為： INSERT_ERROR：檔案匯入失敗。 RUNNING：檔案匯入中。 DELETED：檔案已刪除。 FINISH：檔案匯入成功。	RUNNING
EnableHeaders	string	Excel 檔案表頭是否支援拼裝。	true
OverlapSize	string	分段重疊長度。	100
Message	string	檔案匯入錯誤資訊。	check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid
Size	integer	檔案大小，單位位元組 Byte。	996764
SourceId	string	類目 ID。	cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx
GmtModified	integer	檔案匯入知識庫的時間，採用 Unix timestamp 格式。	1744856423000
DocumentType	string	檔案格式類型。可能值為： pdf、docx、doc、txt、md、pptx、ppt、png、jpg、jpeg、bmp、gif、EXCEL。	pdf
ChunkMode	string	自訂切分。	DashSplitter
Code	string	檔案匯入錯誤狀態代碼。	110002
separator	string	分句標識符。	" "
Name	string	檔案名稱。	翻譯平台營運文檔
ChunkSize	string	分段長度，即文本切片的字元數。	600
Id	string	檔案 ID。	doc_c134aa2073204a5d936d870bf960f56axxxxxxxx
IndexId	string	知識庫 ID。	79c0alxxxx
TotalCount	integer	返回結果的總條數。	2437
PageNumber	integer	返回指定的頁碼。	1
PageSize	integer	返回指定的每頁條數。	10
Status	string	介面返回的狀態代碼。	200

樣本

正常返回樣本

JSON格式

{
  "RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
  "Code": "InvalidParameter\n",
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Success": true,
  "Data": {
    "Documents": [
      {
        "Status": "RUNNING",
        "EnableHeaders": "true",
        "OverlapSize": "100",
        "Message": "check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid",
        "Size": 996764,
        "SourceId": "cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx\n",
        "GmtModified": 1744856423000,
        "DocumentType": "pdf",
        "ChunkMode": "DashSplitter",
        "Code": "110002",
        "separator": "\" \"",
        "Name": "翻譯平台營運文檔\n",
        "ChunkSize": "600",
        "Id": "doc_c134aa2073204a5d936d870bf960f56axxxxxxxx\n"
      }
    ],
    "IndexId": "79c0alxxxx",
    "TotalCount": 2437,
    "PageNumber": 1,
    "PageSize": 10
  },
  "Status": "200"
}

錯誤碼

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

變更歷史

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