Skip to main content
字段抽取

提交抽取任务

提交结构化信息抽取任务,返回 biz_id 用于异步查询

POST
/extract/submit
cURL
curl --request POST \
  --url 'https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v2/apps/parse-x/extract/submit' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "file_url": "<string>",
  "parsed_file_biz_id": "<string>",
  "file_name": "<string>",
  "file_name_extension": "<string>",
  "config_id": "<string>",
  "processing": {
    "user_prompt": "<string>",
    "extract_processing_config": {
      "citation_required": false,
      "allow_inference": false,
      "extract_schema": {}
    }
  },
  "output": {
    "oss_config": {
      "bucket": "<string>",
      "endpoint": "<string>",
      "access_key_id": "<string>",
      "access_key_secret": "<string>",
      "security_token": "<string>"
    }
  }
}
'
{
  "request_id": "<string>",
  "data": {
    "biz_id": "<string>"
  }
}
提交结构化信息抽取任务,返回 biz_id。输入可以是文件 URL,也可以是此前解析任务返回的 parsed_file_biz_id。信息抽取为异步任务:提交后使用该 ID 调用查询抽取结果获取处理状态和结构化结果。
调用前请确保已获取 API Key,详见鉴权

请求参数

参数类型必填说明
file_urlstring待抽取文档的可访问 URL。与 parsed_file_biz_id 二选一
parsed_file_biz_idstring已完成解析的业务任务 ID。与 file_url 二选一
file_namestring文件名
file_name_extensionstring文件类型
config_idstring已保存的 Extract 配置 ID,例如 config_xxx
processingobject内联处理配置,优先级高于 config_id
processing.user_promptstring用户 Prompt
processing.extract_processing_configobject内联抽取处理配置。使用 processing 时必须提供
processing.extract_processing_config.citation_requiredboolean是否返回引用信息,默认 true
processing.extract_processing_config.allow_inferenceboolean是否允许推断,默认 false
processing.extract_processing_config.extract_schemaobject抽取 Schema,值为 JSON 对象。使用内联处理配置时必须提供
outputobject输出配置
output.oss_configobjectOSS 输出配置
output.oss_config.bucketstringOSS Bucket 名称
output.oss_config.endpointstringOSS Endpoint
output.oss_config.access_key_idstringOSS AccessKey ID
output.oss_config.access_key_secretstringOSS AccessKey Secret
output.oss_config.security_tokenstringOSS Security Token
请求需要分别完成两组二选一:文件来源使用 file_urlparsed_file_biz_id;处理定义使用 config_id 或内联 processing。复用解析结果时,该结果需要仍在 7 天保留期内,并且输入类型必须支持复用。

返回结果

字段类型说明
request_idstring请求 ID
data.biz_idstring业务任务 ID,用于调用 /extract/result

代码示例

以下示例分别展示两种处理定义, config_idprocessing 同时存在时,processing 会优先生效。示例中的 URL、任务 ID 和配置 ID 均为脱敏占位值。
  • 使用已保存配置
  • 使用内联配置
通过
curl -X POST 'https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v2/apps/parse-x/extract/submit' \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "file_url": "https://example.com/contracts/sample.pdf",
    "file_name": "sample.pdf",
    "config_id": "config_xxx"
  }'
提交抽取任务响应
{
  "request_id": "request_xxx",
  "data": {
    "biz_id": "biz_xxx"
  }
}
抽取不支持音视频输入。复用的解析结果若已超过 7 天保留期或类型不匹配,接口会返回对应错误;详见错误码。Schema 规模和长文档页数仅按工程设计边界规划,公开配额以正式页面为准,见支持的文件与限制
提交后,使用查询抽取结果轮询任务状态并获取结构化结果。

Authorizations

string
header
required

Body

application/json
string

待抽取文档的可访问 URL。与 parsed_file_biz_id 二选一

string

已完成解析的业务任务 ID。与 file_url 二选一

string

文件名

string

文件类型

string

已保存的 Extract 配置 ID,例如 config_xxx。使用该方式时不要传递 processing

object

内联处理配置。未传 config_id 时必须提供,并且不能与 config_id 同时传递

object

输出配置

Response

200-application/json
string

请求 ID

object
Managed Agent API
  • API 总览与认证
Sandbox API
Token Plan API
Security API
记忆库 API
Flow Agent API
RAG API
Connector API
框架集成
  • 框架
Assistant API(下线中)
  • 概览