RunHotTopicChat_百炼全妙轻应用_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

当前接口 RunHotTopicChat 说明

通过此接口,可以对播报单(热榜)、热榜新闻、开放域内容做问答,包括频道推荐、热点推荐、热点内容问答等。

欢迎前往控制台体验。

通过 SDK 方式调用 API,请可参考控制台“API”页签下的 java、python 示例!

通过 SDK 方式调用 API,请可参考控制台“API”页签下的 java、python 示例!

通过 SDK 方式调用 API,请可参考控制台“API”页签下的 java、python 示例!

新闻热榜互动全量 API 说明

API 明细

AI 妙笔 SDK 下:对应 alibabacloud-aimiaobi20230801

百炼全妙轻应用 SDK 下:对应 alibabacloud-quanmiaolightapp20240801

  • RunHotTopicChat - 播报单(热榜)问答 --常用
  • RunHotTopicSummary - 播报单热点自定义摘要生成

场景说明

场景 1:获取完整播报单(热榜)全量或者部分频道热点:

  • GetHotTopicBroadcast:查询播报单

场景 2:针对播报单或通用领域问题做问答:

  • RunHotTopicChat:问答

场景 3:内置播报单(热榜)不满足要求,需要个性化定制(频道、个性化摘要等):

  • SubmitCustomHotTopicBroadcastJob:提交自定义播报单任务
  • GetCustomHotTopicBroadcastJob:轮训自定义播报单任务状态
  • GetHotTopicBroadcast:获取自定义播报单信息

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
quanmiaolightapp:RunHotTopicChat
None
全部资源
*

请求语法

POST /{workspaceId}/quanmiao/lightapp/runHotTopicChat HTTP/1.1

路径参数

字段名称字段详情
workspaceIdstring

百炼业务空间唯一标识,百炼首页左上角获取

示例值:llm-xx

请求参数

字段名称字段详情
modelIdstring

数据模型 ID。默认:qwen-max-latest

示例值:qwen-max-latest
modelCustomPromptTemplatestring

prompt 模版

示例值:xx
generateOptionsarray<string>

生成模式列表:默认 textChatGenerate

taskIdstring

对话任务唯一标识:多轮时,这个值保持不变

示例值:a3d1c2ac-f086-4a21-9069-f5631542f5a2
originalSessionIdstring

原始会话唯一标识:重试场景

示例值:a3d1c2ac-f086-4a21-9069-f5631542f5ax
promptstring

用户问题

示例值:帮我播报体育热点
hotTopicVersionstring

热榜版本

示例值:2024-09-13_12参考取值来源:
    ListHotTopicSummaries
    RunHotTopicSummary
categorystring

热榜频道

示例值:体育
hotTopicsarray<string>

热点名称列表

imageCountinteger<int32>

配图张数:不一定都有图,取值[1-3]

示例值:1
stepForBroadcastContentConfigobject

新闻播报内容配置:仅 Saas 用,Paas 调用建议走 hotTopicVersion

messagesarray<object>

上下文

返回参数

字段名称字段详情
headerobject

消息头

payloadobject

消息体

requestIdstring

请求唯一标识

示例值:04DA1A52-4E51-56CB-BA64-FDDA0B53BAE8

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
403
NoPermission
You are not authorized to perform this action , Please check the assignment of the workspaceId.诊断

变更历史

变更时间变更内容概要操作
2024-12-11
新增请求参数messages
2024-12-05
新增错误码403
2024-12-03
变更返回参数
2024-12-03
变更返回参数

相关示例

2024年08月20日