文档解析(异步)

最近更新时间:2025-05-08 01:33:33

我的收藏

1. 接口描述

接口请求域名: es.tencentcloudapi.com 。

本服务可将各类格式文档精准转换为标准格式,满足企业知识库建设、技术文档迁移、内容平台结构化存储等需求。
本接口为异步接口,有单账号调用上限控制,如您有提高并发限制的需求请联系我们

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ParseDocumentAsync。
Version String 公共参数,本接口取值:2025-01-01。
Region String 公共参数,详见产品支持的 地域列表
Document Document 文件信息。
示例值:{ "FileType": "TXT", "FileUrl": "", "FileContent": "data:text/plain;base64,SGVsbG8sIFdvcmxkIQ==", "FileName": "test.txt" }
ModelName String 模型名称,可选模型列表:doc-llm。
示例值:doc-llm

3. 输出参数

参数名称 类型 描述
TaskId String 任务 id
示例值:6538a10a-18c5-4cba-a870-b02e78b46f71
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 文件解析异步任务

输入示例

POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ParseDocumentAsync
<公共请求参数>

{
    "Document": {
        "FileType": "TXT",
        "FileUrl": "",
        "FileContent": "data:text/plain;base64,SGVsbG8sIFdvcmxkIQ==",
        "FileName": "test.txt"
    },
    "ModelName": "doc-llm"
}

输出示例

{
    "Response": {
        "RequestId": "e3a1a515-e53c-473f-9114-6d05a19d1c0c",
        "TaskId": "acf20b7e-47b2-4cfd-8aba-d170dee34cfc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
LimitExceeded 超过配额限制。