文档

智能文档润色

更新时间:

您可以通过智能文档润色功能,使得文档更加优雅、清晰、易读。

注意事项

  • 智能文档润色功能仅支持同步处理(x-oss-process处理方式)。

  • 该接口需采用POST方式请求。

  • 使用智能文档润色前,需要先绑定IMM Project。关于控制台和API如何绑定,请参见快速入门AttachOSSBucket

  • 不支持匿名访问。

  • 必须拥有IMM处理所需的相关权限。更多信息,请参见权限

参数说明

操作名称:doc/polish

具体参数如下表所示。

参数

类型

是否必须

描述

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 /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/polish,content_5Zub5aSn5ZCN6JGX77yM5Y2z5Zub5aSn5bCP6K-05ZCN6JGX77yM5piv5oyH44CK5LiJ5Zu95ryU5LmJ44CL44CB44CK6KW_5ri46K6w44CL44CB44CK5rC05rWS5Lyg44CL44CB44CK57qi5qW85qKm44CLNOmDqOS4reWbveWPpOWFuOeroOWbnuWwj-ivtOOAgg==

返回示例

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

{
    "RequestId":"6597BEF94479D8313302D71D",
    "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/polish,format_event-stream,content_5Zub5aSn5ZCN6JGX77yM5Y2z5Zub5aSn5bCP6K-05ZCN6JGX77yM5piv5oyH44CK5LiJ5Zu95ryU5LmJ44CL44CB44CK6KW_5ri46K6w44CL44CB44CK5rC05rWS5Lyg44CL44CB44CK57qi5qW85qKm44CLNOmDqOS4reWbveWPpOWFuOeroOWbnuWwj-ivtOOAgg==

返回示例

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

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

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

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

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

id: 4
event: Result
data: {"RequestId":"6597BFAB4479D8393209D71D","Output":{"Text":"四大名著,是指中国古典章回小说中的四部杰出代表作","FinishReason":"null"}}

id: 5
event: Result
data: {"RequestId":"6597BFAB4479D8393209D71D","Output":{"Text":"四大名著,是指中国古典章回小说中的四部杰出代表作——《三国演义》、《","FinishReason":"null"}}

id: 6
event: Result
data: {"RequestId":"6597BFAB4479D8393209D71D","Output":{"Text":"四大名著,是指中国古典章回小说中的四部杰出代表作——《三国演义》、《西游记》、《水浒","FinishReason":"null"}}

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

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

使用SDK

智能文档润色仅支持同步处理,SDK使用方法请参见使用SDK