纠错API

目录

1. 接口描述

域名:wenzhi.api.qcloud.com
接口名: LexicalCheck
能够实现对短文本的自动纠错功能,长文本的自动纠错也即将推出。用户只需要提供业务数据和日志, 无需关注技术细节和更新流程, 就可以享受到业务自身定制的纠错服务, 甚至不提供业务数据,享受通用的纠错服务。目前已经接入的业务包括音乐、视频、应用宝、云搜等,评测效果均好于竞品。

2. 输入参数

参数名称 必选 类型 描述
text String 待纠错的文本(utf-8)

3. 输出参数

参数名称 类型 描述
code Int32 错误码, 0: 成功, 其他值: 失败
message String 错误信息,错误码详情参见错误码说明
text String 纠错后词
text_annotate String 标红的纠错后词
conf Double 纠错置信度


纠错API错误码详细信息如下:

错误码 含义说明
400 HTTP Method不正确
401 HTTP请求参数不符合要求
503 调用额度已超出限制
504 服务故障

4. 详细示例

示例业务详细信息如下表:

参数名称 参数描述 必选 参数值示例
腾讯云公共参数 Action 方法名 LexicalCheck
SecretId SecretId AKIDz8krbsJ5yKBZQpn74WFkmLPx3gnPhESA
Timestamp 当前时间戳 1408704141
Nonce 随机正整数 345122
业务参数 text 待纠错的文本(utf-8) 睡交吃饭


下面以上述业务为例,详细说明“纠错API”接口的使用方法。

4.1 接口鉴权

示例要调用服务的数据为:{"text":"睡交吃饭"}
则上述业务的参数列表如下:

{
        'Action' : 'LexicalCheck',
        'Nonce' : 345122,
        'Region' : 'sz',
        'SecretId' : 'AKIDz8krbsJ5yKBZQpn74WFkmLPx3gnPhESA',
        'Timestamp' : 1408704141,
        'text': '睡交吃饭'
    }

根据上述参数列表进行签名,得出的数字签名为:HgIYOPcx5lN6gz8JsCFBNAWp2oQ(示例),详细的数字签名的生成方法请参照:《腾讯云接口鉴权》。
注意
1)在生成签名的过程中,需要将加密字符串中包含的“_”改写成“.”,从而加密产生签名;
2)鉴权时,需要将参数列表按key进行排序:字典序,同时大写在前。

4.2 API调用

根据上一步(3.4.1)中得到的数字签名,以POST请求为例构造请求URL,将数字签名加入到参数Signature中。

https://wenzhi.api.qcloud.com/v2/index.php?
    Action=LexicalCheck
    &Nonce=345122
    &Region=sz
    &SecretId=AKIDz8krbsJ5yKBZQpn74WFkmLPx3gnPhESA
    &Timestamp=1408704141
    &Signature=HgIYOPcx5lN6gz8JsCFBNAWp2oQ
    &text=睡交吃饭

执行上述操作之后,会将数据{"text":"睡交吃饭"}发送给API接口,进行相应分析。
注意:在发送请求过程中,不能将参数字符串中包含的“_”改写成“.”。
上述指令返回的数据结构如下:

{
        "code": 0,
        "message": "",
        "conf": 1.3,
        "text": "睡觉吃饭",
        "text_annotate": "睡觉吃饭"
    }

以上信息是否解决您的问题?

Copyright © 1998 - 2017 Tencent. All Rights Reserved.

腾讯公司 版权所有

有问必答 返回顶部