查询异步任务结果

最近更新时间:2019-10-12 15:53:35

1. 接口描述

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

异步任务结果查询接口

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTask
Version String 公共参数,本接口取值:2018-12-13
Region String 公共参数,本接口不需要传递此参数。
TaskId String 任务 ID
EccAppid String 业务应用ID,与账号应用APPID无关,是用来方便客户管理服务的参数(暂时无需传入)。

3. 输出参数

参数名称 类型 描述
Content String 作文识别文本
注意:此字段可能返回 null,表示取不到有效值。
CorrectData CorrectData 整体的批改结果
注意:此字段可能返回 null,表示取不到有效值。
Status String 任务状态,“Progressing”: 处理中(此时无结果返回)、“Finished”: 处理完成
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询异步任务结果-正常

正常返回(内容仅为参考,非实际批改结果)

输入示例

https://ecc.tencentcloudapi.com/?Action=DescribeTask
&TaskId=xxx
&<公共请求参数>

输出示例

{
  "Response": {
    "Status": "Finished",
    "Content": "this is compostion content",
    "CorrectData": {
      "Score": 72.39,
      "ScoreCat": {
        "Words": {
          "Name": "词汇",
          "Score": 76.08,
          "Percentage": 42
        },
        "Sentences": {
          "Name": "句子",
          "Score": 61.16,
          "Percentage": 28
        },
        "Structure": {
          "Name": "篇章结构",
          "Score": 80.37,
          "Percentage": 23
        },
        "Content": {
          "Name": "内容",
          "Score": 69,
          "Percentage": 7
        },
        "Score": 0,
        "Percentage": 0
      },
      "Comment": "作者词汇基础扎实;可适当增加复合句和从句的使用;文中衔接词丰富。请多加练习,更上一层楼。",
      "SentenceComments": [
        {
          "Sentence": {
            "Sentence": "Teenagers likeating fast 1888861 food.",
            "ParaID": 1,
            "SentenceID": 7
          },
          "Suggestions": [
            {
              "Type": "Error",
              "ErrorType": "拼写错误",
              "Origin": "likeating",
              "Replace": "elevating",
              "Message": "likeating 可能是拼写错误,请注意拼写检查,这里应将 likeating 替换为 elevating",
              "ErrorPosition": [
                8,
                8
              ],
              "ErrorCoordinate": [
                {
                  "Coordinate": [
                    424,
                    360,
                    459,
                    359,
                    459,
                    386,
                    424,
                    387
                  ]
                }
              ]
            },
            {
              "Type": "Error",
              "ErrorType": "易混淆词汇建议",
              "Origin": "1888861",
              "Replace": "1886861",
              "Message": "注意1888861 与 1886861 的区别,推荐将 1888861 替换为 1886861",
              "ErrorPosition": [
                8,
                8
              ],
              "ErrorCoordinate": [
                {
                  "Coordinate": [
                    424,
                    360,
                    459,
                    359,
                    459,
                    386,
                    424,
                    387
                  ]
                }
              ]
            }
          ]
        }
      ]
    },
    "RequestId": "ae5d82c1-47a1-43c0-b8a2-4d3c35a21488"
  }
}

示例2 查询异步任务结果-处理中

任务处理中(内容仅为参考,非实际返回结果)

输入示例

https://ecc.tencentcloudapi.com/?Action=DescribeTask
&TaskId=xxx
&<公共请求参数>

输出示例

{
  "Response": {
    "Status": "Progressing",
    "Content": null,
    "CorrectData": null,
    "RequestId": "ae5d82c1-47a1-43c0-b8a2-4d3c35a21488"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.CorrectError 批改错误。
InternalError.OcrError 识别错误。
InternalError.OcrServerInternError 服务器内部错误,初始化失败。
InternalError.OtherError 其它错误。
InternalError.OverLoadError 服务器过载,请联系相关客服。
InternalError.RecognizeError 图片识别错误。
InternalError.ServerConnectDownloadError 无法连接图像下载服务器。
InternalError.SplitError 图片切割错误。
InvalidParameter.EmptyParameterError 参数为空。
InvalidParameter.InputError 传入的参数有误。
InvalidParameter.TaskNotFound 任务不存在。
InvalidParameterValue.AppidInvalidError Appid无效。
InvalidParameterValue.DecodeImageError 图片解码失败,请核实输入信息。
InvalidParameterValue.DownloadImageFailError url图片下载失败。
InvalidParameterValue.ImageDownloadFailError 图片下载失败。
InvalidParameterValue.ImageSizeExceedError 图片超出下载限制。
InvalidParameterValue.UrlFromatIvadlidError 图像请求URL的格式错误。
LimitExceeded.FreqLimitForbiddenAccessError 频率限制。
ResourceNotFound.CannotFindUser 无法找到用户,请确认已在控制台开通服务并使用了正确的 ECCAPPID。
ResourceNotFound.ServerNameNotExistInLicenseError 无效的服务名称。
ResourceUnavailable.AuthorizeError 服务未开通或已欠费。
UnauthorizedOperation.LicenseInvalidForbiddenAccessError license无效。
UnauthorizedOperation.ServerNameUnauthorizedInError license中未授权该服务。