ListTextbookAssistantSceneDetails - 获取场景详情

更新时间:
复制 MD 格式

获取文章内容详情

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

aicontent:ListTextbookAssistantArticleDetails

list

*全部资源

*

请求语法

POST /api/v1/textbookAssistant/teachingResource/ListSceneDetails HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

body

object

请求 body 参数

authToken

string

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

tc_e6dc70c890866f4028ca685b6fa29874

sceneIdList

array

场景 ID 列表

string

场景 ID

38c41b7b509911efbe6e0c42a106bb02

返回参数

名称

类型

描述

示例值

object

Schema of Response

requestId

string

Id of the request

xxxx-xxxx-xxxx-xxxxxxxx

success

boolean

接口调用是否成功。

  • true:成功

  • false:失败

true

errCode

string

错误码

UNKNOWN_ERROR

errMessage

string

错误信息

未知错误

httpStatusCode

integer

HTTP 状态码。

200

data

array<object>

返回数据对象

array<object>

数据对象

sceneId

string

场景 Id

38c41b7b509911efbe6e0c42a106bb02

target

string

练习目标

""

scene

string

场景描述

At school, Carl sees a photo and asks you about your family.

sceneImageList

array

当前场景相关图片

string

图片地址

https://xxxxxxx/file_service/dialog/xxxxxx.png

sceneTaskList

array<object>

场景任务列表

object

任务信息

sceneTask

string

场景任务描述

Say that this is your dad's brother.

sceneTaskTranslate

string

场景任务描述释义

说这是你爸爸的兄弟。

theme

object

主题信息

themeName

string

主题名称

家庭生活

themeTranslate

string

主题名称翻译内容

Family and family life

themeImageList

array

当前主题相关图片

string

图片地址

https://xxxxxxx/file_service/dialog/xxxxxx.png

topic

object

话题信息

topicName

string

话题名称

介绍家人

topicTranslate

string

话题内容翻译

Introducing family members

topicImageList

array

当前话题相关图片

string

图片地址

https://xxxxxxx/file_service/dialog/xxxxxx.png

sentenceList

array<object>

句子信息列表

object

句子详情。

sentenceId

string

句子编号 ID

a774c6d09c4511eebe6e0c42a106bb02

sentenceText

string

句子文本信息

Is this your sister?

sentenceAnalysis

string

句子分析,释义

Is + this + your + 家庭成员?

wordList

array<object>

单词信息列表

object

单词详情。

wordId

string

单词 id

a94c3337ed8c11eebe6e0c42a106bb02

wordText

string

单词文本

family

wordAnalysis

string

单词释义

家;家庭

roleList

array<object>

角色列表

object

roleName

string

角色名称

Carl

roleNameTranslate

string

角色名称翻译结果

Carl

introduction

string

角色介绍

Carl, a curious boy

introductionTranslate

string

角色介绍翻译结果

Carl,一个好奇的男孩

promoting

string

角色引导文本

Hi Noah, who is that in the photo?

promotingTranslate

string

角色引导文本翻译结果

嗨 Noah,照片里的人是谁?

roleType

string

角色类型(0 为提问者 AI,1 为回答者)

0

sceneTranslate

string

示例

正常返回示例

JSON格式

{
  "requestId": "xxxx-xxxx-xxxx-xxxxxxxx",
  "success": true,
  "errCode": "UNKNOWN_ERROR",
  "errMessage": "未知错误",
  "httpStatusCode": 200,
  "data": [
    {
      "sceneId": "38c41b7b509911efbe6e0c42a106bb02",
      "target": "\"\"",
      "scene": "At school, Carl sees a photo and asks you about your family.",
      "sceneImageList": [
        "https://xxxxxxx/file_service/dialog/xxxxxx.png"
      ],
      "sceneTaskList": [
        {
          "sceneTask": "Say that this is your dad's brother.",
          "sceneTaskTranslate": "说这是你爸爸的兄弟。"
        }
      ],
      "theme": {
        "themeName": "家庭生活",
        "themeTranslate": "Family and family life",
        "themeImageList": [
          "https://xxxxxxx/file_service/dialog/xxxxxx.png"
        ]
      },
      "topic": {
        "topicName": "介绍家人",
        "topicTranslate": "Introducing family members",
        "topicImageList": [
          "https://xxxxxxx/file_service/dialog/xxxxxx.png"
        ]
      },
      "sentenceList": [
        {
          "sentenceId": "a774c6d09c4511eebe6e0c42a106bb02",
          "sentenceText": "Is this your sister?",
          "sentenceAnalysis": "Is + this + your + 家庭成员?"
        }
      ],
      "wordList": [
        {
          "wordId": "a94c3337ed8c11eebe6e0c42a106bb02",
          "wordText": "family",
          "wordAnalysis": "家;家庭"
        }
      ],
      "roleList": [
        {
          "roleName": "Carl",
          "roleNameTranslate": "Carl",
          "introduction": "Carl, a curious boy",
          "introductionTranslate": "Carl,一个好奇的男孩",
          "promoting": "Hi Noah, who is that in the photo?",
          "promotingTranslate": "嗨 Noah,照片里的人是谁?",
          "roleType": "0"
        }
      ],
      "sceneTranslate": ""
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情