智能文档摘要_对象存储(OSS)-阿里云帮助中心

智能文档摘要生成功能可以根据用户提供的文档内容快速生成摘要，方便用户更快速地获取文档的核心内容和结论，提高效率。

注意事项

智能文档摘要功能仅支持同步处理（x-oss-process处理方式）。
该接口需采用POST方式请求。
使用智能文档摘要前，需要先绑定IMM Project。关于控制台和API如何绑定，请参见快速入门和AttachOSSBucket。
不支持匿名访问。
必须拥有IMM处理所需的相关权限。更多信息，请参见权限。

参数说明

操作名称：doc/summarize

具体参数如下表所示。

参数

类型

是否必须

描述

content

string

是

需要摘要的文档内容，需经过URL安全的Base64编码。

说明

最大支持长度为19500字节。

format

string

否

指定返回数据的方式，取值：

json（默认值）：普通模式，会返回一个数据包，其中包含完整的请求结果。
event-stream：SSE模式，会收到多个数据包，其中每次都包含全量的数据。

返回参数如下表所示：

参数	类型	描述
RequestId	string	当次请求的Request ID。
Output	struct	输出的结果内容。子节点：Text, FinishReason
Text	string	本次请求的处理得到的结果内容。父节点：Output
FinishReason	string	表明当前生成结果的现状。取值： null：正在生成 stop：生成结束父节点：Output

使用REST API

使用普通模式进行文档智能摘要

处理方式

待处理文件：example.doc
待摘要文本：“四大名著，即四大小说名著，是指《三国演义》、《西游记》、《水浒传》、《红楼梦》4部中国古典章回小说。”
返回结果方式：json

处理示例

POST /example.doc?x-oss-process HTTP/1.1
Host: doc-demo.oss-cn-hangzhou.aliyuncs.com
Date: Fri, 28 Oct 2022 06:40:10 GMT
Authorization: OSS qn6q**************:77Dv****************

x-oss-process=doc/summarize,content_5Zub5aSn5ZCN6JGX77yM5Y2z5Zub5aSn5bCP6K-05ZCN6JGX77yM5piv5oyH44CK5LiJ5Zu95ryU5LmJ44CL44CB44CK6KW_5ri46K6w44CL44CB44CK5rC05rWS5Lyg44CL44CB44CK57qi5qW85qKm44CLNOmDqOS4reWbveWPpOWFuOeroOWbnuWwj-ivtOOAgg==

返回示例

HTTP/1.1 200 OK
Server: AliyunOSS
Date: Thu, 10 Aug 2023 11:09:00 GMT
Content-Type: application/json;charset=UTF-8
Connection: close
Vary: Accept-Encoding
x-oss-request-id: 6597BB4D4479D831339FCA1D
x-oss-server-time: 2010
Content-Encoding: gzip

{
    "RequestId":"6597BB4D4479D831339FCA1D",
    "Output":{
        "Text":"四大名著是中国古典章回小说的代表作，包括《三国演义》、《西游记》、《水浒传》和《红楼梦》四部作品。",
        "FinishReason":"stop"
    }
}

使用SSE进行文档智能摘要

处理方式

待处理文件：example.doc
待摘要文本：“四大名著，即四大小说名著，是指《三国演义》、《西游记》、《水浒传》、《红楼梦》4部中国古典章回小说。”
返回结果方式：event-stream

处理示例

POST /demo.doc?x-oss-process HTTP/1.1
Host: doc-demo.oss-cn-hangzhou.aliyuncs.com
Date: Fri, 28 Oct 2022 06:40:10 GMT
Authorization: OSS qn6q**************:77Dv****************

x-oss-process=doc/summarize,format_event-stream,content_5Zub5aSn5ZCN6JGX77yM5Y2z5Zub5aSn5bCP6K-05ZCN6JGX77yM5piv5oyH44CK5LiJ5Zu95ryU5LmJ44CL44CB44CK6KW_5ri46K6w44CL44CB44CK5rC05rWS5Lyg44CL44CB44CK57qi5qW85qKm44CLNOmDqOS4reWbveWPpOWFuOeroOWbnuWwj-ivtOOAgg==

返回示例

HTTP/1.1 200 OK
Server: AliyunOSS
Date: Thu, 10 Aug 2023 11:20:11 GMT
Content-Type: text/event-stream;charset=UTF-8
Transfer-Encoding: chunked
Connection: close
x-oss-request-id: 64D4C7EA88339E30351A6A2E
x-oss-server-time: 587

id: 0
event: Result
data: {"RequestId":"6597BBD04479D83232F0CA1D","Output":{"Text":"四大","FinishReason":"null"}}

id: 1
event: Result
data: {"RequestId":"6597BBD04479D83232F0CA1D","Output":{"Text":"四大名","FinishReason":"null"}}

id: 2
event: Result
data: {"RequestId":"6597BBD04479D83232F0CA1D","Output":{"Text":"四大名著","FinishReason":"null"}}

id: 3
event: Result
data: {"RequestId":"6597BBD04479D83232F0CA1D","Output":{"Text":"四大名著是中国古典章回小说","FinishReason":"null"}}

id: 4
event: Result
data: {"RequestId":"6597BBD04479D83232F0CA1D","Output":{"Text":"四大名著是中国古典章回小说的代表作，包括《三国演","FinishReason":"null"}}

id: 5
event: Result
data: {"RequestId":"6597BBD04479D83232F0CA1D","Output":{"Text":"四大名著是中国古典章回小说的代表作，包括《三国演义》、《西游记》","FinishReason":"null"}}

id: 6
event: Result
data: {"RequestId":"6597BBD04479D83232F0CA1D","Output":{"Text":"四大名著是中国古典章回小说的代表作，包括《三国演义》、《西游记》、《水浒传》和《","FinishReason":"null"}}

id: 7
event: Result
data: {"RequestId":"6597BBD04479D83232F0CA1D","Output":{"Text":"四大名著是中国古典章回小说的代表作，包括《三国演义》、《西游记》、《水浒传》和《红楼梦》四部作品。","FinishReason":"null"}}

id: 8
event: Result
data: {"RequestId":"6597BBD04479D83232F0CA1D","Output":{"Text":"四大名著是中国古典章回小说的代表作，包括《三国演义》、《西游记》、《水浒传》和《红楼梦》四部作品。","FinishReason":"stop"}}

使用SDK

智能文档摘要仅支持同步处理，SDK使用方法请参见使用SDK。