针对一篇文章、视频或者URL，生成总分结构的摘要（全文概述、关键要点）。 1、支持章节速览（即分段、每段的总结、段落摘要）； 2、输入和输出内容支持多语言，包含中/英/日/法，用户可对输入和输出的结果进行自定义的语言要求。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| aimiaobi:RunDocIntroduction | get | *全部资源 * |
| 无 |
请求语法
POST /miaodu/stream/runDocIntroduction HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| WorkspaceId | string | 是 | 业务空间 id | xxxx |
| DocId | string | 是 | 文档 ID | 12345 |
| SessionId | string | 是 | 对话 ID | a3b5eb35-6b28-4cf9-ac09-1dec25ab4df6 |
| SummaryPrompt | string | 否 | 总结内容自定义要求 | 用英文输出 |
| KeyPointPrompt | string | 否 | 关键点自定义要求 | 用英文输出 |
| IntroductionPrompt | string | 否 | 导读内容自定义要求 | 用英文输出 |
| CleanCache | boolean | 否 | 清除缓存 | true |
| referenceContent | string | 否 | 要进行导读的内容，如果不为空，该值优先于 docId | 要进行导读的内容 |
返回参数
示例
正常返回示例
JSON格式
{
"Header": {
"ErrorCode": "success",
"ErrorMessage": "success",
"Event": "task-started",
"EventInfo": "模型生成事件",
"SessionId": "20247a52-23e2-46fb-943d-309cdee2bc6d",
"TaskId": "8a9cecb7-6d20-32db-8823-5882c217b647",
"TraceId": "0bd58ea2-dc38-45da-ac02-17f05cb9040b"
},
"Payload": {
"Output": {
"Introductions": [
{
"Blocks": [
{
"Height": 600,
"PageId": 10,
"Width": 600,
"X": 10,
"Y": 10,
"BeginTime": 0,
"EndTime": 1200
}
],
"StartPageId": 10,
"Summary": "本段摘要内容",
"Title": "本段标题内容"
}
],
"KeyPoint": "要点1；要点2；",
"Summary": "大纲摘要内容"
},
"Usage": {
"InputTokens": 100,
"OutputTokens": 100,
"TotalTokens": 200
}
},
"RequestId": "C9B5BEA6-E8C4-5861-BE37-D906D516510E"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 403 | NoPermission | You are not authorized to perform this action. | 请检查workspaceId的赋值 |
访问错误中心查看更多错误码。