Добавление пользовательского провайдера ИИ

Редакторы ONLYOFFICE позволяют добавить пользовательского провайдера ИИ и настроить его по своему усмотрению.

Предварительные требования

Перед добавлением пользовательского провайдера убедитесь, что выполнены следующие шаги:

1. Получите необходимые учетные данные у выбранного провайдера:

   • Base URL — веб-адрес, на который отправляются запросы API. В некоторых случаях базовый URL может содержать конечную точку, указывающую на используемую модель, например:

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

   • Model Version — версия модели, к которой вы обращаетесь. Иногда версия модели входит в базовый URL, например, v1 в следующем URL:

     https://api.moonshot.cn/v1

   • API Key — уникальный ключ, выданный поставщиком сервиса и используемый для аутентификации.

Создание внешнего файла JavaScript

Чтобы добавить пользовательского провайдера и отобразить его в списке доступных провайдеров в плагине ИИ, нужно создать и загрузить внешний файл 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 = [];
    }
}

Рассмотрим в качестве примера реализацию сервиса Tongyi Qianwen:

"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. Щелкните правой кнопкой мыши по любому выделенному слову и в контекстном меню выберите ИИ → Настройки.
2. В окне Конфигурация ИИ выберите Редактировать ИИ-модели.
3. В окне Список ИИ-моделей нажмите значок карандаша, чтобы изменить модели.
4. В окне Редактировать ИИ-модель нажмите Настраиваемые поставщики в левом нижнем углу окна.
5. Нажмите значок плюса и загрузите файл JavaScript с настройками вашего пользовательского провайдера.
6. Нажмите Назад, чтобы выйти из окна Добавить ИИ-модель.
7. Выберите своего пользовательского провайдера в списке в окне Добавить ИИ-модель и нажмите OK.
8. Нажмите Назад, чтобы выйти из окна Список ИИ-моделей.
9. Назначьте модель вашего пользовательского провайдера для конкретной задачи в окне Конфигурация ИИ.