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

create

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
scenario	string	Yes	The practice scenario. Valid values: SYNC for synchronous practice and EXPAND for extended practice.	SYNC
chatId	string	Yes	The conversation ID.	6788e0b475a4631ffc626722
assistant	string	Yes	The ID of the assistant's message.	6788e0b4b54c5268c1b78638
authToken	string	Yes	The authorization token. Obtain this token by calling the authorization operation for the AI Textbook Assistant feature.	tc_e6dc70c890866f4028ca685b6fa29874

Response elements

Element	Type	Description	Example
	object	The response object.
requestId	string	The request ID.	9EB79C1E-36C2-5777-BED6-C23A98DF0637
success	boolean	Indicates whether the request was successful.	true
errCode	string	The error code.	0
errMessage	string	The error message.	""
httpStatusCode	integer	The HTTP status code.	200
data	object	The data returned by the API.
result	object	The result object.
result	string	The translated text.	根据文章，迈克·布莱克是如何介绍自己的？

Examples

Success response

JSON format

{
  "requestId": "9EB79C1E-36C2-5777-BED6-C23A98DF0637",
  "success": true,
  "errCode": "0",
  "errMessage": "\"\"",
  "httpStatusCode": 200,
  "data": {
    "result": {
      "result": "根据文章，迈克·布莱克是如何介绍自己的？"
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.