Использование ИИ-ассистента#

Типовой сценарий использования#

Для настройки и начала работы с ИИ-ассистентом выполните шаги:

Подготовка документации и ассистента. В дистрибутиве продукта поставляется комплект документации в виде HTML-файлов. Скопируйте или распакуйте этот комплект в директорию, указанную в параметре doc_agent.docs_dir. Так же создайте конфигурационный файл агента (по умолчанию optional/ai-doc/conf/ai-doc.json) на основании файла-примера из дистрибутива (optional/ai-doc/conf/ai-doc-example.json).
Построение индекса. Выполните команду bin/ai-doc ingest для построения локального векторного индекса на основе эмбеддингов. Текст документации предварительно обрабатывается и разбивается на смысловые фрагменты (чанки) при выполнении индексации.
Запуск чата. После завершения построения индекса запустите команду bin/ai-doc ask для начала работы с ИИ-ассистентом.
Работа с ассистентом. ИИ-агент отвечает на запросы пользователя исключительно на основе данных из векторного индекса, что гарантирует достоверность ответов.

Внимание

Для корректной работы ИИ-ассистента должна быть установлена JVM в соответствии с разделом «Системные требования». В противном случае может возникнуть ошибка UnsupportedClassVersionError — подробнее об ошибке и способе устранения описано в документе Ошибка: UnsupportedClassVersionError.

Пример (для настроек по умолчанию):

mkdir -p /opt/kfk/docs
cp -r /path/to/product-docs-html/* /opt/kfk/docs/
bin/ai-doc ingest
bin/ai-doc ask

Подготовка документации#

Поместите файлы документации в директорию, указанную в doc_agent.docs_dir.

Если архив документации не распакован — распакуйте его:

unzip /path/to/product-docs-html.zip -d /opt/kfk/docs
# или
tar -xzf /path/to/product-docs-html.tar.gz -C /opt/kfk/docs

Построение индекса#

Перед началом работы необходимо один раз проиндексировать документацию. Это требуется после добавления новых файлов или обновления существующих.

bin/ai-doc ingest

После успешного завершения индекс сохраняется локально и используется при последующих запросах.

Запуск интерактивной сессии для вопросов#

Для работы с ассистентом используйте интерактивный режим (REPL):

bin/ai-doc ask

Пример сессии:

ai-doc — Documentation Assistant

Question> Как включить шифрование межузлового трафика?

Thinking...

Answer:
Для включения шифрования межузлового трафика задайте параметр
server_encryption_options в kafka.yaml...

Ассистент анализирует вопрос, ищет релевантные фрагменты в индексе и формирует ответ на естественном языке.

Интерактивная оболочка (REPL) поддерживает стандартные возможности работы с историей ввода:

↑ / ↓ — навигация по истории;
Ctrl+R — обратный поиск по истории;
Shift+Enter — многострочный вопрос;
Ctrl+C — отмена текущего ввода;
Ctrl+D / exit / quit — выход.

История сохраняется в файл ~/.kafka/ai_history между сессиями.

Переопределение пути к конфигурационному файлу#

По умолчанию используется стандартный конфигурационный файл, однако при необходимости можно указать собственный:

bin/ai-doc --config /path/to/ai-doc.json ingest

или

bin/ai-doc --config /path/to/ai-doc.json ask

JVM-опции#

Поскольку ассистент запускается в JVM, можно передать дополнительные параметры через переменную окружения KFK_AI_JAVA_OPTS:

KFK_AI_JAVA_OPTS="-Xmx512m" bin/ai-doc ask