跳到主要内容

添加自定义 AI 提供商

ONLYOFFICE 编辑器允许您添加自定义 AI 提供商，并根据您的偏好进行配置。

前提条件​

添加自定义提供商之前，请确保已完成以下步骤：

  1. 从您选择的提供商处获取必要的凭据：

    • 基础 URL：发送 API 请求的网址。在某些情况下，基础 URL 可能包含指定所用模型的端点，例如：

      https://dashscope.aliyuncs.com/compatible-mode/

    • 模型版本：用于标识您所访问的模型版本。有时模型版本包含在基础 URL 中，例如以下 URL 中的 v1：

      https://api.moonshot.cn/v1

    • API 密钥：由服务提供商提供的唯一密钥，用于身份验证。

创建外部 JavaScript 文件​

要添加自定义提供商并使其显示在 AI 插件的可用提供商列表中，您需要创建并上传一个外部 JS 文件。

从该文件解析的自定义提供商是 Provider 类的实例，该类扩展了 AI.Provider。此类管理插件中所有可用的提供商。

以下是 Provider 类的参数：

class Provider {
    /**
     * Provider base class.
     * @param {string} name  Provider name.
     * @param {string} url   Url to service.
     * @param {string} key   Key for service. This is an optional field. Some providers may require a key for access.
     * @param {string} addon Addon for url. For example: v1 for many providers.
     */
    constructor(name, url, key, addon) {
        this.name  = name  || "";
        this.url   = url   || "";
        this.key   = key   || "";
        this.addon = addon || "";

        this.models = [];
        this.modelsUI = [];
    }
}

让我们以通义千问服务的实现为例：

"use strict";

class Provider extends AI.Provider {

    constructor() {
        super("Alibaba Cloud", "https://dashscope.aliyuncs.com/compatible-mode", "yourAPIKey", "v1");
    }

}

其中：

  • Alibaba Cloud 是将在插件中显示的提供商名称。
  • https://dashscope.aliyuncs.com/compatible-mode 是我们发送 API 请求的网址。
  • yourAPIKey 是提供商颁发的 API 密钥。
  • v1 是我们发送 API 请求所用的模型版本。

添加自定义提供商​

  1. 右键单击任意选中的单词，在上下文菜单中选择 AI → 设置。
  2. 在 AI 配置窗口中，选择编辑 AI 模型。
  3. 在 AI 模型列表窗口中，单击铅笔图标以编辑模型。
  4. 在编辑 AI 模型窗口中，单击窗口左下角的自定义提供商。
  5. 单击加号图标，上传包含您的自定义提供商设置的 JavaScript 文件。
  6. 单击返回退出添加 AI 模型窗口。
  7. 在添加 AI 模型窗口的列表中选择您的自定义提供商，然后单击 OK。
  8. 单击返回退出 AI 模型列表窗口。
  9. 在 AI 配置窗口中，为特定任务设置您的自定义提供商模型。