AI口语老师简介

概念解释

AI口语老师服务，可以提供用户的自由对话和主题对话的服务。

说明

Hi，您好，欢迎使用有道智云AI口语老师接口服务。

本文档主要针对需要集成HTTP API的技术开发工程师，详细描述AI口语老师能力相关的技术内容。

如果您有与我们商务合作的需求，可以通过以下方式联系我们：

商务邮箱： AIcloud_Business@corp.youdao.com

如果您对文档内容有任何疑问，可以通过以下几种方式联系我们：

客服QQ：1906538062

AIGC产品技术交流群 ：837394306

联系邮箱： zhiyun@corp.youdao.com

温馨提示：

• 本文档主要针对开发人员，接入测试前需要获取应用ID和应用密钥，并创建应用；如果您还没有，请按照 新手指南 获取。
• 平台向每个账户赠送50元的体验金，供用户集成前测试所用。

协议须知

调用方在集成AI口语老师API时，请遵循以下规则。

接口调用参数

AI口语老师线上调用地址：

https://openapi.youdao.com/ai_dialog

注意： 签名生成方法如下： signType=v4； sign=sha256(应用ID+salt+curtime+应用密钥)；

AI口语老师-V2接口定义

进行对话接口

• 接口uri：/chat

• 接口说明： 用户和系统之间的对话接口，根据参数isTopic支持两种对话：主题对话，自由对话。

• 接口参数：

{
    "appKey":"",                         // 必填 appkey  权限认证
    "salt":"",                           // 必填 随机串   权限认证
    "curtime":"",                        // 必填 时间戳   权限认证
    "signType":"v4",                     // 必填 仅支持v4 权限认证
    "sign":"",                           // 必填 sha256(appKey + salt + curtime +appSecret) 权限认证
    "isTopic": true|false                // 必填 true为主题对话, false为自由对话
    "taskId": "",                        // 非必填 当isTopic=true时，首次开启对话时 / 开启新对话时 不需要传，继续历史对话必需填第一次调用时返回的taskId；当isTopic=false时，不需要传此参数
    "userLevel": "0",                    // 非必填 用户水平等级(字符串)：0表示1-3年级小学生；1表示4-6年级小学生；2表示初中生；3表示高中生/大学生(四六级)，默认2
    "extJson": "",                       // 非必填 无需关注具体值，注意: 当isTopic=true时且继续历史对话 (不是新对话) 时，需要把首次调用(开启对话时）返回的该字段传进来
    "history": [                         // 必填，对话历史，注: 1.当isTopic=true，第一次调用根据首句生成topic，此时应该只有[{"speaker": "User", "content": "xxx"}] 2.当isTopic=false，第一次调用传[{"speaker:User", "content": "xxx"}]
       {
          "speaker":"System",            // 讲话人：系统
          "content":"Hi there! My name is Sarah, and I'm from New York. What's your name and where are you from?"  // 讲话内容, 语种限制英文
       },
       {
           "speaker":"User",             // 讲话人：用户
           "content":"Hello, I'm Echo, I come from China. Nice to meet you. Do you have any hobbies?" // 讲话内容, 语种限制英文，单词数限制80
       }
    ]
  }

• 响应结果

{
  "code": "0",
  "msg": "SUCCESS",
  "data": {
    "taskId": "",                       // 当isTopic=true时，返回任务id。 当isTopic=false时，不返回该字段
    "extJson": "",                      // 无需关注具体值，注意: 当isTopic=true时且继续历史对话时，需要把该字段当作参数传进
    "systemReply": "",                  // 系统的回答  
    "recommandedReplies": [             // 推荐用户回答列表  
       "",                              
       "",
       ""
    ]
  }
}

错误代码列表