open assistant api скачать - open assistant api -код скачать

open assistant api

Другой исходный код

1.0.0

Скачать

Открытый помощник API

Нестандартный интеллектуальный помощник AI AI AI

Английский | 简体中文 | 日本語

Введение

Открытый помощник API-это самостоятельный AI AI-помощник с открытым исходным кодом API, совместимый с официальным интерфейсом Openai. Его можно использовать непосредственно с официальным клиентом Openai для создания приложений LLM.

Он поддерживает один API для интеграции с большим количеством коммерческих и частных моделей.

Он поддерживает R2R Rag Engine。

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

Ниже приведен пример использования официальной библиотеки Openai Python openai :

 import openai

client = openai . OpenAI (
    base_url = "http://127.0.0.1:8086/api/v1" ,
    api_key = "xxx"
)

assistant = client . beta . assistants . create (
    name = "demo" ,
    instructions = "You are a helpful assistant." ,
    model = "gpt-4-1106-preview"
)

Почему выбирают открытый помощник API

Особенность	Открытый помощник API	Openai Assistant API
Экосистемная стратегия	Открытый исходный код	Закрытый источник
Тряпичный двигатель	Поддержка R2R	Поддерживается
Поиск в Интернете	Поддерживается	Не поддерживается
Пользовательские функции	Поддерживается	Поддерживается
Встроенный инструмент	Расширяется	Не расширяется
Переводчик кода	Под разработкой	Поддерживается
Мультимодальный	Поддерживается	Поддерживается
Поддержка LLM	Поддерживает больше LLMS	Только GPT
Выход потоковой передачи сообщений	Поддержка	Поддерживается
Местное развертывание	Поддерживается	Не поддерживается

Поддержка LLM : по сравнению с официальной версией Openai, можно поддерживать больше моделей, интегрируя с одним API.
Инструмент : в настоящее время поддерживает онлайн -поиск; может легко расширить больше инструментов.
Rag Engine : в настоящее время поддерживаемые в настоящее время типы файлов являются TXT, HTML, Markdown, PDF, DOCX, PPTX, XLSX, PNG, MP3, MP4 и т. Д. Мы предоставляем предварительную реализацию.
Вывод потоковой передачи сообщений : вывод потоковой передачи сообщений для более плавного пользовательского опыта.
Экосистемная стратегия : с открытым исходным кодом, вы можете развернуть сервис локально и расширить существующие функции.

Быстрый старт

Самый простой способ начать открытый помощник API-это запустить файл docker-compose.yml. Убедитесь, что Docker и Docker Compose установлены на вашей машине перед запуском.

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

Перейдите в каталог Project Root, Open docker-compose.yml , заполните ключ поиска API_KEY и Bing Bing (необязательно).

 # openai api_key (supports OneAPI api_key)
OPENAI_API_KEY= < openai_api_key >

# bing search key (optional)
BING_SUBSCRIPTION_KEY= < bing_subscription_key >

Рекомендуется настроить R2R Rag Engine, чтобы заменить реализацию RAG по умолчанию, чтобы обеспечить лучшие возможности RAG. Вы можете узнать и использовать R2R через репозиторий Github R2R.

 # RAG config
# FILE_SERVICE_MODULE=app.services.file.impl.oss_file.OSSFileService
FILE_SERVICE_MODULE=app.services.file.impl.r2r_file.R2RFileService
R2R_BASE_URL=http:// < r2r_api_address >
R2R_USERNAME= < r2r_username >
R2R_PASSWORD= < r2r_password >

Бегать

Беги с Docker Compose:

docker compose up -d

Доступ к API

URL -адрес базы API: http://127.0.0.1:8086/api/v1

Адрес документации интерфейса: http://127.0.0.1:8086/docs

Завершите пример использования

В этом примере создается и запускается ассистент ИИ с использованием официальной клиентской библиотеки Openai. Если вам нужно изучить другие методы использования, такие как потоковая вывод, инструменты (Web_Search, поиск, функция) и т. Д., Вы можете найти соответствующий код в каталоге примеров. Перед запуском вам нужно запустить pip install openai чтобы установить библиотеку Python openai .

 # !pip install openai
export PYTHONPATH= $( pwd )
python examples/run_assistant.py

Разрешения

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

Метод аутентификации - токен носителя. Вы можете включить Authorization: Bearer *** в заголовке для аутентификации.
Управление токеном описано в разделе токена документации API. Соответствующие API должны быть аутентифицированы с токеном администратора, который настроен как APP_AUTH_ADMIN_TOKEN и по умолчанию «администратор».
При создании токена вам необходимо предоставить базовый URL и ключ API большой модели. Созданный помощник будет использовать соответствующую конфигурацию для доступа к большой модели.

Инструменты

Согласно спецификации OpenAPI/Swagger, он позволяет интегрировать различных инструментов в помощника, расширяя возможности и расширение возможностей для связи с внешним миром.

Облегчает подключение вашего приложения с другими системами или службами, обеспечивая взаимодействие с внешней средой, например, выполнение кода или доступ к запатентованным источникам информации.
Во время использования вам нужно сначала создать инструменты, а затем вы можете интегрировать их с помощником. Обратитесь к тестовым случаям для получения более подробной информации.
Если вам нужно использовать инструменты с информацией об аутентификации, просто добавьте информацию о аутентификации во время выполнения. Конкретный формат параметров можно найти в документации API. Обратитесь к тестовым случаям для получения более подробной информации. Беги с действием Auth

Сообщество и поддержка

Присоединяйтесь к каналу Slack, чтобы увидеть новые релизы, обсудить проблемы и участвовать в взаимодействии сообщества.
Присоединяйтесь к каналу Discord, чтобы взаимодействовать с другими членами сообщества.
Присоединяйтесь к группе WeChat: