RunSummaryGenerate

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 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
aimiaobi:RunSummaryGenerate	get	All Resource ``	None	None

Action

Access level

Resource type

Condition key

Dependent action

aimiaobi:RunSummaryGenerate

get

*All Resource

*

None

Request syntax

POST /quanmiao/aimiaobi/runSummaryGenerate HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	Unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see workspace ID.	llm-2setzb9x4ewsd
Content	string	Yes	Content to summarize.	Promote innovative government social media functions. Encourage all regions and departments to develop distinctive government social media features based on actual conditions, such as online consulting services, policy interpretation, and interactive Q&A, to enhance the interactivity and practicality of government social media and improve public participation.
Prompt	string	No	Custom prompt for summary generation.	Please generate a summary for the above content, within 100~200 characters.

Response elements

Element	Type	Description	Example
	object	Response schema.
End	boolean	Indicates whether the response is complete. Set to true when complete.
Header	object	Streaming output header. Contains general response information.
ErrorCode	string	Error code.	403
ErrorMessage	string	Error message.	Pop sign mismatch, please check.
Event	string	Event type.	result-generated
EventInfo	string	Event description.	Model generation event
SessionId	string	Session ID.	3cd10828-0e42-471c-8f1a-931cde20b035
TaskId	string	Task ID.	d3be9981-ca2d-4e17-bf31-1c0a628e9f99
TraceId	string	Trace ID.	2150451a17191950923411783e2927
Payload	object	Response payload in JSON format.
Output	object	Output object.
Text	string	Output text.	This is test output
Usage	object	Large Language Model (LLM) token usage information.
InputTokens	integer	Number of input tokens.	100
OutputTokens	integer	Number of output tokens.	100
TotalTokens	integer	Total number of tokens.	200
RequestId	string	Unique request ID.	d3be9981-ca2d-4e17-bf31-1c0a628e9f99

Examples

Success response JSON format

{
  "End": false,
  "Header": {
    "ErrorCode": "403",
    "ErrorMessage": "Pop sign mismatch, please check.",
    "Event": "result-generated",
    "EventInfo": "模型生成事件",
    "SessionId": "3cd10828-0e42-471c-8f1a-931cde20b035",
    "TaskId": "d3be9981-ca2d-4e17-bf31-1c0a628e9f99",
    "TraceId": "2150451a17191950923411783e2927"
  },
  "Payload": {
    "Output": {
      "Text": "这是测试输出"
    },
    "Usage": {
      "InputTokens": 100,
      "OutputTokens": 100,
      "TotalTokens": 200
    }
  },
  "RequestId": "d3be9981-ca2d-4e17-bf31-1c0a628e9f99"
}

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

​Try it now

​RAM authorization

​Request syntax

​Request parameters

​Response elements

​Examples

​Error codes

​Release notes