文本处理

最近更新时间:2019-08-21 18:59:13

1. 接口描述

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

接收调用侧的文本输入,返回应答文本。已废弃,推荐使用最新版TextProcess接口。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:TextProcess
Version String 公共参数,本接口取值:2019-03-11
Region String 公共参数,本接口不需要传递此参数。
BotId String 机器人标识,用于定义抽象机器人。
TerminalId String 终端标识,每个终端(或线程)对应一个,区分并发多用户。
InputText String 请求的文本。
BotEnv String 机器人版本,取值"dev"或"release",{调试版本:dev;线上版本:release}。
SessionAttributes String 透传字段,透传给用户自定义的WebService服务。

3. 输出参数

参数名称 类型 描述
DialogStatus String 当前会话状态{会话开始: START; 会话中: COUTINUE; 会话结束: COMPLETE}。
注意:此字段可能返回 null,表示取不到有效值。
BotName String 匹配到的机器人名称。
注意:此字段可能返回 null,表示取不到有效值。
IntentName String 匹配到的意图名称。
注意:此字段可能返回 null,表示取不到有效值。
SlotInfoList Array of SlotInfo 槽位信息。
注意:此字段可能返回 null,表示取不到有效值。
InputText String 原始的用户说法。
注意:此字段可能返回 null,表示取不到有效值。
SessionAttributes String 透传字段,由用户自定义的WebService服务返回。
注意:此字段可能返回 null,表示取不到有效值。
ResponseText String 机器人对话的应答文本。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 机器人对话服务接口

输入示例

https://tbp.tencentcloudapi.com/?Action=TextProcess
&BotId=972445
&InputText=北京
&TerminalId=123
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "20190117150912",
    "DialogStatus": "COMPLETE",
    "BotName": "订票机器人",
    "IntentName": "Intent_book_tickets",
    "ResponseText": "好的,我这就去办。",
    "SlotInfoList": [
      {
        "SlotName": "CityName",
        "SlotValue": "北京"
      }
    ],
    "SessionAttributes": "",
    "InputText": "北京"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.ErrorMms 查询数据库失败,没有对应数据。
InternalError.ErrorNlu nlu处理失败。
InternalError.ErrorRpc rpc调用失败。
InternalError.ErrorWebHook webHook处理失败。
InternalError.NoAppPrivilege 未开通相关应用访问权限。
InvalidParameter 参数错误。