ExecuteTextbookAssistantGrammarCheck - 获取用户回复内容的语法检测的结果

更新时间:
复制 MD 格式

语法检测

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

aicontent:ExecuteTextbookAssistantGrammarCheck

create

*全部资源

*

请求语法

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

请求参数

名称

类型

必填

描述

示例值

body

object

请求 body 参数

scenario

string

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

SYNC

chatId

string

本轮对话的编号

6788e0b475a4631ffc626722

user

string

用户回复消息编号

6788e0b45bdfc807f077a5a1

authToken

string

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

tc_e6dc70c890866f4028ca685b6fa29874

返回参数

名称

类型

描述

示例值

object

Schema of Response

requestId

string

Id of the request

0bc1e96d17091734639835114e12c8

success

boolean

是否请求成功

true

errCode

string

错误码

0

errMessage

string

错误信息

null

httpStatusCode

integer

HTTP 状态码

200

data

object

数据对象

result

object

结果数据

correction

string

纠错后的语句

I am you.

analysis

string

错误分析

主语 \"I\" 后应跟动词 \"am\" 而不是 \"are\"。

correctionStatus

string

语法检测结果 有错误: Has_Error 无错误: No_Error 无法解析语句: Invalid_Sentence

Has_Error

示例

正常返回示例

JSON格式

{
  "requestId": "0bc1e96d17091734639835114e12c8",
  "success": true,
  "errCode": "0",
  "errMessage": "null",
  "httpStatusCode": 200,
  "data": {
    "result": {
      "correction": "I am you.",
      "analysis": "主语 \\\"I\\\" 后应跟动词 \\\"am\\\" 而不是 \\\"are\\\"。",
      "correctionStatus": "Has_Error"
    }
  }
}

错误码

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

变更历史

更多信息,参考变更详情