gigachat-node v2.1.2

GigaChat API Library

Эта библиотека обеспечивает удобный доступ к GigaChat REST API из TypeScript или JavaScript.

Чтобы узнать, как использовать GigaChat API, ознакомьтесь с документацией по API.

• Установка
• Импорт
• Начало работы
• Получение всех моделей
• Описание модели
• Завершение чата
• Завершение чата в потоке
• Генерация изображений
• Векторное представление текста
• Подсчет кол-ва токенов
• Примеры работы
• Отключение цензуры

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

Установка

npm i gigachat-node

Импорт

Первый вариант импорта:

import { GigaChat } from 'gigachat-node';

Второй вариант импорта:

const GigaChat = require('gigachat-node').GigaChat;

Начало работы

Создание экземпляра класса и получение токена доступа к API (подробнее в документации). Обратите внимание, что при получении CLIENT_SECRET необходимо копировать значение в Base64, иначе придется переводить самостоятельно ключ в Base64.

const client = new GigaChat(
    clientSecretKey='CLIENT-SECRET-KEY', 
    isIgnoreTSL=true,
    isPersonal=true,
    autoRefreshToken=true
);
await client.createToken();

Получение всех моделей

Возвращает массив объектов с данными доступных моделей.

const responce = await client.allModels();

Описание модели

Возвращает объект с описанием указанной модели. Аргументом функции следует передать название модели.

const responce = await client.model('GigaChat:latest');

Завершение чата

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

const responce = await client.completion({
    "model":"GigaChat:latest",
    "messages": [
        {
            role:"user",
            content:"Привет! Как дела?"
        }
    ]
});

console.log(responce.choices[0].message);

Завершение чата в потоке

Возвращает ответ модели в потоке в base64. Подробнее можно прочитать в оффициальной документации.

const stream = await client.completionStream({
    "model":"GigaChat:latest",
    "messages": [
        {
            role:"user",
            content:"Привет! Напиши текст на 2000 слов про историю часов."
        }
    ]
});

let str = '';

stream.on('data', async (data) => {
    const decodedData = await data.toString('utf-8');
    const jsonData = await JSON.parse(decodedData.substring(6));
    str += jsonData.choices[0].delta.content;
})

stream.on('end', () => {
    console.log('Поток завершился.')
})

Генерация изображений

При соответствующих настройках конструктора, можно генерировать изображения прямо из завершений чата. Необходимо указать путь до папки, куда будут сохраняться изображения. GigaChat API предоставляет изображения в бинарном виде, однако, если Вы пользуетесь данной библиотекой, то она заботится о преобразовании бинарного представления в JPG, а путь до сгенерированной картинки вернется вместе с завершением чата в объекте responce.choices0.message.

const responce = await client.completion({
    "model":"GigaChat:latest",
    "messages": [
        {
            role:"user",
            content:"Нарисуй солнечное небо."
        }
    ]
});

console.log(responce.choices[0].message.image);

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

Возвращает векторные представления соответствующих текстовых запросов. Подробнее в документации API.

const embed = await client.embedding(["Как дела?", "Векторное представлеие? 0_0"]);
console.log(embed.data);

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

Возвращает объект с информацией о количестве токенов, посчитанных заданной моделью. Подробнее в документации API.

const sum = await client.summarize("GigaChat:latest", ["Подсчитай кол-во токенов в этой строке"]);
console.log(sum[0].tokens);

Примеры работы

• Телеграм-бот с GigaChat API

Отключение цензуры

Отключение цензуры доступно только в том случае, если Вы пользуетесь GigaChat, как юридическое лицо. Далее следующий алгоритм:

1. Необходимо написать запрос на почту gigachat@sberbank.ru с указанием id пространства и client id, который дается при получении ключа.
2. После одобрения запроса, необходимо добавить свойство объекта profanity_check со значением false в запросе на завершение чата.

RoadMap