Использование APIMart в AnythingLLM

Documentation Index

Fetch the complete documentation index at: https://docs.apimart.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

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

1. AnythingLLM установлен
   Скачайте и установите AnythingLLM с официального сайта или посетите GitHub
2. Получен API-ключ APIMart
   Войдите в консоль APIMart, чтобы получить API-ключ (начинается с sk-)

​

Шаг 1: Запустите AnythingLLM и откройте настройки

​

1.1 Запустите приложение

1. Запустите десктоп-приложение AnythingLLM или зайдите в веб-версию
2. При первом запуске появится приветственный экран
3. Нажмите кнопку Open settings в нижнем левом углу

​

1.2 Перейдите к конфигурации LLM

1. Найдите LLM Preference в левом меню
2. Кликните, чтобы открыть страницу конфигурации LLM

​

Шаг 2: Настройте API APIMart

​

2.1 Выберите провайдера LLM

1. Найдите выпадающее меню LLM Provider
2. Выберите Generic OpenAI

​

2.2 Настройте данные API

​

2.3 Настройте параметры модели (необязательно)

​

2.4 Сохраните конфигурацию

1. Нажмите кнопку Save внизу страницы
2. Система автоматически проверит подключение
3. Появится сообщение об успехе, если конфигурация верна

​

Шаг 3: Настройте Embedding-модель (необязательно)

​

3.1 Перейдите к настройкам Embedding

1. Найдите Embedding Preference в левом меню
2. Кликните, чтобы открыть страницу конфигурации embedding-модели

​

3.2 Настройте Embedding-модель

​

Шаг 4: Создайте рабочее пространство и загрузите документы

​

4.1 Создайте рабочее пространство

1. Вернитесь в главный интерфейс
2. Нажмите + New Workspace
3. Введите имя рабочего пространства (например, «Помощник по технической документации», «База знаний клиентского сервиса»)
4. Нажмите Create

​

4.2 Загрузите документы

• 📄 Текстовые документы — .txt, .md, .pdf, .docx
• 💻 Файлы кода — .py, .js, .java, .cpp и т. д.
• 🌐 Веб-страницы — через скрапинг по URL
• 📊 Файлы данных — .csv, .json, .xml

1. На странице рабочего пространства нажмите Upload Documents
2. Выберите файлы или перетащите их в область загрузки
3. Дождитесь завершения обработки документов
4. Документы будут автоматически векторизованы

​

4.3 Управляйте документами

1. Просматривайте все загруженные документы
2. Удаляйте ненужные документы
3. Просматривайте детали разбиения документов
4. Редактируйте метаданные документов

​

Шаг 5: Начните диалог

​

5.1 Базовые диалоги

1. В рабочем пространстве найдите поле ввода диалога
2. Введите ваш вопрос или запрос
3. ИИ сгенерирует ответы на основе загруженных документов и моделей APIMart

​

5.2 Использование функции базы знаний

1. Анализировать ваш вопрос
2. Извлекать релевантный контент из загруженных документов
3. Генерировать точные ответы, комбинируя извлечённый контент и AI-модель

​

5.3 Переключайтесь между рабочими пространствами

1. Кликните на имя рабочего пространства в левом верхнем углу
2. Выберите другие рабочие пространства или создайте новые
3. У каждого рабочего пространства независимые документы и история диалогов

​

Расширенные возможности

​

1. Режим Agent

• 🔍 Искать в вебе — получать актуальную информацию
• 🧮 Выполнять расчёты — обрабатывать математику и анализ данных
• 📊 Создавать графики — визуализировать данные
• 🔗 Вызывать API — взаимодействовать с внешними сервисами

1. Найдите Agent Configuration в настройках рабочего пространства
2. Выберите инструменты и функции для включения
3. Сохраните конфигурацию

​

2. Управление историей диалогов

• Экспорт диалогов — экспортируйте диалоги в текст или JSON
• Поиск по истории — быстро находите исторические диалоги
• Удаление записей — очищайте ненужную историю диалогов

​

3. Кастомные системные промпты

1. Найдите System Prompt
2. Настройте роль и поведение ИИ
3. Пример:

You are a professional technical support engineer, skilled at answering technical questions about products.
When answering, please:
1. Maintain professionalism and courtesy
2. Provide detailed step-by-step instructions
3. If uncertain, recommend contacting technical support

​

4. Управление несколькими пользователями (только Docker)

• Создавайте несколько учётных записей пользователей
• Устанавливайте разные уровни доступа
• Управляйте правами доступа к рабочим пространствам

​

5. Доступ к API

• Программного доступа к рабочим пространствам
• Загрузки и управления документами
• Отправки запросов диалога
• Интеграции в ваши приложения

​

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

​

Q1: Не удаётся подключиться к сервису APIMart?

1. Проверьте Base URL:
   • Убедитесь, что это https://api.apimart.ai/v1 (включает /v1)
   • Не добавляйте лишние пути и не пропускайте /v1
2. Проверьте API Key:
   • Убедитесь, что API Key начинается с sk-
   • Проверьте действительность ключа в консоли APIMart
3. Проверьте сетевое подключение:
   • Убедитесь в доступности https://api.apimart.ai
   • Проверьте настройки брандмауэра или прокси

​

Q2: Документы не извлекаются корректно после загрузки?

