GetParseSettings - 擷取類目解析設定 - Alibaba Cloud Model Studio

查詢指定類目的資料解析設定。

介面說明

RAM 使用者（子帳號）需要首先擷取阿里雲百鍊的 API 許可權（AliyunBailianDataFullAccess或AliyunBailianDataReadOnlyAccess均可，已包括 sfm:GetParseSettings 許可權點），並加入一個業務空間後，方可調用本介面。阿里雲帳號（主帳號）可直接調用無須授權。建議您通過最新版阿里雲百鍊 SDK來調用本介面。
本介面具有等冪性。

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

sfm:GetParseSettings

get

*全部資源

*

無

請求文法

GET /{WorkspaceId}/datacenter/parser/settings HTTP/1.1

路徑參數

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

請求參數

名稱	類型	必填	描述	樣本值
CategoryId	string	否	類目 ID，即 AddCategory 介面返回的`CategoryId`，或者在應用資料-非結構化資料頁簽，單擊類目名稱旁的 ID 表徵圖擷取。	cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	本次請求 requestId	35A267BF-xxxx-54DB-8394-AA3B0742D833
Data	array<object>	請求成功返回的業務資料。
	array<object>	返回具體內容
FileType	string	檔案類型，副檔名，可能值為： pdf、docx、doc 等，列舉當前類目中支援的所有檔案類型。	pdf
ParserDisplayName	string	解析方式的顯示名稱。	電子文檔解析
ParserConfig	object	解析器配置，僅在類型被設定為 Qwen VL 解析時才會返回。
ModelName	string	模型名稱。枚舉值： qwen-vl-max : qwen-vl-max qwen-vl-plus : qwen-vl-plus	qwen-vl-max
ModelPrompt	string	調用 Qwen VL 解析時的 Prompt。	#角色你是一個專業的圖片內容標註人員，擅長識別並描述出圖片中的內容。 # 任務目標請結合輸入圖片，詳細描述圖片中的內容。
Parser	string	解析該類目下當前類型檔案使用的解析器。可能值為： DOCMIND：智能文檔解析 DOCMIND_DIGITAL：電子文檔解析 DOCMIND_LLM_VERSION：大模型文檔解析 DASH_QWEN_VL_PARSER：Qwen VL 解析	DOCMIND
Status	string	介面返回的狀態代碼。	200
Success	boolean	介面調用是否成功，可能值為： true：成功。 false：失敗。	True
Message	string	錯誤資訊。	workspace id is null or invalid.
Code	string	錯誤狀態代碼。	success

樣本

正常返回樣本

JSON格式

{
  "RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
  "Data": [
    {
      "FileType": "pdf",
      "ParserDisplayName": "電子文檔解析",
      "ParserConfig": {
        "ModelName": "qwen-vl-max",
        "ModelPrompt": "#角色\n你是一個專業的圖片內容標註人員，擅長識別並描述出圖片中的內容。\n# 任務目標\n請結合輸入圖片，詳細描述圖片中的內容。"
      },
      "Parser": "DOCMIND"
    }
  ],
  "Status": "200",
  "Success": true,
  "Message": "workspace id is null or invalid.",
  "Code": "success"
}

錯誤碼

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

變更歷史

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