RunCustomHotTopicViewPointAnalysis

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:RunCustomHotTopicViewPointAnalysis	create	All Resource ``	None	None

Action

Access level

Resource type

Condition key

Dependent action

aimiaobi:RunCustomHotTopicViewPointAnalysis

create

*All Resource

*

None

Request syntax

POST /quanmiao/miaoce/runCustomHotTopicViewPointAnalysis HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see Get the Workspace ID.	xxxx
AskUser	string	No	Model follow-up question	Model follow-up question
UserBack	string	No	User feedback	User feedback
SearchQuery	string	No	Rewritten query	Rewritten query
Prompt	string	Yes	Prompt for custom hot topic viewpoint analysis	Prompt for custom hot topic viewpoint analysis
SkipAskUser	boolean	No	Set to true to skip the follow-up question	true
TopicId	string	No	Hot topic ID	Hot topic ID
Topic	string	No	The hot topic for analysis	Hot topic
TopicVersion	string	No	Hot topic version	Hot topic version
TopicSource	string	No	Hot topic source	Hot topic source

Response elements

Element	Type	Description	Example
	object	CustomHotTopicBaseLlmResponse
Header	object	Response header
ErrorCode	string	Error code	Error code
ErrorMessage	string	Error message	Error message
Event	string	Server-sent event. Valid values: task-started, task-finished, and task-failed.	task-started
OriginSessionId	string	Parent session ID	3f7045e099474ba28ceca1b4eb6d6e21
SessionId	string	Session ID	3f7045e099474ba28ceca1b4eb6d6e21
TaskId	string	Task ID	3f7045e099474ba28ceca1b4eb6d6e21
TraceId	string	Trace ID	Trace ID
Payload	object	Response body
Output	object	Outputs
AskUser	array	Follow-up question list
	string	Model follow-up question	xxxxxxx
AsyncTaskId	string	Asynchronous task ID	Asynchronous task ID
Attitude	string	Viewpoint of the custom hot topic generated by the model	Viewpoint of the custom hot topic generated by the model
CustomViewPointId	string	Custom viewpoint ID	xxxxxx
Text	string	Text generation result	Text generation result
TopicId	string	Topic ID	Topic ID
Articles	array<object>	Reference article list
	object	Reference article object
Author	string	Author	Author
Title	string	Title	Article title
Content	string	Content	Article content
PubTime	string	Publish time	2024-09-10 14:17:53
Source	string	Source	CCTV
Url	string	URL title.	https://www.example.com/aaa.docx
Summary	string	Summary	Article summary
Usage	object	Whether the image is running on an ECS instance. Valid values: instance: The image is running and used by an ECS instance. none: The image is idle and not currently used by any ECS instance.
InputTokens	integer	Number of input tokens	51
OutputTokens	integer	Number of output tokens	79
TotalTokens	integer	Total number of tokens	130
RequestId	string	Request ID	3f7045e099474ba28ceca1b4eb6d6e21

Examples

Success response JSON format

{
  "Header": {
    "ErrorCode": "错误码",
    "ErrorMessage": "错误信息",
    "Event": "task-started",
    "OriginSessionId": "3f7045e099474ba28ceca1b4eb6d6e21",
    "SessionId": "3f7045e099474ba28ceca1b4eb6d6e21",
    "TaskId": "3f7045e099474ba28ceca1b4eb6d6e21",
    "TraceId": "全链路ID"
  },
  "Payload": {
    "Output": {
      "AskUser": [
        "xxxxxxx"
      ],
      "AsyncTaskId": "异步任务ID",
      "Attitude": "模型生成的自定义选题视角的观点",
      "CustomViewPointId": "xxxxxx",
      "Text": "文本生成结果",
      "TopicId": "话题ID",
      "Articles": [
        {
          "Author": "作者\n\n",
          "Title": "文章标题",
          "Content": "文章内容",
          "PubTime": "2024-09-10 14:17:53",
          "Source": "央视网",
          "Url": "https://www.example.com/aaa.docx",
          "Summary": "文章摘要"
        }
      ]
    },
    "Usage": {
      "InputTokens": 51,
      "OutputTokens": 79,
      "TotalTokens": 130
    }
  },
  "RequestId": "3f7045e099474ba28ceca1b4eb6d6e21"
}

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