gigachat

0
3 года назад
2 года назад
2 года назад
3 года назад
2 года назад
3 года назад
2 года назад
2 года назад
2 года назад
README.md

GigaChat. Python-библиотека для GigaChain

Библиотека Python, позволяющая GigaChain обращаться к GigaChat — нейросетевой модели, которая умеет вести диалог, писать код, создавать тексты и картинки по запросу.

Обмен данными с сервисом обеспечивается с помощью GigaChat API. О том как получить доступ к API читайте в официальной документации.

Библиотека поддерживает обработку потоковой передачи токенов, а также работу в синхронном или в асинхронном режиме.

Библиотека позволяет выполнить точный подсчет токенов в тексте с помощью GigaChat API.

Warning

В версии 0.1.14 добавлена поддержка функций (functions). Данная опция находится на этапе тестирования и пока доступна только для некоторых моделей, а протокол может быть изменен в следующих версиях.

Установка

Библиотеку можно установить с помощью pip:

Работа с GigaChat

Перед использованием модуля:

  1. Подключите проект GigaChat API.

  2. В личном кабинете нажмите кнопку Сгенерировать новый Client Secret.

    Откроется окно Новый Client Secret.

  3. В открывшемся окне, скопируйте и сохраните токен, указанный в поле Авторизационные данные.

    Warning

    Не закрывайте окно, пока не сохраните токен. В противном случае его нужно будет сгенерировать заново.

Пример показывает как импортировать библиотеку в GigaChain и использовать ее для обращения к GigaChat:

Больше примеров.

Способы авторизации

Авторизация с помощью токена (в личном кабинете из поля Авторизационные данные):

Авторизация с помощью логина и пароля:

Взаимная аутентификация по протоколу TLS (mTLS):

Авторизация с помощью временного токена

Дополнительные настройки

Выбор модели

С помощью GigaChain вы можете обращаться к различным моделям, которые предоставляет GigaChat.

Для этого передайте название модели в параметре

model
:

Полный список доступных моделей можно получить с помощью запроса

к GigaChat API.

Warning

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

Подсчет количества токенов

Для подсчета количества токенов в запросах используйте метод

tokens_count(["текст1", "текст2", ...])
.

Метод выполняет запрос

к GigaChat API и возвращает список объектов с информацией о количестве токенов в каждой строке.

Векторное представление текста

Эмбеддинг (англ. embedding) — это вектор, представленный в виде массива чисел, который получается в результате преобразования данных, например, текста. Комбинация этих чисел, составляющих вектор, действует как многомерная карта для измерения сходства.

Для получения эмбеддингов используйте метод

embeddings("текст")
.

Warning

Функция получения эмбеддингов находится на этапе тестирования и может быть недоступна некоторым категориям пользователей.

Отключение проверки сертификатов

Для отключения проверки сертификатов передайте параметр

verify_ssl_certs=False
:

Warning

Отключение проверки сертификатов снижает безопасность обмена данными.

Установка корневого сертификата НУЦ Минцифры:

Для установка корневого сертификата НУЦ Минцифры выполните команду:

Настройки в переменных окружения

Чтобы задать настройки с помощью переменных окружения, используйте префикс

GIGACHAT_
.

Авторизация с помощью токена и отключение проверки сертификатов:

Авторизация с помощью логина и пароля: