spring-ai-gigachat

Данная библиотека позволяет интегрироваться с GigaChat API с использованием фреймворка Spring AI.

Реализованы:

• Вызов Chat модели, включая:
• • потоковую обработку (streaming)
• • вызов внешних функций, в том числе доп.возможности GigaChat (fewShotExample/returnParameters и т.д.) - подробнее в tools.md
• работу с файлами и изображениями
• Вызов Embedding модели
• Observability

Требования

• Java 17+
• Spring Boot 3.4.x

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

Для работы с библиотекой вам понадобится ключ авторизации API.

Чтобы получить ключ авторизации:

1. Создайте проект GigaChat API в личном кабинете Studio.
2. В интерфейсе проекта, в левой панели выберите раздел Настройки API.
3. Нажмите кнопку Получить ключ.

В открывшемся окне скопируйте и сохраните значение поля Client Secret. Этот ключ отображается только один раз и не хранится в личном кабинете. При компрометации или утере ключа авторизации вы можете сгенерировать его повторно.

1. Подключите в ваш pom.xml зависимость

<dependency>
    <groupId>chat.giga</groupId>
    <artifactId>spring-ai-starter-model-gigachat</artifactId>
    <version>1.0.0</version>
</dependency>

2. Пропишите параметры подключения к GigaChat в application.yml:

spring:
  ai:
    gigachat:
      scope: GIGACHAT_API_PERS             # доступны также GIGACHAT_API_B2B, GIGACHAT_API_CORP
      client-id: <ваш_client_id>           # Можно посмотреть в личном кабинете GigaChat в разделе "Настройки API" в вашем проекте
      client-secret: <ваш_client_secret>   # Ваш Client Secret
      unsafe-ssl: true                     # отключает проверку не рекомендуется использовать в production

3. Создайте Main-класс:

@SpringBootApplication
public class Main {
    public static void main(String[] args) {
        SpringApplication.run(Main.class, args);
    }

    @Bean
    public CommandLineRunner runner(ChatClient.Builder builder) {
        return args -> {
            ChatClient chatClient = builder.build();
            String response = chatClient.prompt("Расскажи шутку").call().content();
            System.out.println(response);
        };
    }
}

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

В application.yml можно задать дефолтные параметры для запроса к API GigaChat, а также параметры для подключения и авторизации.

Описание параметров можно найти в официальной документации.

spring:
  ai:
    gigachat:
      chat:
        options:
          # дефолтные параметры для обращения к API GigaChat.
          model: GigaChat        # GigaChat по дефолту, список доступных моделей - https://developers.sber.ru/docs/ru/gigachat/models
          temperature: 0.5       # null по дефолту
          top-p: 0.5             # null по дефолту
          max-tokens: 200        # null по дефолту
          repetition-penalty: 1  # null по дефолту 
          update-interval: 0     # null по дефолту
      embedding:
        options:
          model: Embeddings      # Embeddings по дефолту
          dimensions: 1024       # null по дефолту, вычисляется при первом обращении к Embedding-модели

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

По Client ID + Client Secret

Пример application.yml для авторизации по Client ID и Client Secret:

spring:
  ai:
    gigachat:
      scope: GIGACHAT_API_PERS
      client-id: <ваш_client_id>             # Можно посмотреть в личном кабинете GigaChat в разделе "Настройки API" в вашем проекте
      client-secret: <ваш_client_secret>     # Можно посмотреть в личном кабинете GigaChat в разделе "Настройки API" в вашем проекте

С помощью TLS-сертификатов

Пример application.yml для подключения к GigaChat :

spring:
  ai:
    gigachat:
      scope: GIGACHAT_API_PERS
      client-key: file:/path/to/tls.key         # Путь до вашего сертификата. Если у вас терминация TLS настроена на Egress-gateway, то можно пропустить этот параметр
      client-certificate: file:/path/to/tls.crt # Путь до вашего сертификата. Если у вас терминация TLS настроена на Egress-gateway, то можно пропустить этот параметр

Примеры

Примеры работы с библиотекой - в отдельном модуле spring-ai-gigachat-example.