Elasticsearch Service 实时文档解析

1. 接口描述

接口请求域名： es.ai.tencentcloudapi.com 。

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

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

3. 输出参数

参数名称	类型	描述
Progress	String	进度：0-100。示例值：100
DocumentParseResultUrl	String	解析文件结果。示例值：https://ai-search-doc-bj-xxxxx.cos.ap-beijing.myqcloud.com/&2 F1257780094/2013/81e11a5472dd4288a0b998c032b4df26.zip
FailedPages	Array of Integer	失败页码。示例值：[1]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。

4. 示例

示例1 文档解析示例

输入示例

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

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

输出示例

{
    "Response": {
        "RequestId": "7ab3fd45-61e7-4e5e-8194-b1997f67fc18",
        "Progress": "0",
        "DocumentParseResultUrl": "",
        "FailedPages": []
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
UnknownParameter	未知参数错误。

实时文档解析

本页目录：