文档

GetParseResult - 获取文档解析结果

更新时间:

获取文档解析结果。可查询文档的解析状态以及获取文档的解析结果。

接口说明

前提条件

已开通 百炼服务和通义点金服务。

获取到 workspaceId:获取 workspace 标识

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

POST /{workspaceId}/api/library/document/getParseResult

请求参数

名称类型必填描述示例值
workspaceIdstring

路径参数,业务空间 id。

llm-xxxxx
bodyobject

请求 body。

docIdstring

文档 id

873648346573245
libraryIdstring

文档库 id

sjdgdsfg

返回参数

名称类型描述示例值
object

ResultCode

costlong

耗时

null
dataobject

响应数据

fileTypestring

文件类型

pdf
providerTypestring

供应商类型

null
requestIdstring

请求 id

b0a202e2-5031-4589-a6d7-39185f0d8d01
resultobject

解析结果

{ "Status": "Success", "Data": {}, "Message": null, "TaskId": "docmind-20240601-123abc" }
statusstring

文档解析状态

WaitRefresh
dataTypestring

数据类型

null
errCodestring

错误码

0
messagestring

错误信息

ok
requestIdstring

请求 id

0abb793617204049360065953ec6dd
successboolean

是否成功

true
timestring

时间戳

2024-04-24 11:54:34

示例

正常返回示例

JSON格式

{
  "cost": 0,
  "data": {
    "fileType": "pdf",
    "providerType": "null",
    "requestId": "b0a202e2-5031-4589-a6d7-39185f0d8d01",
    "result": {
      "Status": "Success",
      "Data": {},
      "Message": null,
      "TaskId": "docmind-20240601-123abc"
    },
    "status": "WaitRefresh"
  },
  "dataType": "null",
  "errCode": "0",
  "message": "ok",
  "requestId": "0abb793617204049360065953ec6dd",
  "success": true,
  "time": "2024-04-24 11:54:34"
}

错误码

访问错误中心查看更多错误码。