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

Practice synchronous dialogue.

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:ExecuteAITeacherSyncDialogue

create

*All Resource

*

None

Request syntax

POST /api/v1/aiteacher/syncPractice/executeSyncTraining HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
records	array<object>	No	An array of dialogue record objects.
	object	No	A dialogue record object.
content	string	Yes	The message content.	Ask Mark if he has thought about what his dream job might be.
role	string	Yes	The role of the message author. Valid values: assistant : The assistant. user : The user.	AI：assistant；用户：user
isOnTopic	boolean	No	Indicates whether the response is on-topic.	扣题：true, 不扣题：false
isOffTopicControl	boolean	No	Indicates whether the user's response is off-topic, acting as a flow control mechanism. This value is based on how the user's previous response aligned with the dialogue task. If the user goes off-topic more than twice, the system sets this parameter to `true` to trigger a task switch.	跑题：true, 不跑题：false
order	integer	Yes	The sequence number of the message.	1
dialogueTasks	array<object>	Yes	An array of dialogue task objects.
	object	Yes	A dialogue task object.
assistant	string	Yes	The assistant's dialogue content.	Why might some people think dog walking is a great job?
assistantTranslate	string	No	The translation of the assistant's dialogue content.	为什么有些人认为遛狗是份好差事?
user	string	Yes	The user's dialogue content.	They think it's great because they won't be stuck in an office.
order	integer	Yes	The sequence number of the task.	1
languageCode	string	No	The language and dialect of the dialogue. Valid values: en-us : American English en-gb : British English	en-gb
userId	string	Yes	A unique identifier for the user.	886eba3702xxxxxxxxx4ba52a87a525

Response elements

Element	Type	Description	Example
	object	The API response object.
requestId	string	The request ID.	xxxx-xxxx-xxxx-xxxxxxxx
success	boolean	Indicates whether the call was successful.	true
errCode	string	The error code.	UNKNOWN_ERROR
errMessage	string	The error message.	未知错误
httpStatusCode	integer	The HTTP status code.	200
data	object	The data object.	[]
englishResult	string	The English response from the AI teacher.	Thanks, Lily. Do you like meat, Lily?
isFinish	boolean	Indicates whether the dialogue is finished.	true
isOnTopic	boolean	Indicates whether the user's response is on topic.	true
questionIndex	integer	The index of the current question.	2

Examples

Success response

JSON format

{
  "requestId": "xxxx-xxxx-xxxx-xxxxxxxx",
  "success": true,
  "errCode": "UNKNOWN_ERROR",
  "errMessage": "未知错误",
  "httpStatusCode": 200,
  "data": {
    "englishResult": "Thanks, Lily. Do you like meat, Lily?",
    "isFinish": true,
    "isOnTopic": true,
    "questionIndex": 2
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.