1. 接口描述
接口请求域名: es.tencentcloudapi.com 。
本接口用于获取文档解析异步处理结果。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetDocumentParseResult。 |
Version | 是 | String | 公共参数,本接口取值:2025-01-01。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
TaskId | 是 | String | 任务 Id 示例值:10343124 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Status | Integer | 任务状态,-1:失败,0:运行中,1:成功。 示例值:1 |
DocumentParseResultUrl | String | 结果文件。 示例值:https://ai-search-doc-bj-xxxxx.cos.ap-beijing.myqcloud.com/&2 F1257780094/2013/81e11a5472dd4288a0b998c032b4df26.zip |
FailedPages | Array of Integer | 失败的页码。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1,2 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取文档解析任务结果
输入示例
POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetDocumentParseResult
<公共请求参数>
{
"TaskId": "3cce395a-fe9e-460f-9b19-8920d15867e3"
}
输出示例
{
"Response": {
"DocumentParseResultUrl": "https://aisearch-xxxx.cos.ap-guangzhou.myqcloud.com/%2F1257780094/2025/87a8419e7e7d4bd9ad17267c47d12168.zip?x-cos-security-token=6VP365zlkuYclNSS8Uo2nO0HnR8EnMpa3af95a3e21d25bc893099fa2755135125OWpJjDZaOCMgmOglpve2Riw_eQhuqLM0X-s-TelbIipYTGRWgodzr4MspocQuTqi-qxIWjgLlCyv52JP2uA-ebvnGjaqsfxDZiaQf8SLEvv_OpdZ_DWdf2GVFJlxcMkyRb3swd900raxsnGuq1HOq2apiWxIqdyKD2XNeicqJiKvXBIwNozOhUt9bj9BBYLOiQOjHw5dLFDJM6xa53b9X2Z1LJKK53FlNJ5buCZ9Up18vKJn1YtFMAxvMYY-N1peQpzBo6OC-nj5ObvGYYSz-OOy3edOkaHzHksKuxBz181sk2EXrWf4NyF4pbuKM0YkFYek_d06s9n3MBsqXBIv79U3vmSfpjsTM7I26idRZg&q-sign-algorithm=sha1&q-ak=AKIDlCtP1SmwsERqUnRAwLlOZ21NbUGlevaln-DCwJZcft9vsiPNHgEMiwusHrhFpCa0&q-sign-time=1744014678%3B1744101078&q-key-time=1744014678%3B1744101078&q-header-list=host&q-url-param-list=x-cos-security-token&q-signature=ef15228dff60abfe0f7a4e51df7d81cf1fcff767",
"FailedPages": null,
"RequestId": "7da936b2-8d10-42bd-b65f-8d10ae99927a",
"Status": 1
}
}
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 SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
LimitExceeded | 超过配额限制。 |