oai

OAI - Assistai Assistant Interface

Chatgpt в вашей системе

Оглавление

• Почему oai
• Образец использования
• Установка
• Настройка
• Использование CLI
  • Глобальный доступ
  • Команды
• Векторные магазины
• Инструменты
  • Доступные инструменты
  • Как добавить инструменты?
• Отладка

Почему oai

Помощник API OpenAI обрабатывает агентов, историю разговоров, векторные магазины и инструменты для работы, которые традиционно требуют большого количества кода шаблона для настройки.

Наша цель с OAI - обеспечить простой и интуитивно понятный интерфейс для взаимодействия с этим API.

Текущая версия предлагает интерфейс CLI, но в будущем появится больше.

Образец использования

• Общаться с актуальной документацией с управляемыми векторными магазинами
• Задайте вопрос о вашей кодовой базе, используя инструменты
• Попросите вашего помощника написать код непосредственно в файлы
• Позвольте вашему помощнику управлять и получить доступ к вашей системе
• Настроить и проверить помощника для другой интеграции
• Что бы вы ни думали

Просто запустите oai из командной строки, чтобы взаимодействовать

Установка

В настоящее время OAI полагается на булочку, и его необходимо установить в вашу систему, чтобы запустить проект.

Более поздняя версия может позволить использовать время выполнения node , но сейчас поддерживается только bun .

git clone [email protected]:pAIrprogio/gpt-assistant-cli-playground.git
bun install

Настройка

• Создать проект на платформе Openai
• Создать ключ API
• Добавьте свой ключ API OpenAI в файл .env с помощью OPENAI_API_KEY=your-key

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

Глобальный доступ

Чтобы установить своего помощника по всему миру и получить доступ к нему с помощью команды oai , запустите bun link в папке проекта.

Любые изменения, внесенные в проект, будут отражены в глобальной команде без какого -либо дополнительного шага сборки.

Команды

• oai или oai chat : начинает беседовать с помощником
• oai a|assistant : управлять своим помощником
  • oai a ls|list : список доступных помощников
  • oai a add|create|new : Создайте нового помощника
  • oai a rm|remove|delete : Удалить помощника
  • oai ae|edit : Изменить помощника
• oai vs|vector-store : управляйте вашим векторным магазином
  • oai vs ls|list : список доступных векторных магазинов
  • oai vs add|create|new : Создайте новый векторный магазин
  • oai vs rm|remove|delete : удалить векторный магазин
  • oai vs e|edit : редактировать векторный магазин
  • oai vs sync : синхронизированные векторные магазины

Векторные магазины

Векторные магазины используются помощниками с file search включенным для динамического получения соответствующей информации. OAI помогает вам управлять их пользовательскими синхронизациями.

• Sitemap Sync : получает URL -адреса из карты сайта и синхронизирует каждую страницу в векторный магазин
• Синхронизации URL -адресов страниц : получает URL -адреса со страницы и синхронизирует каждый URL -адрес в векторном магазине
• Больше впереди

После настройки обязательно запустите oai vs sync , чтобы синхронизировать ваш векторный магазин.

Инструменты

Доступные инструменты

• LS: git infault file listing
• Читать-файл: прочитать файл
• write-file: записывает в файл, создавая каталоги, если это необходимо
• Приложение к файлу: добавляет к существующему файлу
• Commit: Commits изменения в текущую филиал
• Create-DIR: создает каталог со своими родителями, если это необходимо
• Execute-Command: выполняет команду ( ️ Не будет просить подтверждения)
• get-url-content: получает содержание URL
• File-Diff: считывает текущие различия файла

Как добавить инструменты?

Следуйте шагам в Docs/Add-new-tool.md

Отладка

Из-за проблем в Bun-Vscode вам необходимо проверить через внешний отладчик.

Чтобы отлаживать проект, запустите bun debug в папке проекта.