RunHotTopicChat - 聚合热点问答

百炼轻应用-聚合热点播报下API:聚合热点问答。

接口说明

通过此接口,可以针对聚合热点和通用领域知识做问答。欢迎前往控制台体验。通过 SDK 方式调用 API 可参考控制台“API”下的示例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
quanmiaolightapp:RunHotTopicChatnone
*全部资源
*

请求语法

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

请求参数

名称类型必填描述示例值
workspaceIdstring

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

llm-xx
modelIdstring

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

qwen-max-latest
modelCustomPromptTemplatestring

prompt 模版

xx
generateOptionsarray

生成模式列表:默认 textChatGenerate

string

生成模式:summaryChatGenerate、newsChatGenerate 和控制台第三步选项对应,可以直接使用,其他场景可以按需要组合

  • summaryChatGenerate:对应轻应用控制台“仅针对聚合新闻播报单内已包含的信息进行回答”,包括 categoryRecommend, hotTopicSummarySearch, textChatGenerate
  • newsChatGenerate:对应轻应用控制台“允许针对新闻的原始素材和互联网开放域进行搜索后回答“,包括 hotTopicNewsSearch, internetSearch, textChatGenerate
  • textChatGenerate:问答,仅次选项时,必须明确指定源 internetSearch、hotTopicSummarySearch、hotTopicNewsSearch
  • internetSearch:互联网搜索源
  • hotTopicSummarySearch:聚合热点摘要搜索源
  • hotTopicNewsSearch:聚合热点详情搜索源
  • categoryRecommend:频道热点推荐
  • queryRecommend:开启 query 推荐
newsChatGenerate
taskIdstring

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

a3d1c2ac-f086-4a21-9069-f5631542f5a2
originalSessionIdstring

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

a3d1c2ac-f086-4a21-9069-f5631542f5ax
promptstring

用户问题

帮我播报体育热点
hotTopicVersionstring

热榜版本

2024-09-13_12
categorystring

热榜频道

体育
hotTopicsarray

热点名称列表

string

热点标题名称

xxx
imageCountinteger

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

1
stepForBroadcastContentConfigobject

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

categoriesarray

选择的频道列表

string

频道

体育
customHotValueWeightsarray<object>

热度计算维度,不传,则走默认

object

热度计算维度列表

dimensionstring

权重维度唯一标识:

  • views("阅读量")
  • comments("发表观点量")
  • ups("点赞数")
  • downs("点踩数")
  • publishTime("发布时间")
comments
weightinteger

权重,0-10 之间

1
topicCountinteger

话题数量

20
messagesarray<object>

上下文

object

角色:user、assistant、system

rolestring

内容

user
contentstring

发生时间

xxx
createTimestring

时间

2024-12-10 18:51:29

返回参数

名称类型描述示例值
object

Schema of Response

headerobject

消息头

errorCodestring

错误码 code

InvalidParam
errorMessagestring

错误描述

xx
eventstring

事件

task-finished
eventInfostring

事件描述信息

xx
sessionIdstring

会话唯一标识

xxx
taskIdstring

任务唯一标识

d3be9981-ca2d-4e17-bf31-1c0a628e9f99
traceIdstring

全链路唯一标识

2150451a17191950923411783e2927
payloadobject

消息体

outputobject

输出结果

articlesarray<object>

参照内容列表

articlesobject

内容列表

contentstring

正文

xxx
pubTimestring

发布时间

2024-09-22 16:45:06
scoredouble

相关度

0.8
searchSourceNamestring

文章来源名称

互联网
selectboolean

是否参照

true
summarystring

摘要

xx
titlestring

标题

test
urlstring

链接

http://xxx
hotTopicSummariesarray<object>

热点列表

hotTopicSummariesobject

热点

customHotValuedouble

自定义热度值

100000
hotTopicstring

热点话题名称

xx
hotTopicVersionstring

热点话题摘要版本

2024-09-13_08
hotValuedouble

热度值

100000
textSummarystring

热点话题文本摘要

xxx
customTextSummarystring

自定义热点话题文本摘要

xxx
newsarray<object>

新闻列表

newsobject

新闻

titlestring

标题

xxx
urlstring

url

http://xxx
imagesarray<object>

图片列表

imagesobject

图片

urlstring

图片

http://xxx
multimodalMediasarray<object>

配图

multimodalMediasobject

配图

fileUrlstring

链接

http://xxxx
mediaTypestring

类型:

  • image:图片
image
sortScoredouble

相关度

0.8
recommendQueriesarray

推荐 query 列表

recommendQueriesstring

推荐 query

关于xx你有什么看法?
searchQuerystring

改写后 query

xxx
textstring

生成正文:答案等

xx
usageobject

token 消耗

inputTokenslong

输入 token

100
outputTokenslong

输出 token

100
totalTokenslong

总 token

200
requestIdstring

请求唯一标识

04DA1A52-4E51-56CB-BA64-FDDA0B53BAE8

示例

正常返回示例

JSON格式

{
  "header": {
    "errorCode": "InvalidParam",
    "errorMessage": "xx",
    "event": "task-finished",
    "eventInfo": "xx",
    "sessionId": "xxx",
    "taskId": "d3be9981-ca2d-4e17-bf31-1c0a628e9f99",
    "traceId": "2150451a17191950923411783e2927"
  },
  "payload": {
    "output": {
      "articles": [
        {
          "content": "xxx",
          "pubTime": "2024-09-22 16:45:06",
          "score": 0.8,
          "searchSourceName": "互联网",
          "select": true,
          "summary": "xx",
          "title": "test",
          "url": "http://xxx"
        }
      ],
      "hotTopicSummaries": [
        {
          "customHotValue": 100000,
          "hotTopic": "xx",
          "hotTopicVersion": "2024-09-13_08",
          "hotValue": 100000,
          "textSummary": "xxx",
          "customTextSummary": "xxx",
          "news": [
            {
              "title": "xxx",
              "url": "http://xxx"
            }
          ],
          "images": [
            {
              "url": "http://xxx"
            }
          ]
        }
      ],
      "multimodalMedias": [
        {
          "fileUrl": "http://xxxx",
          "mediaType": "image",
          "sortScore": 0.8
        }
      ],
      "recommendQueries": [
        "关于xx你有什么看法?"
      ],
      "searchQuery": "xxx",
      "text": "xx"
    },
    "usage": {
      "inputTokens": 100,
      "outputTokens": 100,
      "totalTokens": 200
    }
  },
  "requestId": "04DA1A52-4E51-56CB-BA64-FDDA0B53BAE8"
}

错误码

HTTP status code错误码错误信息描述
403NoPermissionYou are not authorized to perform this action , Please check the assignment of the workspaceId.请检查workspaceId的赋值

访问错误中心查看更多错误码。