1. Проверьте конфигурацию embedding-модели:
   • Убедитесь, что embedding-модель настроена правильно
   • Протестируйте подключение embedding-модели
2. Переобработайте документы:
   • Удалите и перезагрузите документы
   • Проверьте, поддерживается ли формат документа
3. Настройте параметры поиска:
   • Настройте порог сходства в настройках рабочего пространства
   • Увеличьте количество возвращаемых фрагментов документов

​

Q3: Медленный отклик диалога?

1. Переключитесь на более быстрые модели:
   • Используйте gpt-4o-mini вместо gpt-4o
   • Используйте gemini-2.0-flash-exp для более быстрого ответа
2. Оптимизируйте количество документов:
   • Уменьшите количество документов в рабочем пространстве
   • Удалите ненужные большие файлы
3. Настройте Max Tokens:
   • Уменьшите максимальную длину вывода
   • Используйте более лаконичные промпты

​

Q4: Как просмотреть использование API и расходы?

• 📊 Статистику вызовов API
• 💰 Детали расходов
• 📈 Графики тенденций использования
• 🔍 Подробные логи запросов

​

Q5: Какие варианты развёртывания поддерживает AnythingLLM?

• 🖥️ Десктоп-приложение — Windows, macOS, Linux
• 🐳 Docker — самостоятельное развёртывание
• ☁️ Облачная версия — AnythingLLM Cloud (скоро)

​

Примеры сценариев использования

​

1. Корпоративная база знаний

• Модель: gpt-4o-mini (выгодная)
• Документы: внутренние документы, руководства, FAQ
• Функция: быстрый поиск информации для сотрудников

• Онбординг новых сотрудников
• Быстрый поиск политик компании
• Поиск в технической документации

​

2. Помощник по технической документации

• Модель: claude-sonnet-4-5-20250929 (отлично для кода)
• Документы: API-документы, технические спецификации, кодовая база
• Функция: помощь разработчикам в поиске технической информации

• Запросы к документации по использованию API
• Поиск примеров кода
• Ответы на технические вопросы

​

3. База знаний клиентского сервиса

• Модель: gpt-4o (высококачественный диалог)
• Документы: руководства по продукту, FAQ, решения
• Функция: быстрый ответ на вопросы клиентов

• Автоматические ответы на FAQ
• Руководство по использованию продукта
• Советы по устранению неполадок

​

4. Помощник по исследованиям и обучению

• Модель: gpt-5 (мощное понимание)
• Документы: научные статьи, учебники, заметки
• Функция: помощь в обучении и исследованиях

• Резюмирование и анализ статей
• Объяснение концепций
• Планирование образовательного пути

​

Возможности

• 📚 Приватная база знаний — создавайте безопасную приватную базу знаний локально
• 🔒 Конфиденциальность данных — все данные хранятся локально, защищая приватность
• 🤖 Поддержка нескольких моделей — гибко переключайтесь между разными AI-моделями
• 📄 Поддержка нескольких форматов — поддержка различных форматов документов
• 🎯 Точный поиск — интеллектуальный поиск по документам на основе векторов
• 💬 Контекстный диалог — поддержание контекста в длинных диалогах
• 🔧 Высокая настраиваемость — настраиваемые промпты, параметры и т. д.
• 🌐 Кроссплатформенность — поддержка Windows, macOS, Linux

​

Безопасность данных и конфиденциальность

​

Локальное хранение данных

• 📁 Локальная файловая система — документы хранятся локально
• 🗄️ Локальная векторная база — векторные индексы хранятся локально
• 💾 История диалогов — записи диалогов хранятся локально

​

Безопасность API-вызовов

• 🔐 Шифрованная передача — все API-вызовы используют HTTPS-шифрование
• 🔑 Защита ключа — API Key хранится безопасно
• 🚫 Нет хранения данных — APIMart не хранит содержимое ваших диалогов

​

Лучшие практики

​

1. Управление документами

• Регулярные обновления — поддерживайте актуальность содержимого документов
• Структурированная организация — используйте чёткую структуру папок
• Соглашения об именовании — используйте осмысленные имена файлов
• Удаление устаревших — регулярно удаляйте устаревшие документы

​

2. Оптимизация промптов

You are an assistant

You are a professional technical support assistant specializing in helping users resolve product-related technical issues.

When answering, please follow these principles:
1. Answer based on provided documentation; if information isn't available, clearly state so
2. Provide detailed step-by-step instructions with examples when necessary
3. Use clear, understandable language
4. For complex issues, recommend contacting the technical support team

​

3. Оптимизация производительности

• Контролируйте размер документов — избегайте загрузки слишком больших отдельных файлов
• Разумное разбиение — используйте настройки разбиения по умолчанию
• Выбирайте подходящую модель — выбор модели в зависимости от сложности задачи
• Мониторинг использования — регулярно проверяйте использование API

​

4. Планирование рабочих пространств

• Делите по проектам — создавайте независимые рабочие пространства для разных проектов
• Управление правами — настраивайте права рабочих пространств (Docker-версия)
• Резервное копирование — регулярно бэкапьте важные рабочие пространства

​

Поддержка и помощь

• 📚 Документация APIMart
• 📚 Официальная документация AnythingLLM
• 📚 AnythingLLM GitHub
• 💬 Сообщество Discord
• 🐦 Twitter @APIMart_
• 📧 Техническая поддержка: zhihong@apimart.ai