文档

文档AI助手插件

更新时间:

本文介绍WebOffice的文档AI助手插件,包括功能特性和使用方法等。

文档AI助手,是一款融入了阿里巴巴通义大模型技术的智能文档创作辅助工具,它能协助您高效地编辑、修饰和翻译文档,显著提升文档处理的效率与品质。

功能特性

功能分类

功能描述

继续写

支持对所选文本智能续写文档内容,提供使用者创作和编写文案的思路和灵感。

生成摘要

支持对所选文本生成摘要,快速提炼页面内容的核心要点,更快地把握所选内容主旨。

翻译

支持12种语言的翻译功能,可有效满足跨语言文档处理的需求。

帮我润色

通过对文本的语法、拼写、用词、句子结构和整体风格进行优化,提高文本的质量和可读性。

丰富内容

支持对所选内容进行AI扩写,增加其内容的丰富度和深度。

改写语气

支持对所选内容做文案描述改写,支持选择更专业、更轻松、更直白、更自信、更亲切这五种模式。

使用限制

  • 目前仅适用PC端WebOffice,不支持移动端H5页面或者小程序端。

开发对接方法

1. 服务端封装接口

文档 AI 助手需要调用 OSS 的 x-oss-process 接口,调用接口前需要先绑定IMM Project到OSS Bucket。

image

绑定完成后,可以进入文档智能处理选项卡申请配额:

image

服务端需要封装一个接口,用于获取文档AI相关接口的签名URL。如:/file/get_ai_process_url

服务端主要逻辑举例(Node.js代码):

// ali-oss SDK文档: https://github.com/ali-sdk/ali-oss?tab=readme-ov-file#signatureurlname-options-strictobjectnamevalidation
const OSS = require('ali-oss');
const store = new OSS({
  region: '<oss region>',
  accessKeyId: '<Your accessKeyId>',
  accessKeySecret: '<Your accessKeySecret>',
  bucket: '<Your bucket name>'
}); 
const objectKey = '<Your object key>';
const url = store.signatureUrl(objectKey, {
  method: 'POST',
  subResource: {
    'x-oss-process': '',  // 注意,这里传空字符串
  },
  expires: 60, // 单位 秒
  'Content-Type': 'text/plain; charset=UTF-8',
});

附录:签名涉及的接口包括:

2. 前端JS-Plugins使用

  1. 在对接了文档编辑 JS-SDK 的基础上,再引入script:

<!-- 引入 js-sdk -->
<script src="https://g.alicdn.com/IMM/office-js/1.1.19/aliyun-web-office-sdk.min.js"></script>

<!-- 引入插件 sdk -->
<script src="https://g.alicdn.com/IMM/office-js-plugins/1.3.0/aliyun-web-office-plugins.min.js"><script>

示例中的1.1.19表示JS-SDK的版本号,请根据实际填写,最新版本请参见JS-SDK版本

示例中的1.3.0表示JS-Plugins的版本号,请根据实际填写,最新版本请参见JS-SDK插件版本

  1. 初始化插件

在调用 JS-SDK 初始化方法aliyun.config之后,调用文档AI助手初始化方法:aliyun.initAIPlugin

let ins = aliyun.config({
  ....
})

// 使用 AI 插件
aliyun.initAIPlugin({
  sdkInstance: ins, // 传入 sdk 实例
  // aiHelperLink: 'https://help.aliyun.com/xxxx', // 面板上AI帮助文档链接
  async onGetAIProcessUrl({ content_type, content_md5 }){
 
    /** 下面获取 x-oss-process url 逻辑,需要调用封装的服务端接口 */
    let opt = {
      content_type,
      // content_md5,
      file_name: "test-object.docx",
    };
    let { ai_process_url } = await $.post("/file/get_ai_process_url", opt);
    
    return {
      ai_process_url, // 必选
      // content_md5, // 可选。 如果不传,则不签名 content_md5 项
    };
  },
  async onFeedback(info){
    // 记录
  }
})

2.1. initAIPlugin 参数说明

字段

类型

必选

说明

sdkInstance

Object

SDK 实例。即 aliyun.config() 返回值。

onGetAIProcessUrl

({content_type: string, content_md5:string })=>Promise<{ai_process_url:string,content_md5?:string}>

获取 x-oss-process 的 URL签名地址的方法。

aiHelperLink

string

面板上AI帮助文档说明链接

onFeedback

(info:FeedbackInfo)=>void

参数 FeedbackInfo

2.2. FeedbackInfo 字段说明

字段

类型

说明

type

string

取值: 'thumb-up', 'thumb-down'

data

object

具体反馈信息

用户使用方式

在文字(word)编辑界面,点击开始工具栏右侧“文档AI助手”或者按快捷键 (windows 使用Alt + /, mac OS使用 Control + /),可以唤醒文档AI助手的菜单,对选中文字或者光标位置的文字进行优化。

image

  • 本页导读 (1)