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

Starts a conversation with the AI teacher. The teacher then sends the initial message.

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

create

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
authToken	string	Yes	The authorization token for the API call. Obtain this token by calling the operation that provides the authorization token for the textbook-style AI teacher feature.	tc_e6dc70c890866f4028ca685b6fa29874
scenario	string	Yes	The practice scenario. Valid values: `SYNC`: synchronous practice `EXPAND`: expansion practice	SYNC
articleId	string	Yes	How you obtain this ID depends on the value of `scenario`. When the `scenario` input parameter is `SYNC`: From the `Get Article List` response, use the top-level `articleId` field. From the `Get Article Details` response, use the top-level `articleId` field. When the `scenario` input parameter is `EXPAND`: From the `Get Article Details` response, use the `sceneid` field from an element in the `sceneList` array.	0c05700d4d9411efbe6e0c42a106bb02

Response elements

Element	Type	Description	Example
	object	The data returned when the request is successful.
requestId	string	The request ID.	6F73C114-A76E-51AD-99E3-BC7B941B69E0
success	boolean	Indicates whether the request was successful.	true
errCode	string	The error code.	B_USER_NOT_FOUND_EXCEPTION
errMessage	string	The error message.	用户不存在
httpStatusCode	integer	The HTTP status code.	200
data	object	The data object.
chatId	string	The conversation ID.	6788e0b475a4631ffc626722
assistant	string	The ID of the message generated by the AI teacher.	6788e0b4b54c5268c1b78638
user	string	The ID of the message generated by the user.	6788e0b45bdfc807f077a5a1
result	object	An object that contains the response from the AI teacher.
englishResult	string	The AI teacher's response in English.	Good evening! From the book, how does Mike Black introduce himself?
chineseResult	string	The AI teacher's response in Chinese.	根据文章，迈克·布莱克是如何介绍自己的？

Examples

Success response

JSON format

{
  "requestId": "6F73C114-A76E-51AD-99E3-BC7B941B69E0",
  "success": true,
  "errCode": "B_USER_NOT_FOUND_EXCEPTION\n",
  "errMessage": "用户不存在",
  "httpStatusCode": 200,
  "data": {
    "chatId": "6788e0b475a4631ffc626722",
    "assistant": "6788e0b4b54c5268c1b78638",
    "user": "6788e0b45bdfc807f077a5a1",
    "result": {
      "englishResult": "Good evening! From the book, how does Mike Black introduce himself?",
      "chineseResult": "根据文章，迈克·布莱克是如何介绍自己的？"
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.