ExecuteTextbookAssistantSseDialogue - AI老师进行对话-流式输出

更新时间:

进行对话-流式输出

调试

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

授权信息

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

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

请求语法

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

请求参数

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

请求 body 参数

scenariostring

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

EXPAND
chatIdstring

本轮对话的编号

67e374acb54c526c95c4fbd4
userMessagestring

用户回复消息内容

hello
authTokenstring

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

tc_e6dc70c890866f4028ca685b6fa29874

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

Id of the request

xxxx-xxxx-xxxx-xxxxxxxx
chatIdstring

本轮对话的编号

67e374acb54c526c95c4fbd4
dataobject

返回数据对象

englishResultstring

AI 老师的英文回复

Thanks, Lily. Do you like meat, Lily?
isFinishboolean

是否完成对话

true
assistantstring

AI 老师生成消息的编号

67e4c9d95bdfc83cd742ae7c
userstring

用户回复消息的编号

67e4c9d6b54c526c95c53925
successboolean

调用是否成功:

  • true:成功
  • false:失败
true
errCodestring

错误码

BIZ_ERROR
errMessagestring

错误信息

执行对话流式输出服务错误,请重试:资源信息不存在

示例

正常返回示例

JSON格式

{
  "requestId": "xxxx-xxxx-xxxx-xxxxxxxx",
  "chatId": "67e374acb54c526c95c4fbd4",
  "data": {
    "englishResult": "Thanks, Lily. Do you like meat, Lily?",
    "isFinish": true
  },
  "assistant": "67e4c9d95bdfc83cd742ae7c",
  "user": "67e4c9d6b54c526c95c53925",
  "success": true,
  "errCode": "BIZ_ERROR",
  "errMessage": "执行对话流式输出服务错误,请重试:资源信息不存在"
}

错误码

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