ExecuteTextbookAssistantStartConversation - 开启与AI老师的对话

更新时间:

发起与AI老师的对话,由Ai老师率先发起第一句对话内容。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
aicontent:ExecuteTextbookAssistantStartConversationcreate
*全部资源
*

请求语法

POST /api/v1/textbookAssistant/dialogue/StartConversation HTTP/1.1

请求参数

名称类型必填描述示例值
bodyobject

请求 body 参数。

authTokenstring

接口调用授权码,可以通过"英语教材式 AI 老师功能使用授权码"接口获取。

tc_e6dc70c890866f4028ca685b6fa29874
scenariostring

选择场景。

SYNC:同步练习

EXPAND:拓展练习

SYNC
articleIdstring

文章 ID,获取方式如下:

scenario 入参选择 SYNC 时:

  1. 接口名称:获取英语教材的文章列表    来源字段:响应参数顶层 articleId
  2. 接口名称:获取文章详情    来源字段:响应参数顶层 articleId

scenario 入参选择 EXPAND 时:

  1. 接口名称:获取文章详情    来源字段:sceneList 数组内元素的 sceneid 字段
0c05700d4d9411efbe6e0c42a106bb02

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

Id of the request

6F73C114-A76E-51AD-99E3-BC7B941B69E0
successboolean

是否成功

true
errCodestring

错误码

B_USER_NOT_FOUND_EXCEPTION
errMessagestring

错误信息

用户不存在
httpStatusCodeinteger

HTTP 状态码

200
dataobject

返回数据对象

chatIdstring

本轮对话的 ID

6788e0b475a4631ffc626722
assistantstring

AI 老师生成消息的编号

6788e0b4b54c5268c1b78638
userstring

用户生成消息的编号

6788e0b45bdfc807f077a5a1
resultobject

结果消息数据

englishResultstring

AI 老师的英文回复

Good evening! From the book, how does Mike Black introduce himself?
chineseResultstring

AI 老师的中文回复

根据文章,迈克·布莱克是如何介绍自己的?

示例

正常返回示例

JSON格式

{
  "requestId": "6F73C114-A76E-51AD-99E3-BC7B941B69E0",
  "success": true,
  "errCode": "B_USER_NOT_FOUND_EXCEPTION\n",
  "errMessage": "用户不存在",
  "httpStatusCode": 200,
  "data": {
    "chatId": "6788e0b475a4631ffc626722",
    "assistant": "6788e0b4b54c5268c1b78638",
    "user": "6788e0b45bdfc807f077a5a1",
    "result": {
      "englishResult": "Good evening! From the book, how does Mike Black introduce himself?",
      "chineseResult": "根据文章,迈克·布莱克是如何介绍自己的?"
    }
  }
}

错误码

访问错误中心查看更多错误码。