Skip to main content

​
Обзор

Плагин hellojint/updream-openai-compatible-plugin (GitHub) — это плагин с открытым исходным кодом для генерации изображений в Updream Desktop v0.2.0, поддерживающий протокол Universal OpenAI-compatible Image. После установки десктопный клиент перенаправляет запросы на генерацию изображений к любому вышестоящему стороннему API, соответствующему интерфейсу OpenAI Images — APIYI удовлетворяет этому требованию на пути API.
Информация о проекте
  • Исходный код: github.com/hellojint/updream-openai-compatible-plugin (GitHub)
  • Лицензия: MIT
  • Автор: hellojint
  • Имя пакета плагина: updream-openai-compatible-v1.updplugin
  • Основано на: примере провайдера изображений OpenAI из официального руководства по разработке плагинов Updream
Два пути интеграцииЕсли вам не требуется «локальное выполнение задач / локальное хранение учетных данных», отдайте предпочтение веб-клиенту Updream: Интеграция Updream с APIYI (веб). Веб-клиент подключается к APIYI через навык «External Model Connector» + OpenAI-совместимый протокол, при этом установка плагина не требуется — это рекомендуемый вариант для большинства пользователей.Описанный здесь путь с использованием десктопного клиента и плагина предназначен для пользователей, которым необходимо хранить API-ключ локально, выполнять пакетные задачи генерации изображений или которые сталкиваются с ограничениями протокола OpenAI Images в веб-клиенте.

​
Основные возможности

Универсальный OpenAI-совместимый протокол

Работает с любым апстримом, который предоставляет /v1/images/generations и выполняет аутентификацию с помощью Bearer. APIYI удовлетворяет этим требованиям.

Локальное выполнение на десктопе

Задачи выполняются локально в Updream Desktop v0.2.0 и возвращают результаты на веб-холст.

API-ключ хранится локально

Ключ хранится в системной связке ключей Updream и считывается во время выполнения. Сам плагин поставляется без каких-либо учетных данных.

Несколько провайдеров бок о бок

Десктопный клиент может содержать несколько провайдеров (например, openai, apiyi-compatible) и переключаться между ними.

Автоматическое сопоставление размеров

Четкость и соотношение сторон на десктопе автоматически сопоставляются с параметром апстрима size. Жестко заданный extra.size переопределяет это сопоставление.

Несколько форматов ответа

Совместимо с data[].url, data[].b64_json, url верхнего уровня и т. д. MIME определяется по Base64.

​
Примеры моделей APIYI

Следующие ID можно указать в поле ID эндпоинта. Они приведены исключительно для примера:
Фактически поддерживаемые модели перечислены на странице рекомендаций по моделям APIYI. В этой таблице лишь показан формат поля, который принимает плагин.

​
Поля конфигурации плагина

После загрузки плагина в десктопный клиент в форме Add API-Key доступны следующие поля: Ключи API конфиденциальны. Не вставляйте реальные ключи в скриншоты, документацию, issues, файлы README или чаты. В консоли APIYI создайте отдельный ключ с лимитом использования для десктопного клиента и отзовите его после завершения работы.

​
Установка и настройка (пошаговое руководство)

​
Шаг 0: Обзор десктопного клиента

Обзор задач Updream Desktop (v0.2.0) Стандартный интерфейс версии v0.2.0: список задач «Локальное выполнение» слева, верхняя панель с кнопками Синхронизация / Добавить ключ / Импорт плагина / Управление плагинами и метка версии v0.2.0 в правом нижнем углу.

​
Шаг 1: Импорт плагина

Пункт «Импорт плагина» на верхней панели десктопного клиента Нажмите кнопку Импорт плагина в верхней части экрана. В окне выбора файла выберите скачанный updream-openai-compatible-v1.updplugin и при появлении запроса подтвердите установку. Автор рекомендует ознакомиться с plugin.py перед подтверждением.

​
Шаг 2: Проверка установки

