ChangeParseSetting

Updated at:
Copy as MD

Configures the parsing method for a specific file type. For example, you can specify LLM-based document parsing for .pdf files and the Qwen VL Parser for .jpg files.

Operation description

  • A RAM user (sub-account) must first obtain the required API permissions for Alibaba Cloud Model Studio (the AliyunBailianDataFullAccess policy, which includes the sfm:ChangeParseSetting permission) and join a workspace before calling this operation. An Alibaba Cloud account (primary account) can call this operation directly without authorization. We recommend using the latest version of the Alibaba Cloud Model Studio SDK to call this operation.

  • This operation is not idempotent.

Throttling The system throttles frequent calls to this operation. Do not exceed a frequency of 10 requests per second. If your request is throttled, try again later.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sfm:ChangeParseSetting

update

*All Resource

*

None

None

Request syntax

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

Path Parameters

Parameter

Type

Required

Description

Example

WorkspaceId

string

Yes

The ID of the workspace that contains the category. For more information about how to obtain the workspace ID, see How to use workspaces.

llm-3z7uw7fwz0vxxxx

Request parameters

Parameter

Type

Required

Description

Example

CategoryId

string

Yes

The category ID. This is the CategoryId returned by the AddCategory operation. You can also obtain the ID from the Application Data - Unstructured Data tab by clicking the ID icon next to the category name.

cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx

FileType

string

Yes

The file type, specified by its extension. Valid values:

  • doc

  • docx

  • ppt

  • pptx

  • xls

  • xlsx

  • md

  • txt

  • pdf

  • png

  • jpg

  • jpeg

  • bmp

  • gif

  • html

pdf

Parser

string

Yes

The identifier for the parser. Different parsers are suitable for different scenarios. For more information, refer to the knowledge base. Valid values:

  • DOCMIND (intelligent document parsing)

  • DOCMIND_DIGITAL (digital document parsing)

  • DOCMIND_LLM_VERSION (LLM-based document parsing)

  • DASH_QWEN_VL_PARSER (Qwen VL Parser)

Valid values:

  • DOCMIND :

    intelligent document parsing

  • DOCMIND_LLM_VERSION :

    LLM-based document parsing

  • DOCMIND_DIGITAL :

    digital document parsing

  • DASH_QWEN_VL_PARSER :

    Qwen VL Parser

DOCMIND

ParserConfig

object

No

The parser configuration. This parameter is required only when the Parser parameter is set to DASH_QWEN_VL_PARSER.

modelName

string

No

The model name.

Valid values:

  • qwen-vl-max :

    qwen-vl-max

  • qwen-vl-plus :

    qwen-vl-plus

qwen-vl-max

modelPrompt

string

No

The prompt to use when calling the Qwen VL Parser.

#角色 你是一个专业的图片内容标注人员,擅长识别并描述出图片中的内容。 # 任务目标 请结合输入图片,详细描述图片中的内容。

Response elements

Element

Type

Description

Example

object

The response object.

RequestId

string

The request ID.

7BA8ADD9-53D6-53F0-918F-A1E776AD230E

Data

object

The data returned for a successful request.

ChangeResult

boolean

Indicates whether the configuration was successfully updated.

  • true: The configuration was updated.

  • false: The configuration failed to be updated.

true

Status

string

The status code returned for the request.

200

Success

boolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.

  • false: The request failed.

true

Message

string

The error message.

User not authorized to operate on the specified resource.

Code

string

The error code.

InvalidParameter

Examples

Success response

JSON format

{
  "RequestId": "7BA8ADD9-53D6-53F0-918F-A1E776AD230E",
  "Data": {
    "ChangeResult": true
  },
  "Status": "200",
  "Success": true,
  "Message": "User not authorized to operate on the specified resource.",
  "Code": "InvalidParameter"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.