Skip to main content
数据连接（原应用数据）

GetParseSettings - 获取类目解析设置

查询指定类目的数据解析设置。

接口说明

  • RAM 用户（子账号）需要首先获取阿里云百炼的 API 权限（AliyunBailianDataFullAccess或AliyunBailianDataReadOnlyAccess均可，已包括 sfm:GetParseSettings 权限点），并加入一个业务空间后，方可调用本接口。阿里云账号（主账号）可直接调用无须授权。建议您通过最新版阿里云百炼 SDK来调用本接口。
  • 本接口具有幂等性。
限流说明： 本接口频繁调用会被限流，频率请勿超过 10 次/秒。如遇限流，请稍后重试。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。 调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用前面加 * 表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
sfm:GetParseSettingsget
*全部资源
*
    无
无

请求语法 

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

请求参数

名称类型必填描述示例值
WorkspaceIdstring否

文件所属的业务空间 ID。获取方式请参见如何使用业务空间。

llm-3shx2gu255oqxxxx
CategoryIdstring否

类目 ID，即 AddCategory 接口返回的CategoryId，或者在应用数据-非结构化数据页签，单击类目名称旁的 ID 图标获取。

cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

本次请求 requestId

35A267BF-xxxx-54DB-8394-AA3B0742D833
Dataarray<object>

请求成功返回的业务数据。

Dataobject

返回具体内容

FileTypestring

文件类型，扩展名，可能值为： pdf、docx、doc 等，列举当前类目中支持的所有文件类型。

pdf
ParserDisplayNamestring

解析方式的显示名称。

电子文档解析
ParserConfigobject

解析器配置，仅在类型被设置为 Qwen VL 解析时才会返回。

ModelNamestring

模型名称。

枚举值：
  • qwen-vl-max：qwen-vl-max。
  • qwen-vl-plus：qwen-vl-plus。
qwen-vl-max
ModelPromptstring

调用 Qwen VL 解析时的 Prompt。

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

解析该类目下当前类型文件使用的解析器。可能值为：

  • DOCMIND：智能文档解析
  • DOCMIND_DIGITAL：电子文档解析
  • DOCMIND_LLM_VERSION：大模型文档解析
  • DASH_QWEN_VL_PARSER：Qwen VL 解析
DOCMIND
Statusstring

接口返回的状态码。

200
Successboolean

接口调用是否成功，可能值为：

  • true：成功 。
  • false：失败。
True
Messagestring

错误信息。

workspace id is null or invalid.
Codestring

错误状态码。

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"
}

错误码

应用调用
应用组件
Assistant API（下线中）
更多