GetParseSettings - Alibaba Cloud Model Studio - Alibaba Cloud Documentation Center

Queries the data parsing settings in a specified category.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
sfm:GetParseSettings	get	All Resources ``	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	No	The ID of the workspace to which the file belongs. For more information, see Use workspaces.	llm-3shx2gu255oqxxxx
CategoryId	string	No	The category ID, which is the `CategoryId` returned by AddCategory. To view the category ID, click the ID icon next to the category name on the Unstructured Data tab of the Application Data page.	cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	35A267BF-xxxx-54DB-8394-AA3B0742D833
Data	array<object>	The returned data fields.
Data	object	The returned data.
FileType	string	The file type. Valid values are: pdf, docx, doc, etc. All supported file types in the category are listed here.	pdf
ParserDisplayName	string	The display name of the parsing method.	Digital parsing
ParserConfig	object	The parser configuration. Currently, this is available only for Qwen VL parsing.
ModelName	string	The model name.	- qwen-vl-max - qwen-vl-plus
ModelPrompt	string	The prompt used for parsing.	# Role You are a professional image content annotator, skilled in identifying and describing the contents of images. # Task Objective Based on the input image, provide a detailed description of its contents.
Parser	string	The parser used for files of the current type. Valid values: DOCMIND (Intelligent parsing) DOCMIND_DIGITAL (Digital parsing) DOCMIND_LLM_VERSION (LLM parsing) DASH_QWEN_VL_PARSER (Qwen VL parsing)	DOCMIND
Status	string	The HTTP status code returned.	200
Success	boolean	Indicates whether the call is successful. Valid values: true false	True
Message	string	The error message.	workspace id is null or invalid.
Code	string	The status code.	success

Examples

Sample success responses

JSONformat

{
  "RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
  "Data": [
    {
      "FileType": "pdf",
      "ParserDisplayName": "Digital parsing",
      "ParserConfig": {
        "ModelName": "- qwen-vl-max\n- qwen-vl-plus",
        "ModelPrompt": "# Role  \nYou are a professional image content annotator, skilled in identifying and describing the contents of images.  \n\n# Task Objective  \nBased on the input image, provide a detailed description of its contents."
      },
      "Parser": "DOCMIND"
    }
  ],
  "Status": 200,
  "Success": true,
  "Message": "workspace id is null or invalid.",
  "Code": "success"
}

Error codes

For a list of error codes, visit the Service error codes.