Состояние установленного плагина На странице Управление плагинами появится Универсальный OpenAI-совместимый модуль изображений (universal-openai-compatible-image · v1.0.0 · image). С этого момента десктопный клиент готов к обращению к любому вышестоящему сервису, совместимому с генерацией изображений OpenAI.

​
Шаг 3: Добавление ключа

Пункт «Добавить ключ» на верхней панели десктопного клиента Нажмите кнопку Добавить ключ, чтобы открыть форму настройки.

​
Шаг 4: Настройка APIYI

Пример настройки APIYI Заполните форму в соответствии с примером на скриншоте: Нажмите Проверить подключение и Проверить генерацию. Когда появится сообщение Подключение успешно! API доступен, сохраните конфигурацию.

​
Шаг 5: Убедитесь, что провайдер включен

Список провайдеров В списке провайдеров на странице Конфигурация появится ваша новая запись apiyi-compatible. Ее идентификатор провайдера — plugin:universal-openai-compatible-image, а статус — Включено. Вы можете переключаться между провайдерами или отключать их в любое время.
После завершения настройки десктопного клиента снова откройте веб-клиент Updream. В выпадающем списке провайдеров генерации изображений на узле холста выберите apiyi-compatible, чтобы отправлять задачи из веб-клиента для их выполнения десктопным клиентом.

​
Использование: цикл Web → Desktop → Web

После выполнения пяти вышеуказанных шагов запуск генерации изображений из веб-клиента Updream задействует провайдер apiyi-compatible на стороне десктопного клиента и передаст его в https://api.apiyi.com/v1/images/generations. Результат возвращается в узел веб-холста. Веб-клиент получает результат генерации от десктопного клиента На скриншоте панель под холстом показывает: Генерация изображений + apiyi-compatible (позиция стрелки) + 16:9 / 2K / ×1. Это наглядный результат задачи, которая была запущена в веб-клиенте Updream, выполнена в десктопном клиенте и возвращена на веб-холст.

​
Часто задаваемые вопросы

Убедитесь, что версия десктопного клиента — ≥ v0.2.0. В более ранних версиях поддержка плагинов отсутствует, и вам необходимо сначала обновить Updream Desktop.
  1. Убедитесь, что архив .updplugin содержит plugin.py непосредственно в корне, в соответствии с manifest.entry
  2. Перезапустите десктопный клиент
  3. На странице Управление плагинами убедитесь, что статус плагина — не Отключено
  1. Проверьте правильность написания ID эндпоинта и его наличие в актуальном списке моделей APIYI
  2. Убедитесь, что баланса вашего аккаунта достаточно (см. Почему аккаунт выдает ошибку даже при наличии баланса?)
  3. Проверьте точный код ошибки на странице Локальное выполнение десктопного клиента
Веб-клиент не работает через этот плагин. Используйте навык Коннектор внешних моделей веб-клиента с конфигурацией OpenAI-совместимого протокола или см. Интеграция Updream с APIYI (веб).
Увеличьте версию в manifest.json.version, затем выполните переупаковку:
ZIP-архив должен содержать plugin.py непосредственно в корне.
Нет. Плагин поставляется без учетных данных. Ключ хранится в связке ключей Updream и считывается во время выполнения через cfg.get('api_key'). Не вставляйте реальные ключи в plugin.py, README, тикеты или чат.

​
Связанные ресурсы

Интеграция Updream с APIYI (веб-версия, рекомендуется)

Веб-клиент подключается к APIYI с помощью навыка External Model Connector — плагин не требуется

hellojint/updream-openai-compatible-plugin

Открытый репозиторий, на котором основан данный документ (лицензия MIT): github.com/hellojint/updream-openai-compatible-plugin

Рекомендации моделей APIYI

Ознакомьтесь с моделями изображений и ценами, поддерживаемыми в APIYI в настоящее время

Управление API-ключами APIYI

Рекомендации по созданию API-ключей и управлению ими

Консоль APIYI

Создавайте выделенные ключи, отслеживайте использование и устанавливайте лимиты баланса

Интеграция и использование APIYI

Обзор интеграции по API и OpenAI-совместимого протокола