ExecuteTextbookAssistantDialogue-Smart Science and Education Content Platform(SSECP)-阿里云帮助中心

Executes a dialogue turn with the Textbook Assistant.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

aicontent:ExecuteTextbookAssistantDialogue

create

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
scenario	string	Yes	The scenario. Valid values: SYNC for synchronous practice and EXPAND for extended practice.	SYNC
chatId	string	Yes	The chat ID for this turn.	6788e0b475a4631ffc626722
userMessage	string	Yes	The user's message content.	Hello
authToken	string	Yes	The authorization token required to call the API. To get this token, use the Textbook Assistant authorization API.	6788e0b475a4631ffc626722

Response elements

Element	Type	Description	Example
	object	The response.
requestId	string	The request ID.	DBFA232A-1176-50E6-95AE-50F7A62A28AD
success	string	Indicates whether the request was successful.	true
errCode	string	The error code.	null
errMessage	string	The error message.	null
httpStatusCode	string	The HTTP status code.	200
data	object	The returned data.
chatId	string	The chat ID for this turn.	6788e0b475a4631ffc626722
assistant	string	The ID of the Textbook Assistant's message.	6788f4935bdfc807f077a984
user	string	The ID of the user's reply.	6788f4905bdfc807f077a982
result	object	The returned data.
englishResult	string	The Textbook Assistant's reply in English.	Let's look at the text again. Mike says, \"I'm Mike Black.\" Can you try saying it like Mike?
chineseResult	string	The Textbook Assistant's reply in Chinese.	让我们再看一遍课文。迈克说: “我是迈克·布莱克。”你能试着像迈克那样说吗？
isTaskCompleted	boolean	Indicates whether the task is completed.	true
isFinish	boolean	Indicates whether the dialogue is finished.	true

Examples

Success response

JSON format

{
  "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
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.