Руководство
Журнал изменений
Записи об изменениях структуры руководства и описаний интерфейсов
Журнал изменений
На этой странице описаны изменения структуры документации руководства и описаний интерфейсов, чтобы
разработчики, уже выполнившие интеграцию, могли сверить свою реализацию. Документация описывает только
актуальное поведение; если она расходится с вашей прежней реализацией, ориентируйтесь на это руководство
и актуальные результаты GET /v1/models.
Текущее обновление (упорядочение документации)
Структура навигации
Руководство теперь организовано по сценариям использования и разделено на шесть разделов:
| Раздел | Содержание |
|---|---|
| Быстрый старт | Быстрый старт, руководство по функциям платформы, каталог моделей и биллинг, подключение распространённых инструментов |
| Обзор платформ | Позиционирование, функции и частые вопросы четырёх платформ |
| Подключение API | Спецификация аутентификации, обзор интерфейсов, текст, изображения, видео, аудио, коды ошибок |
| Библиотека материалов | Руководство по библиотеке материалов, интерфейсы библиотеки материалов, процесс работы с портретными материалами, референсное видео |
| Веб-создание | Рабочая среда Creation и Agent, генерация видео и повторные попытки, частые вопросы |
| Помощь и справочник | Сводка частых вопросов, биллинг и счета, ограничения и квоты, журнал изменений, глоссарий |
Верхние вкладки и боковая панель обновлены синхронно. Все прежние адреса остались неизменными — ссылки, которыми вы уже поделились с клиентами, продолжают работать.
Новое содержимое
- добавлен раздел «Помощь и справочник»: сводка частых вопросов, биллинг и счета, ограничения и квоты, журнал изменений, глоссарий;
- добавлена отдельная страница описания интерфейса синтеза речи;
- дополнены страницы четырёх платформ списками функций, типичными рабочими процессами и частыми вопросами;
- на страницу Canvas добавлены типы узлов, типовые операции, сочетания клавиш и пример полного процесса создания;
- в индекс документации добавлены аудиоинтерфейс и вход в обзор платформ.
Исправления
- исправлены нерабочие ссылки на странице Canvas, ведущие на неопубликованные страницы;
- исправлена ссылка на видеоинтерфейс в главном входе документации — теперь она ведёт сразу на страницу создания задачи;
- исправлен пропущенный в индексе документации пункт аудиоинтерфейса — теперь он соответствует обзору интерфейсов.
Уточнение понятий
Следующее поведение явно описано в руководстве — обратите на него особое внимание при интеграции:
| Тема | Описание |
|---|---|
| Расчёт при завершении | Асинхронные задачи рассчитываются при завершении; отправка только принимает задачу и не списывает средства заранее |
| Запросы не тарифицируются | Запрос статуса задачи не создаёт расходов; тарифицируется только создание задачи |
| Одинаковые запросы не объединяются | Повторная отправка с теми же параметрами создаёт новые задачи, каждая тарифицируется отдельно; платформа не объединяет их автоматически |
| Материал нужно добавить в библиотеку один раз | ID материала остаётся одинаковым для разных моделей; при смене модели достаточно изменить поле model |
| Материалы реальных людей нельзя понизить | При переключении на модель без поддержки материалов реальных людей они не преобразуются автоматически в обычные референсные изображения |
| Права на снимок запроса | Содержимое запроса и исходный JSON запроса видны только администратору; при запросе обычного пользователя это поле не возвращается |
Как проверить актуальное поведение
Документация описывает проектное поведение; фактическая видимость моделей определяется актуальными результатами:
curl "$LOCOPAL_BASE_URL/v1/models" \
-H "Authorization: Bearer $LOCOPAL_API_KEY"Каталог моделей меняется в зависимости от авторизации аккаунта, адреса доступа и доступности платформы. Рекомендуется повторно запрашивать его при запуске сервиса, смене модели пользователем или получении сообщения «Модель недоступна»; не хардкодьте названия моделей.
