Refines the content of a playbook conversation.
Debug
You can run this API directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After a successful call, OpenAPI Explorer can automatically generate SDK code examples.
Debug
Authorization information
The following table describes the authorization information for this API. You can use it in the Action element of RAM permission policy statements to grant RAM users or RAM roles the permission to call this API. For more information:
- Action: The specific permission.
- Access level: The access level of each operation. Valid values: Write, Read, or List.
-
Resource type: The resource types supported for authorization in the operation. For more information:
- For required resource types, an asterisk (*) prefix is used.
- For operations that do not support resource-level authorization,
All resourcesis used.
- Condition key: The condition keys defined by the cloud service.
- Dependent action: The other permissions required to successfully perform the operation. The caller must have the permissions of all dependent actions for the operation to succeed.
| Action | Access level | Resource type | Condition key | Dependent action |
|---|---|---|---|---|
| quanmiaolightapp:RunScriptRefine | none | *All resources * |
| None |
Request syntax
Request parameters
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| workspaceId | string | Yes | The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see Workspace ID | llm-zna577pdximvztk5 |
| taskId | string | No | The unique identifier of the task Note | a3d1c2ac-f086-4a21-9069-f5631542f5a2 |
Response parameters
| Parameter | Type | Description | Example value |
|---|---|---|---|
| object | Schema of Response | ||
| end | boolean | Indicates whether the output is complete. A value of true indicates that the output is complete. | |
| header | object | The header of the streaming output, which contains common response information | |
| errorCode | string | The error code | 403 |
| errorMessage | string | The error message | Pop sign mismatch, please check log. |
| event | string | The event type | result-generated |
| eventInfo | string | The event description | Model generation event |
| requestId | string | The request ID | F8A35034-EDCF-5C50-95A5-1044316F36E3 |
| sessionId | string | The session ID | 17dc8bcd-f34a-46d1-a7a3-0fa3d1ce3824 |
| taskId | string | The ID of a generation task | 14356391-6c6c-40d5-b80a-8ecd03b69d72 |
| traceId | string | The trace ID | 2150432017236011824686132ecdbc |
| payload | object | The payload of the response, in JSON format. The structure varies by event | |
| output | object | The output content object | |
| text | string | The output content | xx |
| role | string | The role identity | User role information |
| scene | string | The story scene. This is a reserved field | Reserved field, no value assigned |
| summary | string | The story synopsis | In a metropolis full of opportunities and challenges, an ordinary girl Lin Su harbors dreams but hits walls everywhere. A chance encounter |
| outline | string | The script outline | On a night in the bustling city, Lin Su, feeling down after a failed interview, accidentally bumps into Shen Yi |
| content | array<object> | The body content | |
| content | object | The body content | |
| string | The body content. The content of an act | {"Act 1":" Act number: Act 1\n\n Scene description"} | |
| usage | object | The token usage of the Large Language Model (LLM) | |
| inputTokens | long | The number of input tokens | 100 |
| outputTokens | long | The number of output tokens | 100 |
| totalTokens | long | The total number of tokens | 200 |
Examples
Normal response example
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 assignment of the workspaceId. | Check the workspaceId assignment |