-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Add support for choosing models; - Support max_tokens; - Add ability to skip auth validation (for testing purposes); - Added EN readme
- Loading branch information
Showing
11 changed files
with
504 additions
and
221 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| [](https://github.com/gritaro/gigachain/blob/main/README.md) | ||
| [](https://github.com/gritaro/gigachain/blob/main/README-ru.md) | ||
| <br /> | ||
| <div align="center"> | ||
|
|
||
| <a href="https://github.com/ai-forever/gigachain"> | ||
| <img src="https://raw.githubusercontent.com/gritaro/gigachain/main/static/logo.png" alt="Logo" width="80" height="80"> | ||
| </a> | ||
|
|
||
| <h1 align="center">🦜️🔗 GigaChain (GigaChat + LangChain)</h1> | ||
| </div> | ||
|
|
||
| # Компонент GigaChain для Home Assistant | ||
| [](https://github.com/custom-components/hacs) | ||
| [](https://github.com/gritaro/gigachain/actions/workflows/hacs.yaml) | ||
| [](https://github.com/gritaro/gigachain/actions/workflows/hassfest.yaml) | ||
| [](https://github.com/gritaro/gigachain) | ||
| [](https://github.com/gritaro/gigachain/releases/latest) | ||
| [](https://github.com/gritaro/gigachain/releases) | ||
|
|
||
| Компонент реализует диалоговую систему Home Assistant для использования с языковыми моделями, поддерживаемыми фреймворком GigaChain. | ||
| В настоящее время поддерживаются интеграции с LMM: | ||
| * [GigaChat](#GigaChat) (<a href="https://developers.sber.ru/docs/ru/gigachat/overview">русскоязычная (но не только) нейросеть от Сбера</a>) | ||
| * [YandexGPT](#YandexGPT) | ||
| * [OpenAI](#OpenAI) ака ChatGPT (не тестируется) | ||
|
|
||
| ## Установка | ||
| Устанавливается как и любая HACS интеграция. | ||
|
|
||
| ### Необходимые требования | ||
| Для использования интеграции вам понадобится Home Assistant с установленным [HACS](https://hacs.xyz/) | ||
|
|
||
| ### Установка с использованием HACS | ||
| Найдите GigaChain в магазине HACS. Если интеграция не находится в магазине HACS, вы можете [добавить этот url как пользовательский репозиторий HACS](https://hacs.xyz/docs/faq/custom_repositories). | ||
|
|
||
| [](https://github.com/gritaro/gigachain) | ||
|
|
||
| Перезапустите Home Assistant. | ||
|
|
||
| ## Добавление интеграции | ||
|
|
||
| [](https://my.home-assistant.io/redirect/brand/?brand=+GigaChain) | ||
|
|
||
| После добавления настройте интеграцию. | ||
|
|
||
| ## Настройки | ||
| ### GigaChat | ||
| ### Авторизация запросов к GigaChat | ||
| Для авторизации запросов к GigaChat вам понадобится получить *авторизационные данные* для работы с GigaChat API. | ||
|
|
||
| > [!NOTE] | ||
| > О том как получить авторизационные данные для доступа к GigaChat читайте в [официальной документации](https://developers.sber.ru/docs/ru/gigachat/api/integration). | ||
| > | ||
| > | ||
| > [!NOTE] | ||
| > Сертификаты НУЦ Минцифры устанавливать не нужно | ||
| > | ||
| <img src="https://raw.githubusercontent.com/gritaro/gigachain/main/static/auth_data.jpeg" alt="Authorization data" width="40%"> | ||
|
|
||
| ### YandexGPT | ||
| <a href="https://cloud.yandex.ru/ru/docs/yandexgpt/quickstart">Быстрый старт</a> | ||
|
|
||
| Создайте <a href="https://cloud.yandex.com/ru/docs/iam/operations/sa/create">сервисный аккаунт</a> с ролью `ai.languageModels.user`. | ||
| Для создания аккаунта потребуется привязка карты. С карты будет снята и возвращена символическая сумма (11 RUB). | ||
|
|
||
| Создайте <a href="https://cloud.yandex.com/ru/docs/iam/operations/api-key/create">API ключ</a>. | ||
| Идентификатор каталога (Folder ID) можно узнать пройдя по <a href="https://console.cloud.yandex.com/folders">ссылке</a>. | ||
|
|
||
| ### OpenAI | ||
| Для генерации ключа проследуйте по ссылке https://platform.openai.com/account/api-keys | ||
|
|
||
| ## Конфигурация | ||
|
|
||
| * _Темплейт промпта_ (template, Home Assistant <a href=https://www.home-assistant.io/docs/configuration/templating/>`template`</a>) | ||
|
|
||
| Системное сообщение, настраивающее модель и задающее исходное поведение. | ||
| Значение по умолчанию является лишь примером, взятым из офицальной интеграции <a href="https://github.com/home-assistant/core/blob/dev/homeassistant/components/openai_conversation/const.py#L5">OpenAI Conversation</a>. | ||
| Рекомендуется его изменить под собственные нужды. | ||
|
|
||
| * _Модель_ (model, `string`) | ||
|
|
||
| Модели генерации текста в рамках выбранной LLM. Каждая модель может иметь свои тарифы. | ||
|
|
||
| * _Температура_ (temperature, `float`) | ||
|
|
||
| Температура выборки. Значение температуры должно быть не меньше ноля. Чем выше значение, тем более случайным будет ответ модели. При значениях температуры больше двух, набор токенов в ответе модели может отличаться избыточной случайностью. | ||
| Значение по умолчанию зависит от выбранной модели. | ||
|
|
||
| * Максимум токенов (max_tokens, int) | ||
|
|
||
| Максимальное количество токенов, которые будут использованы для создания ответов. | ||
|
|
||
| ## Использование в качестве диалоговой системы | ||
| Создайте и настройте новый голосовой ассистент: | ||
|
|
||
| <img src="https://raw.githubusercontent.com/gritaro/gigachain/main/static/voice-assistant.jpeg" alt="Voice Assistant"> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.