AI口语老师简介

协议须知

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

接口调用参数

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

https://openapi.youdao.com/ai_dialog

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

AI口语老师-V2接口定义

流式对话接口

• 接口uri：/chatStream

• 接口说明：

接口参数：

{
    "appKey":"",                         // 必填 appkey  权限认证
    "salt":"",                           // 必填 随机串   权限认证
    "curtime":"",                        // 必填 时间戳   权限认证
    "signType":"v4",                     // 必填 仅支持v4 权限认证
    "sign":"",                           // 必填 sha256(appKey + salt + curtime +appSecret) 权限认证
    "userLevel": "0",                    // 非必填 用户水平等级(字符串)：0表示1-3年级小学生；1表示4-6年级小学生；2表示初中生；3表示高中生/大学生(四六级)，默认2
    "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
       }
    ]
  }

响应结果

流式正常结果的格式

注：1. data中type=1是系统回复，以若干个包流式输出，需要组织type=1的所有数据拼接成一个完整回复。 type=2时，是推荐回复，每次输出一个完整的推荐回复，总共会出现3个推荐回复。

流式异常结果的格式

注： 如果是鉴权类错误，可能没有第一部分(正常的message)，直接返回error包。

流式结果的示例

示例一：“正常返回”结果

每一个ServerSentEvent如下所示

ServerSentEvent [id = '1', event='message', retry=null, comment='null', data={"requestId":"a91af3e7-53b4-446e-8681-e881dac31c58","type":1,"content":"Hi"}]
ServerSentEvent [id = '2', event='message', retry=null, comment='null', data={"requestId":"a91af3e7-53b4-446e-8681-e881dac31c58","type":1,"content":","}]
ServerSentEvent [id = '3', event='message', retry=null, comment='null', data={"requestId":"a91af3e7-53b4-446e-8681-e881dac31c58","type":1,"content":" I"}]
ServerSentEvent [id = '4', event='message', retry=null, comment='null', data={"requestId":"a91af3e7-53b4-446e-8681-e881dac31c58","type":1,"content":"’m"}]
ServerSentEvent [id = '5', event='message', retry=null, comment='null', data={"requestId":"a91af3e7-53b4-446e-8681-e881dac31c58","type":1,"content":" fine"}]
ServerSentEvent [id = '6', event='message', retry=null, comment='null', data={"requestId":"a91af3e7-53b4-446e-8681-e881dac31c58","type":1,"content":","}]
ServerSentEvent [id = '7', event='message', retry=null, comment='null', data={"requestId":"a91af3e7-53b4-446e-8681-e881dac31c58","type":1,"content":" thank"}]
ServerSentEvent [id = '8', event='message', retry=null, comment='null', data={"requestId":"a91af3e7-53b4-446e-8681-e881dac31c58","type":1,"content":" you"}]
ServerSentEvent [id = '9', event='message', retry=null, comment='null', data={"requestId":"a91af3e7-53b4-446e-8681-e881dac31c58","type":1,"content":"."}]
ServerSentEvent [id = '10', event='message', retry=null, comment='null', data={"requestId":"a91af3e7-53b4-446e-8681-e881dac31c58","type":1,"content":" And"}]
ServerSentEvent [id = '11', event='message', retry=null, comment='null', data={"requestId":"a91af3e7-53b4-446e-8681-e881dac31c58","type":1,"content":" you"}]
ServerSentEvent [id = '12', event='message', retry=null, comment='null', data={"requestId":"a91af3e7-53b4-446e-8681-e881dac31c58","type":1,"content":"?"}]
ServerSentEvent [id = '13', event='message', retry=null, comment='null', data={"requestId":"a91af3e7-53b4-446e-8681-e881dac31c58","type":2,"content":" I’m good, how about you? "}]
ServerSentEvent [id = '14', event='message', retry=null, comment='null', data={"requestId":"a91af3e7-53b4-446e-8681-e881dac31c58","type":2,"content":" Pretty good, what about you? "}]
ServerSentEvent [id = '15', event='message', retry=null, comment='null', data={"requestId":"a91af3e7-53b4-446e-8681-e881dac31c58","type":2,"content":" Not bad, yourself? "}]
ServerSentEvent [id = '16', event='end', retry=null, comment='null', data={"requestId":"a91af3e7-53b4-446e-8681-e881dac31c58"}]

示例二：“异常返回”结果

ServerSentEvent [id = '1', event='error', retry=null, comment='null', data={"requestId":"945ecfa5-b385-4216-8dd8-c30ff05ed787","errorCode":"108","errorMsg":"auth failed"}]

错误代码列表