Calls AMB to rewrite text in a new tone.
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.
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
Actionelement 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
Resourceelement of the policy. - For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the
Resourceelement of the policy.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the
- 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 |
|---|---|---|---|---|
aimiaobi:RunWriteToneGeneration | create | *All Resource
| None | None |
Request syntax
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| WorkspaceId | string | Yes | Unique identifier of your Alibaba Cloud Model Studio workspace. To get this ID, see Workspace ID. | llm-xxx |
| ReferenceData | object | Yes | Data required for generation. | |
| Contents | array | Yes | List of main text blocks. | |
string | Yes | Main text block. | xxx | |
| TaskId | string | No | Unique identifier of the associated article. You do not need to specify TaskId. The system generates it automatically. If you use the same TaskId in later requests, those requests belong to the same conversation group. | 7AA2AE16-D873-5C5F-9708-15396C382EB1 |
| Prompt | string | Yes | Tone. Examples include lyrical, bold, subtle, excited, friendly, and inspirational. | Inspirational |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | Response schema. | ||
| Header | object | Response headers. | |
| ErrorCode | string | Error code. | AccessForbid |
| ErrorMessage | string | Error message returned when the call fails. | xxx |
| Event | string | Server-sent event (SSE). | task-failed |
| SessionId | string | Session ID. | F1953EE6-157C-40DC-BBF1-87C98AC27C51 |
| TaskId | string | Task ID. | F1953EE6-157C-40DC-BBF1-87C98AC27C51 |
| TraceId | string | End-to-end trace ID. | F1953EE6-157C-40DC-BBF1-87C98AC27C51 |
| Payload | object | Response body. | |
| Output | object | Output data. | |
| Text | string | Generated text. | xxx |
| Usage | object | Token usage. | |
| InputTokens | integer | Number of input tokens used. | 1 |
| OutputTokens | integer | Number of output tokens used. | 1 |
| TotalTokens | integer | Total number of tokens used in this call. | 2 |
| RequestId | string | Unique request ID. | FB698445-61DA-5361-BF73-1C5F1157E888 |
Examples
Success response
JSON format
Error codes
HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 403 | NoPermission | You are not authorized to perform this action. | Please check the workspaceId assignment |