ExecuteTextbookAssistantDialogue - 与AI老师进行对话

更新时间:
复制 MD 格式

进行AI对话。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

aicontent:ExecuteTextbookAssistantDialogue

create

*全部资源

*

请求语法

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

请求参数

名称

类型

必填

描述

示例值

body

object

请求 body 参数

scenario

string

选择场景。SYNC:同步练习,EXPAND:拓展练习

SYNC

chatId

string

本轮对话的编号

6788e0b475a4631ffc626722

userMessage

string

用户回复消息内容

Hello

authToken

string

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

6788e0b475a4631ffc626722

返回参数

名称

类型

描述

示例值

object

Schema of Response

requestId

string

Id of the request

DBFA232A-1176-50E6-95AE-50F7A62A28AD

success

string

是否成功

true

errCode

string

错误码

null

errMessage

string

错误信息

null

httpStatusCode

string

HTTP 状态码

200

data

object

返回数据对象

chatId

string

本轮对话的编号

6788e0b475a4631ffc626722

assistant

string

AI 老师生成消息的编号

6788f4935bdfc807f077a984

user

string

用户回复消息的编号

6788f4905bdfc807f077a982

result

object

获取的数据内容

englishResult

string

AI 老师的英文回复

Let's look at the text again. Mike says, \"I'm Mike Black.\" Can you try saying it like Mike?

chineseResult

string

AI 老师的中文回复

让我们再看一遍课文。迈克说: “我是迈克·布莱克。”你能试着像迈克那样说吗?

isTaskCompleted

boolean

是否完成任务

true

isFinish

boolean

是否完成对话

true

示例

正常返回示例

JSON格式

{
  "requestId": "DBFA232A-1176-50E6-95AE-50F7A62A28AD",
  "success": "true",
  "errCode": "null",
  "errMessage": "null",
  "httpStatusCode": "200",
  "data": {
    "chatId": "6788e0b475a4631ffc626722",
    "assistant": "6788f4935bdfc807f077a984",
    "user": "6788f4905bdfc807f077a982",
    "result": {
      "englishResult": "Let's look at the text again. Mike says, \\\"I'm Mike Black.\\\" Can you try saying it like Mike?",
      "chineseResult": "让我们再看一遍课文。迈克说: “我是迈克·布莱克。”你能试着像迈克那样说吗?",
      "isTaskCompleted": true,
      "isFinish": true
    }
  }
}

错误码

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

变更历史

更多信息,参考变更详情