Перейти к основному содержимому

Создание плагина контекстного движка

Плагины контекстного движка заменяют встроенный ContextCompressor альтернативной стратегией управления контекстом разговора. Например, движок Lossless Context Management (LCM), который строит DAG знаний вместо сжатия с потерями.

Как это работает​

Управление контекстом агента построено на ABC-классе ContextEngine (agent/context_engine.py). Встроенный ContextCompressor — реализация по умолчанию. Плагины должны реализовывать тот же интерфейс.

Одновременно может быть активен только один контекстный движок. Выбор управляется конфигурацией:

# config.yaml
context:
  engine: "compressor"    # встроенный по умолчанию
  engine: "lcm"           # активирует плагин с именем "lcm"

Плагины никогда не активируются автоматически — пользователь должен явно указать context.engine с именем плагина.

Структура директории​

Каждый контекстный движок находится в plugins/context_engine/<name>/:

plugins/context_engine/lcm/
├── __init__.py      # экспортирует подкласс ContextEngine
├── plugin.yaml      # метаданные (name, description, version)
└── ...              # любые другие модули, необходимые движку

ABC-класс ContextEngine​

Ваш движок должен реализовать эти обязательные методы:

from agent.context_engine import ContextEngine

class LCMEngine(ContextEngine):

    @property
    def name(self) -> str:
        """Короткий идентификатор, например 'lcm'. Должен совпадать со значением в config.yaml."""
        return "lcm"

    def update_from_response(self, usage: dict) -> None:
        """Вызывается после каждого вызова LLM со словарём usage.

        Обновляет self.last_prompt_tokens, self.last_completion_tokens,
        self.last_total_tokens из ответа.
        """

    def should_compress(self, prompt_tokens: int = None) -> bool:
        """Возвращает True, если сжатие должно сработать на этом шаге."""

    def compress(self, messages: list, current_tokens: int = None,
                 focus_topic: str = None) -> list:
        """Сжимает список сообщений и возвращает новый (возможно, более короткий) список.

        Возвращаемый список должен быть корректной последовательностью сообщений в формате OpenAI.

        ``focus_topic`` — опциональная строка темы из ручного
        ``/compress <focus>``; движки, поддерживающие направленное сжатие, должны
        в первую очередь сохранять информацию, связанную с ней; остальные могут игнорировать.
        """

Атрибуты класса, которые должен поддерживать ваш движок​

Агент читает их напрямую для отображения и логирования:

last_prompt_tokens: int = 0
last_completion_tokens: int = 0
last_total_tokens: int = 0
threshold_tokens: int = 0        # когда срабатывает сжатие
context_length: int = 0          # полное контекстное окно модели
compression_count: int = 0       # сколько раз выполнялся compress()

Опциональные методы​

В ABC для них есть разумные значения по умолчанию. Переопределяйте при необходимости:

МетодПо умолчаниюПереопределять, когда
on_session_start(session_id, **kwargs)Ничего не делаетНужно загрузить сохранённое состояние (DAG, БД)
on_session_end(session_id, messages)Ничего не делаетНужно сбросить состояние, закрыть соединения
on_session_reset()Сбрасывает счётчики токеновЕсть состояние сессии, которое нужно очистить
update_model(model, context_length, ...)Обновляет context_length + thresholdНужно пересчитать бюджеты при смене модели
get_tool_schemas()Возвращает []Ваш движок предоставляет инструменты, вызываемые агентом (например, lcm_grep)
handle_tool_call(name, args, **kwargs)Возвращает JSON с ошибкойВы реализуете обработчики инструментов
should_compress_preflight(messages)Возвращает FalseМожно сделать дешёвую оценку до вызова API
get_status()Стандартный словарь токенов/пороговЕсть собственные метрики для отображения

Инструменты движка​

Контекстные движки могут предоставлять инструменты, которые агент вызывает напрямую. Возвращайте схемы из get_tool_schemas() и обрабатывайте вызовы в handle_tool_call():

def get_tool_schemas(self):
    return [{
        "name": "lcm_grep",
        "description": "Поиск в графе знаний контекста",
        "parameters": {
            "type": "object",
            "properties": {
                "query": {"type": "string", "description": "Поисковый запрос"}
            },
            "required": ["query"],
        },
    }]

def handle_tool_call(self, name, args, **kwargs):
    if name == "lcm_grep":
        results = self._search_dag(args["query"])
        return json.dumps({"results": results})
    return json.dumps({"error": f"Неизвестный инструмент: {name}"})

Инструменты движка внедряются в список инструментов агента при запуске и обрабатываются автоматически — регистрация в реестре не требуется.

Регистрация​

Через директорию (рекомендуется)​

Поместите движок в plugins/context_engine/&lt;name&gt;/. Файл __init__.py должен экспортировать подкласс ContextEngine. Система обнаружения найдёт и создаст его экземпляр автоматически.

Через общую систему плагинов​

Общий плагин также может зарегистрировать контекстный движок:

def register(ctx):
    engine = LCMEngine(context_length=200000)
    ctx.register_context_engine(engine)

Может быть зарегистрирован только один движок. Попытка второго плагина зарегистрироваться будет отклонена с предупреждением.

Жизненный цикл​

1. Создание экземпляра движка (загрузка плагина или обнаружение директории)
2. on_session_start() — начало разговора
3. update_from_response() — после каждого вызова API
4. should_compress() — проверяется на каждом шаге
5. compress() — вызывается, когда should_compress() возвращает True
6. on_session_end() — граница сессии (выход из CLI, /reset, истечение срока шлюза)

on_session_reset() вызывается при /new или /reset для очистки состояния сессии без полного завершения работы.

Конфигурация​

Пользователи выбирают ваш движок через vibeos plugins → Provider Plugins → Context Engine или редактируя config.yaml:

context:
  engine: "lcm"   # должно совпадать со свойством name вашего движка

Блок конфигурации compression (compression.threshold, compression.protect_last_n и т.д.) специфичен для встроенного ContextCompressor. Ваш движок должен определять собственный формат конфигурации при необходимости, читая из config.yaml во время инициализации.

Тестирование​

from agent.context_engine import ContextEngine

def test_engine_satisfies_abc():
    engine = YourEngine(context_length=200000)
    assert isinstance(engine, ContextEngine)
    assert engine.name == "your-name"

def test_compress_returns_valid_messages():
    engine = YourEngine(context_length=200000)
    msgs = [{"role": "user", "content": "hello"}]
    result = engine.compress(msgs)
    assert isinstance(result, list)
    assert all("role" in m for m in result)

Смотрите tests/agent/test_context_engine.py для полного набора тестов контракта ABC.

Смотрите также​