句子纠错

最近更新时间:2024-03-12 01:42:27

我的收藏

1. 接口描述

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

智能识别并纠正句子中的语法、拼写、用词等错误,确保文本的准确性和可读性。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SentenceCorrection。
Version String 公共参数,本接口取值:2019-04-08。
Region String 公共参数,本接口不需要传递此参数。
TextList.N Array of String 待纠错的句子列表。可以以数组方式在一次请求中填写多个待纠错的句子。文本统一使用utf-8格式编码,每个中文句子的长度不超过150字符,每个英文句子的长度不超过100个单词,且数组长度需小于30,即句子总数需少于30句。

3. 输出参数

参数名称 类型 描述
CorrectionList Array of CorrectionItem 纠错结果列表。
(注意仅展示错误句子的纠错结果,若句子无错则不展示,若全部待纠错句子都被认为无错,则可能返回数组为空)
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 句子纠错调用示例

对包含错别字的中文句子以及包含语法错误的英文句子进行纠错。

输入示例

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

{
    "TextList": [
        "这位外国网友说:这是地球最安全的锅加,在这里,我从未感到过害啪!",
        "We always rent a little cottages from a sheep farmer and now we know his family."
    ]
}

输出示例

{
    "Response": {
        "CorrectionList": [
            {
                "BeginOffset": 16,
                "Confidence": 0,
                "CorrectWord": [
                    "国家"
                ],
                "CorrectionType": 0,
                "DescriptionEn": null,
                "DescriptionZh": null,
                "Len": 2,
                "Order": 1,
                "Word": "锅加"
            },
            {
                "BeginOffset": 30,
                "Confidence": 0,
                "CorrectWord": [
                    "怕"
                ],
                "CorrectionType": 0,
                "DescriptionEn": null,
                "DescriptionZh": null,
                "Len": 1,
                "Order": 1,
                "Word": "啪"
            },
            {
                "BeginOffset": 24,
                "Confidence": 0,
                "CorrectWord": [
                    "cottage"
                ],
                "CorrectionType": 0,
                "DescriptionEn": "It appears that the noun \"cottage\" doesn't agree with \"a little\".",
                "DescriptionZh": "在当前语境下,“cottages”作为名词和量词“a little”没有保持单复数一致,建议使用“cottage”以保持名词一致性。",
                "Len": 8,
                "Order": 2,
                "Word": "cottages"
            }
        ],
        "RequestId": "b183f9d5-b35a-4880-8a36-86883b9eea11"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.BalanceInsufficient 余额不足,开通失败,请充值后再开通。
FailedOperation.InnerError 服务内部错误,请重试。
FailedOperation.NoResults 暂无结果,请更换文本重试。
FailedOperation.NotFoundData 未查询到结果。
FailedOperation.RequestTimeout 后端服务超时。
FailedOperation.ResourceBusy 服务器繁忙,请稍后再试。
FailedOperation.RpcFail RPC请求失败,一般为算法微服务故障。
FailedOperation.UnKnowError 内部错误。
FailedOperation.Unknown 未知错误。
InternalError 内部错误。
InternalError.ServiceCallError 内部服务调用错误。
InternalError.ServiceError 内部服务调用失败。
InvalidParameter.TextTooLongCode 文本长度超过限制。
InvalidParameterValue.InvalidParameter 参数不合法。
InvalidParameterValue.SensitiveText Text输入含有敏感信息。
InvalidParameterValue.TextNumTooMuch 输入文本超出数量限制
InvalidParameterValue.TextTooLong 输入文本超出长度限制
LimitExceeded.ResourceReachedLimit 资源用量达到上限。
RequestLimitExceeded.UinLimitExceeded 请求的次数超过了频率限制。
ResourceNotFound 资源不存在。
ResourceUnavailable.Freeze 账号已被冻结。
ResourceUnavailable.InArrears 账号已欠费。
ResourceUnavailable.IsOpening 服务正在开通中,请稍等。
ResourceUnavailable.NotExist 计费状态未知,请确认是否已在控制台开通服务。
ResourceUnavailable.Recover 资源已被回收。
ResourceUnavailable.StopUsing 账号已停服。
UnsupportedOperation.PkgExhausted 资源包余量已用尽。