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

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

create

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
scenario	string	Yes	Specifies the scenario. Valid values are `SYNC` for synchronous practice and `EXPAND` for expansion practice.	SYNC
chatId	string	Yes	The conversation ID for the current turn.	6788e0b475a4631ffc626722
user	string	Yes	The ID of the user's message.	6788e0b45bdfc807f077a5a1
authToken	string	Yes	The authorization token for the API call. You can obtain this token by calling the authorization API for the "English Textbook AI Teacher" feature.	tc_e6dc70c890866f4028ca685b6fa29874

Response elements

Element	Type	Description	Example
	object	The response object.
requestId	string	The unique request ID.	6F73C114-A76E-51AD-99E3-BC7B941B69E0
success	boolean	A value of `true` indicates that the request succeeded.	true
errCode	string	The error code returned when the request fails.	0
errMessage	integer	The error message returned when the request fails.	null
httpStatusCode	string	The HTTP status code.	200
data	object	The returned data object.
result	object	The result data.
result	string	The refined sentence.	Good evening! From the book, how does Mike Black introduce himself?

Examples

Success response

JSON format

{
  "requestId": "6F73C114-A76E-51AD-99E3-BC7B941B69E0",
  "success": true,
  "errCode": "0",
  "errMessage": 0,
  "httpStatusCode": "200",
  "data": {
    "result": {
      "result": "Good evening! From the book, how does Mike Black introduce himself?"
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.