RunDocSummary - 问答内容总结

妙读文档总结摘要接口

调试

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

授权信息

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

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

请求语法

POST /miaodu/stream/runDocSummary HTTP/1.1

请求参数

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

百炼业务空间 Id

llm-2setzb9x4ewsd
SessionIdstring

对话 ID

0f56f98a-f2d8-47ec-98e9-1cbdcffa9539
DocIdstring

文档 ID

12345
Querystring

自定义要求

请总结一下这篇文档
RecommendContentstring

要总结的内容

要总结的内容

返回参数

名称类型描述示例值
object

Schema of Response

Headerobject

响应头

ErrorCodestring

错误码

success
ErrorMessagestring

错误信息

success
Eventstring

事件类型

task-started
EventInfostring

事件描述

模型生成事件
SessionIdstring

会话 ID

92e16ccb-92b6-4894-abbf-fc6e2929a0df
TaskIdstring

任务 ID

b057f2fa-2277-477b-babf-cbc062307828
TraceIdstring

全链路 ID

2150451a17191950923411783e2927
Payloadobject

响应体

Outputobject

输出

Contentstring

总结内容

总结内容
Usageobject

大模型 token 用量信息

InputTokenslong

输入使用的 Token 数量

100
OutputTokenslong

输出 Token 数量

100
TotalTokenslong

总 oken 数量

200
RequestIdstring

请求 Id

3259D344-E871-5DE0-8FFE-CDA21F8D4382

示例

正常返回示例

JSON格式

{
  "Header": {
    "ErrorCode": "success",
    "ErrorMessage": "success",
    "Event": "task-started",
    "EventInfo": "模型生成事件",
    "SessionId": "92e16ccb-92b6-4894-abbf-fc6e2929a0df",
    "TaskId": "b057f2fa-2277-477b-babf-cbc062307828",
    "TraceId": "2150451a17191950923411783e2927"
  },
  "Payload": {
    "Output": {
      "Content": "总结内容"
    },
    "Usage": {
      "InputTokens": 100,
      "OutputTokens": 100,
      "TotalTokens": 200
    }
  },
  "RequestId": "3259D344-E871-5DE0-8FFE-CDA21F8D4382"
}

错误码

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

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