DescribeFile - 查詢文檔狀態 -

擷取文檔基本資料，包括文檔名稱、類型、狀態等。

介面說明

RAM 使用者（子帳號）需先擷取阿里雲百鍊的資料許可權（AliyunBailianDataFullAccess或AliyunBailianDataReadOnlyAccess均可，已包括 sfm:DescribeFile 許可權點），並加入一個業務空間後，方可調用本介面。阿里雲帳號（主帳號）可直接調用無須授權。建議您通過最新版阿里雲百鍊 SDK來調用本介面。
您在阿里雲百鍊應用資料中上傳的非結構化文檔，也可以通過此介面進行查詢。
本介面具有等冪性。

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

sfm:DescribeFile

none

*全部資源

*

無

請求文法

GET /{WorkspaceId}/datacenter/file/{FileId}/ HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
WorkspaceId	string	是	文檔所屬的業務空間 ID。擷取方式請參見如何使用業務空間。	llm-3shx2gu255oqxxxx
FileId	string	是	文檔 ID，即 AddFile 介面返回的`FileId`。您也可以在應用資料頁面，單擊檔案名稱旁的 ID 表徵圖擷取。	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
Code	string	錯誤狀態代碼。	Success
Data	object	介面業務資料欄位。
CategoryId	string	文檔所屬類目 ID。	cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
CreateTime	string	文檔實際添加到阿里雲百鍊中的時間戳記，格式: yyyy-MM-dd HH:mm:ss，時區：UTC + 8。	2024-09-09 12:45:43
FileId	string	文檔 ID。	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
FileName	string	文檔名稱。	XXX產品介紹.pdf
FileType	string	文件類型，副檔名。可能值為： pdf、docx、doc、txt、md、pptx、ppt、xlsx、xls、html、png、jpg、jpeg、bmp、gif。	pdf
Parser	string	解析該文檔使用的解析器類型。可能值為： DASHSCOPE_DOCMIND：預設文件解析器。	DASHSCOPE_DOCMIND
SizeInBytes	integer	文檔大小，單位位元組 Byte。	1234
Status	string	用於非結構化知識庫的文檔（類型為 UNSTRUCTURED），狀態可能值為： INIT: 待解析。 PARSING: 解析中。 PARSE_SUCCESS：解析完成。說明必須等到狀態為 PARSE_SUCCESS 才能將文檔匯入知識庫。 PARSE_FAILED：解析失敗。	PARSE_SUCCESS
Tags	array	文檔關聯的標籤列表，一個文檔支援關聯多個標籤。
	string	文檔的標籤。	產品介紹
Message	string	錯誤資訊。	Requests throttling triggered.
RequestId	string	請求 ID。	17204B98-xxxx-4F9A-8464-2446A84821CA
Status	string	介面返回的狀態代碼。	200
Success	boolean	介面調用是否成功，可能值為： true：成功。 false：失敗。	true

樣本

正常返回樣本

JSON格式

{
  "Code": "Success",
  "Data": {
    "CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx",
    "CreateTime": "2024-09-09 12:45:43",
    "FileId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx",
    "FileName": "XXX產品介紹.pdf",
    "FileType": "pdf",
    "Parser": "DASHSCOPE_DOCMIND",
    "SizeInBytes": 1234,
    "Status": "PARSE_SUCCESS",
    "Tags": [
      "產品介紹"
    ]
  },
  "Message": "Requests throttling triggered.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

錯誤碼

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

變更歷史

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