1. 接口描述
接口请求域名： ecc.tencentcloudapi.com 。
纯文本英语作文批改
默认接口请求频率限制：1000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ECC。 |
| Version | 是 | String | 公共参数，本接口取值：2018-12-13。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Content | 是 | String | 作文文本，必填 示例值：空 |
| Title | 否 | String | 作文题目，可选参数 示例值：空 |
| Grade | 否 | String | 年级标准， 默认以cet4为标准，取值与意义如下：elementary 小学，grade7 grade8 grade9分别对应初一，初二，初三。 grade10 grade11 grade12 分别对应高一，高二，高三，以及cet4和cet6 分别表示 英语4级和6级。 示例值：空 |
| Requirement | 否 | String | 作文提纲，可选参数，作文的写作要求。 示例值：空 |
| ModelTitle | 否 | String | 范文标题，可选参数，本接口可以依据提供的范文对作文进行评分。 示例值：空 |
| ModelContent | 否 | String | 范文内容，可选参数，同上，范文的正文部分。 示例值：空 |
| EccAppid | 否 | String | 业务应用ID，与账号应用APPID无关，是用来方便客户管理服务的参数（暂时无需传入）。 示例值：空 |
| IsAsync | 否 | Integer | 异步模式标识，0：同步模式，1：异步模式，默认为同步模式 示例值：空 |
| SessionId | 否 | String | 图像识别唯一标识，一次识别一个 SessionId。当传入此前识别接口使用过的 SessionId，则本次批改按图像批改价格收费；如使用了识别接口且本次没有传入 SessionId，则需要加取文本批改的费用；如果直接使用文本批改接口，则只收取文本批改的费用 示例值：空 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | CorrectData | 整体的批改结果 注意：此字段可能返回 null，表示取不到有效值。 示例值：空 |
| TaskId | String | 任务 id，用于查询接口 注意：此字段可能返回 null，表示取不到有效值。 示例值：空 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 纯文本英语作文批改-同步
IsAsync=0 时为同步模式，返回批改结果（内容仅为参考，非实际批改结果）
输入示例
POST / HTTP/1.1
Host: ecc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ECC
<公共请求参数>
{
"Content": "abc",
"Title": "abc",
"Grade": "abc",
"Requirement": "abc",
"ModelTitle": "abc",
"ModelContent": "abc",
"EccAppid": "abc",
"IsAsync": 0,
"SessionId": "abc"
}输出示例
{
"Response": {
"Data": {
"Score": 0,
"ScoreCat": {
"Words": {
"Name": "abc",
"Score": 0,
"Percentage": 0
},
"Sentences": {
"Name": "abc",
"Score": 0,
"Percentage": 0
},
"Structure": {
"Name": "abc",
"Score": 0,
"Percentage": 0
},
"Score": 0,
"Percentage": 0
},
"Comment": "abc",
"SentenceComments": [
{
"Suggestions": [
{
"Type": "abc",
"ErrorType": "abc",
"Origin": "abc",
"Replace": "abc",
"Message": "abc",
"ErrorPosition": [
0
],
"ErrorCoordinates": [
{
"Coordinate": [
0
]
}
]
}
],
"Sentence": {
"Sentence": "abc",
"ParaID": 0,
"SentenceID": 0
}
}
]
},
"TaskId": "abc",
"RequestId": "abc"
}
}示例2 纯文本英语作文批改-异步
IsAsync=1 时为异步模式，返回 TaskId（内容仅为参考，非实际返回结果）
输入示例
POST / HTTP/1.1
Host: ecc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ECC
<公共请求参数>
{
"Content": "abc",
"Title": "abc",
"Grade": "abc",
"Requirement": "abc",
"ModelTitle": "abc",
"ModelContent": "abc",
"EccAppid": "abc",
"IsAsync": 0,
"SessionId": "abc"
}输出示例
{
"Response": {
"Data": null,
"TaskId": "10000004",
"RequestId": "ae5d82c1-47a1-43c0-b8a2-4d3c35a21488"
}
}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.CorrectError | 批改错误。 |
| InternalError.DatabaseServerInternalError | 服务内部错误。 |
| InvalidParameter.InputError | 传入的参数有误。 |
| InvalidParameterValue.SessionError | SessionId无效。 |
| ResourceNotFound.CannotFindUser | 无法找到用户，请确认已在控制台开通服务并使用了正确的 ECCAPPID。 |
