Skip to content

按版本获取文档文本

GET
/v1/versions/text

按 versionId 取该版本的文档文本,数字件与扫描件统一形态返回。内部按文件类型路由:数字文档取确定性抽取文本、扫描件 / 图片取 OCR 识别文本,响应 source 标注来源(EXTRACTED / OCR)。status 四态:READY(text/pages 可用)、PENDING(仍在处理,可稍后轮询,不报错也不返回半成品)、FAILED(真实处理失败,failReason 给出真实失因)、NOT_APPLICABLE(确无文本:纯二进制等无文本衍生物的类型、无文本层的扫描件与空文档、OCR 识别无文字,重试也不会有文本)。同时返回整篇拼接文本 text 与按页结构 pages(OCR 来源全页覆盖、每页携页级置信度与页级状态);传 page 时仅返回该页文本;传 includeLayout=true 且为 OCR 来源时每页附版面明细 layout(加工器页对象原样 JSON,平台不解释、形状以加工器契约为准)、并回传头级 schema / 引擎版本与坐标系。FAILED / NOT_APPLICABLE 终态只回状态与失因、不返回页级明细。前置:对该版本所属文档具备下载权限。

参数

请求头参数

Authorization*

访问令牌以 Bearer 方案在 HTTP Authorization 请求头携带。请在此填入完整值(含 Bearer 前缀),例如:Bearer <accessToken>

类型
string
必填
示例"Bearer <accessToken>"
X-Atk-User-Token

强通道(可选):以某已签发的 atkonbase 用户会话 token 调用,ACL 解析与操作归属走该用户。与弱通道 X-Atk-Act-As-Source(-Id) 互斥——同时携带返回业务码 101008。两个 SDK 均由 client 侧拦截器统一注入(actAsToken()),此处仅为门户演练暴露。

类型
string
X-Atk-Act-As-Source

弱通道(可选):外部身份来源标识,须与 X-Atk-Act-As-Source-Id 成对携带,缺一返回业务码 101009。仅当该 Client 的 act_as_user_allowed=true 时生效,否则静默降级为 APP_ONLY;与强通道互斥。两个 SDK 均由 client 侧拦截器统一注入(actAsSource()),此处仅为门户演练暴露。

类型
string
X-Atk-Act-As-Source-Id

弱通道(可选):外部身份在其来源系统内的 ID,须与 X-Atk-Act-As-Source 成对携带,缺一返回业务码 101009

类型
string

查询参数

versionId*
类型
string
必填
page
类型
integer
格式
"int32"
includeLayout
类型
boolean
默认
false

响应

OK

*/*
JSON
{
  
"code": 0,
  
"data": {
  
  
"versionId": "string",
  
  
"status": "string",
  
  
"source": "string",
  
  
"text": "string",
  
  
"pages": [
  
  
  
{
  
  
  
  
"page": 0,
  
  
  
  
"text": "string",
  
  
  
  
"confidence": 0,
  
  
  
  
"coverage": 0,
  
  
  
  
"ocrStatus": "string",
  
  
  
  
"layout": {
  
  
  
  
}
  
  
  
}
  
  
],
  
  
"failReason": "string",
  
  
"schemaVersion": "string",
  
  
"engineVersion": "string",
  
  
"coordinateSystem": {
  
  
}
  
},
  
"ts": 0,
  
"rid": "string",
  
"msg": "string",
  
"success": true
}

试验场

服务器
请求头
变量

示例

技术支持 VitePress OpenAPI