Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Добавил JS в корневой README #250

Merged
merged 2 commits into from
Feb 13, 2025
Merged

Добавил JS в корневой README #250

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3492a0f
WIP
Feb 12, 2025
0869ff3
Редактура
Feb 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
149 changes: 130 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,30 +25,29 @@

# О GigaChain

GigaChain – это набор решений для создания приложений с использованием больших языковых моделей (*LLM*), который охватывает все этапы разработки от прототипирования и исследования, до запуска в эксплуатацию и поддержки.
GigaChain – это набор решений для создания приложений с использованием больших языковых моделей (*LLM*). GigaChain охватывает все этапы разработки от прототипирования и исследования, до запуска в эксплуатацию и поддержки.

В состав GigaChain входят две библиотеки для работы с [моделями GigaChat](https://developers.sber.ru/docs/ru/gigachat/models):
В состав GigaChain входят такие библиотеки для работы с [моделями GigaChat](https://developers.sber.ru/docs/ru/gigachat/models), как:

* langchain-gigachat — партнерский пакет LangChain, популярного open source фреймворка для разработки комплексных LLM-приложений. Библиотека позволяет использовать все возможности фреймворка и моделей GigaChat, в том числе создание агентов с помощью [LangGraph](https://langchain-ai.github.io/langgraph/tutorials/introduction/).
* [Официальная документация LangChain](https://python.langchain.com/docs/introduction/).
* [Страница партнерского пакета](https://python.langchain.com/docs/integrations/llms/gigachat/) в официальной документации LangChain.
* gigachat — обертка для [REST API GigaChat](https://developers.sber.ru/docs/ru/gigachat/api/reference/rest/gigachat-api). Библиотека управляет авторизацией запросов, упрощает отправку сообщений в модели GigaChat и предоставляет другие методы для работы с API.

Подробная информация о библиотеке — [в репозитории](https://github.com/ai-forever/gigachat).
langchain-gigachat — партнерский пакет популярного open source фреймворка LangChain для разработки комплексных LLM-приложений. Пакет позволяет использовать все возможности фреймворка и моделей GigaChat, в том числе создание агентов с помощью [LangGraph](https://langchain-ai.github.io/langgraph/tutorials/introduction/). Библиотека langchain-gigachat доступна как для [Python](https://github.com/ai-forever/langchain-gigachat), так и для [JavaScript](https://github.com/ai-forever/langchainjs/tree/main/libs/langchain-gigachat).
* Документация LangChain: [для Python](https://python.langchain.com/docs/introduction/), [для JavaScript](https://js.langchain.com/docs/introduction/?ref=blog.apify.com);
* Страница [партнерского пакета langchain-gigachat для Python](https://python.langchain.com/docs/integrations/llms/gigachat/) в официальной документации LangChain.
* gigachat — обертка для [REST API GigaChat](https://developers.sber.ru/docs/ru/gigachat/api/reference/rest/gigachat-api). Она управляет авторизацией запросов, упрощает отправку сообщений в модели GigaChat и предоставляет другие методы для работы с API. Библиотека доступна как для [Python](https://github.com/ai-forever/gigachat), так и для [JavaScript](https://github.com/ai-forever/gigachat-js).

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

## Требования

Для работы с библиотеками langchain-gigachat и gigachat вам понадобятся:

* Python версии 3.9 и выше;
* Ключ авторизации для работы с API. О том, как получить ключ авторизации — в [документации GigaChat API](https://developers.sber.ru/docs/ru/gigachat/quickstart/ind-using-api#poluchenie-avtorizatsionnyh-dannyh);
* Python версии 3.9 и выше для работы библиотеками Python.
* Node.js версии 16 и выше для работы с библиотеками JavaScript.
* Ключ авторизации для работы с API. О том, как получить ключ авторизации — в [документации GigaChat API](https://developers.sber.ru/docs/ru/gigachat/quickstart/ind-using-api#poluchenie-avtorizatsionnyh-dannyh).
* [Сертификаты НУЦ Минцифры](https://developers.sber.ru/docs/ru/gigachat/certificates).

Если нужно, вы можете отключить проверку сертификатов. Подробнее — в примерах ниже.

## Быстрый старт
## Быстрый старт для Python

### langchain-gigachat

Expand All @@ -58,7 +57,7 @@ GigaChain – это набор решений для создания прил
pip install langchain-gigachat
```

Запустите простой пример:
Запустите пример:

```py
from langchain_core.messages import HumanMessage, SystemMessage
Expand All @@ -81,7 +80,7 @@ while(True):
if user_input == "пока":
break
messages.append(HumanMessage(content=user_input))
res = llm.invoke(messages)
res = giga.invoke(messages)
messages.append(res)
print("GigaChat: ", res.content)
```
Expand All @@ -100,7 +99,7 @@ while(True):
* `streaming` — необязательный параметр, который включает и отключает [потоковую генерацию токенов](https://developers.sber.ru/docs/ru/gigachat/api/response-token-streaming). По умолчанию `False`. Потоковая генерация позволяет повысить отзывчивость интерфейса программы при работе с длинными текстами.

> [!TIP]
> Спросите [чат-бот LangChain](https://chat.langchain.com/), о том, как использовать GigaChat с инструментами фреймворка.
> Спросите [чат-бот LangChain](https://chat.langchain.com/), как использовать GigaChat с инструментами фреймворка.
>
> Исходный код чат-бота — в [репозитории chat-langchain](https://github.com/langchain-ai/chat-langchain).

Expand Down Expand Up @@ -148,12 +147,115 @@ for chunk in GigaChat(credentials="ваш_ключ_авторизации",verif
> [!TIP]
> Больше примеров работы с библиотекой — [в репозитории](https://github.com/ai-forever/gigachat/tree/main/examples).

## Быстрый старт для JavaScript

### langchain-gigachat

Для установки библиотеки используйте менеджер пакетов npm:

```sh
npm install --save langchain-gigachat
```

Запустите простой пример:

```js
import { Agent } from 'node:https';
import { GigaChat } from "langchain-gigachat"
import { HumanMessage, SystemMessage } from "@langchain/core/messages";

const httpsAgent = new Agent({
rejectUnauthorized: false, // Отключение проверки сертификатов НУЦ Минцифры
});

const giga = new GigaChat({
credentials: 'ключ_авторизации',
model: 'GigaChat-Max',
httpsAgent
})

const messages = [
new SystemMessage("Переведи следующее сообщение на английский"),
new HumanMessage("Привет!"),
];

const resp = await giga.invoke(messages);

console.log(resp.choices[0]?.message.content);
```

Объект GigaChat принимает параметры:

* `credentials` — ключ авторизации для обмена сообщениями с GigaChat API. [Подробнее о получении ключа авторизации](https://developers.sber.ru/docs/ru/gigachat/quickstart/ind-using-api#poluchenie-avtorizatsionnyh-dannyh).
* `scope` — необязательный параметр, в котором можно указать версию API. По умолчанию запросы передаются в версию для физических лиц. Возможные значения:

* `GIGACHAT_API_PERS` — версия API для физических лиц;
* `GIGACHAT_API_B2B` — доступ для ИП и юридических лиц [по предоплате](https://developers.sber.ru/docs/ru/gigachat/api/tariffs#platnye-pakety2);
* `GIGACHAT_API_CORP` — доступ для ИП и юридических лиц [по схеме pay-as-you-go](https://developers.sber.ru/docs/ru/gigachat/api/tariffs#oplata-pay-as-you-go).

* `model` — необязательный параметр, в котором можно задать [модель GigaChat](https://developers.sber.ru/docs/ru/gigachat/models). По умолчанию запросы передаются в модель GigaChat Lite (`model="GigaChat"`).
* `httpsAgent` — необязательный параметр, который позволяет задать настройки HTTPS. Эти настройки будут использованы при подключении к серверу API. Вы можете использовать их для отключения проверки [сертификатов НУЦ Минцифры](/https://developers.sber.ru/docs/ru/gigachat/certificates).

### gigachat

Для установки библиотеки используйте менеджер пакетов npm:

```sh
npm install gigachat
```

Вызовите подходящий метод для запроса в API:

```js
import GigaChat from 'gigachat';
import { Agent } from 'node:https';

const httpsAgent = new Agent({
rejectUnauthorized: false, // Отключение проверки сертификатов НУЦ Минцифры
});

const giga = new GigaChat({
model: 'GigaChat',
credentials: 'ключ_авторизации',
httpsAgent: httpsAgent,
});

giga
.chat({
messages: [{ role: 'user', content: 'Привет, как дела?' }],
})
.then((resp) => {
console.log(resp.choices[0]?.message.content);
});
```

Объект GigaChat принимает параметры:

* `credentials` — ключ авторизации для обмена сообщениями с GigaChat API. [Подробнее о получении ключа авторизации](https://developers.sber.ru/docs/ru/gigachat/quickstart/ind-using-api#poluchenie-avtorizatsionnyh-dannyh).
* `model` — необязательный параметр, в котором можно явно задать [модель GigaChat](https://developers.sber.ru/docs/ru/gigachat/models). По умолчанию запросы передаются в модель GigaChat Lite (значение поля `GigaChat`).
* `scope` — необязательный параметр, в котором можно указать версию API. Возможные значения:

* `GIGACHAT_API_PERS` — версия API для физических лиц;
* `GIGACHAT_API_B2B` — доступ для ИП и юридических лиц [по предоплате](https://developers.sber.ru/docs/ru/gigachat/api/tariffs#platnye-pakety2);
* `GIGACHAT_API_CORP` — доступ для ИП и юридических лиц [по схеме pay-as-you-go](https://developers.sber.ru/docs/ru/gigachat/api/tariffs#oplata-pay-as-you-go).

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

Настройки HTTPS, которые добавляются при подключении к серверу API

* `httpsAgent` — необязательный параметр, который позволяет задать настройки HTTPS. Эти настройки будут использованы при подключении к серверу API. Вы можете использовать их для отключения проверки [сертификатов НУЦ Минцифры](/https://developers.sber.ru/docs/ru/gigachat/certificates).

> [!TIP]
> Больше примеров работы с библиотекой — [в репозитории](https://github.com/ai-forever/gigachat-js/tree/master/examples).

## Примеры

При запуске примеров могут возникать проблемы связанные с особенностями локального окружения Python.
Чтобы их избежать используйте чистое виртуальное окружение.
Ниже представлен список интерактивных примеров для Python и JavaScript в формате Jupyter-блокнотов.

Список интерактивных примеров в формате блокнотов Jupyter:
### Python

При запуске примеров могут возникать проблемы, связанные с особенностями локального окружения Python.
Чтобы их избежать, используйте чистое виртуальное окружение.

* Retrieval-Augmented Generation (RAG):
* [Ответы на вопросы по заданной книге](/docs/docs_ru/cookbook/gigachat_qa.ipynb)
Expand All @@ -171,10 +273,19 @@ for chunk in GigaChat(credentials="ваш_ключ_авторизации",verif
* [Генерация структурированных данных на основе изображений](/cookbook/gigachat_vision/gigachat_vision.ipynb)
* [Получение изображений и видео после генерации](/cookbook/images_and_videos/gigachat_with_images.ipynb)

### JavaScript

* [Retrieval-Augmented Generation (RAG)](/cookbook/js/rag.ipynb)
* [Работа с функциями](/cookbook/js/tools.ipynb)
* [Выделение сущностей в тексте](/cookbook/js/extraction.ipynb)
* [Пример разработки агента на основе LangGraph.js и GigaChat API](/cookbook/js/langgraph_quickstart.ipynb)

## Смотрите также

* Документация GigaChat API:
* [Быстрый страт для физических лиц](https://developers.sber.ru/docs/ru/gigachat/individuals-quickstart)
* [Быстрый страт для ИП и юридических лиц](https://developers.sber.ru/docs/ru/gigachat/legal-quickstart)
* [Документация LangChain](https://python.langchain.com/docs/introduction/)
* [Документация LangGraph](https://langchain-ai.github.io/langgraph/tutorials/introduction/)
* Документация LangChain:
* [для Python](https://python.langchain.com/docs/introduction/);
* [для JavaScript](https://js.langchain.com/docs/introduction/?ref=blog.apify.com);
* [Документация LangGraph](https://langchain-ai.github.io/langgraph/tutorials/introduction/).