gigachat-rust 0.1.0-alpha.0

Unofficial Rust SDK for Gigachat API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

# GigaChat Rust SDK

[![Crates.io](https://img.shields.io/crates/v/gigachat-rust)](https://crates.io/crates/gigachat-rust)
[![Documentation](https://docs.rs/gigachat-rust/badge.svg)](https://docs.rs/gigachat-rust)
[![License](https://img.shields.io/crates/l/gigachat-rust)](https://github.com/nikitapatsakula/gigachat-rust/blob/main/LICENSE)

Rust SDK для работы с GigaChat API от Сбера - доступ к русскоязычным LLM.

## Возможности

- **Поддержка Sber API**:
  - [x] Генерация текста.
    - [x] Синхронная.
    - [x] Потоковая.
  - [x] Генерация эмбеддингов.
  - [x] Детекция LLM-сгенерированного текста.
  - [ ] Пакетная обработка.
  - [ ] Обработка медиа.
  - [ ] Поддержка функций.
- **Конфигурация клиента**:
  - [x] Автоматическое использование сертификатов мин.цифры.
  - [x] Возможности для конфигурации корпоративного прокси-сервера.
  - [x] OAuth авторизация с автоматической ротацией токенов.
- **Средства интроспекции**:
  - [ ] Поддержка сквозной трассировки при помощи `tracing`.
  - [ ] Поддержка перехвата HTTP запросов.

## Getting started

Добавьте в ваш `Cargo.toml`:

```toml
[dependencies]
gigachat-rust = "0.1.0"
tokio = { version = "1", features = ["full"] }
```

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

### Аутентификация

Для использования GigaChat API вам необходимо получить токен аутентификации от Сбера. Установите его как переменную окружения:

```bash
export GIGACHAT_TOKEN="ваш-токен"
```

## Примеры использования

Вместо встраивания примеров кода в README, мы предоставляем подробные рабочие примеры в директории [examples](./examples/):

| Пример | Описание | Файл |
|--------|----------|------|
| [Генерация текста](./examples/generate.rs) | Демонстрирует генерацию текста с помощью GigaChat | [generate.rs](./examples/generate.rs) |
| [Текстовые эмбеддинги](./examples/embeddings.rs) | Пример создания векторных представлений текста | [embeddings.rs](./examples/embeddings.rs) |

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

### Опции Client Builder

`GigaChatClientBuilder` позволяет настраивать клиент:

```rust
use gigachat_rust::client::GigaChatClientBuilder;
use reqwest::Proxy;

let client = GigaChatClientBuilder::new(token)
    // Настройка URL аутентификации при необходимости
    // .auth_url("https://ваш-auth-url.com")
    // Настройка базового URL при необходимости
    // .base_url("https://ваш-base-url.com")
    // Настройка прокси при необходимости
    // .proxy(Proxy::http("http://proxy:8080").unwrap())
    // Добавление заголовков по умолчанию
    // .default_header("X-Custom-Header", "custom-value")
    .build()
    .await?;
```

## Обработка ошибок

Все вызовы API возвращают тип `Result`, что делает обработку ошибок прямолинейной:

```rust
use anyhow::Result;

async fn example() -> Result<()> {
    let token = std::env::var("GIGACHAT_TOKEN")?;
    let client = GigaChatClientBuilder::new(token).build().await?;

    let response = match client
        .generate()
        .messages(vec![Message::user("Привет, мир!")])
        .execute()
        .await
        .context("Failed to generate response")?;

    println!("Успех: {response:?}");

    Ok(())
}
```

Типичные ошибки:
- Сетевые ошибки (проблемы с подключением, таймауты)
- Ошибки аутентификации (недействительные токены)
- Ошибки API (ограничение скорости, недостаточно прав)
- Ошибки парсинга (неожиданные форматы ответов)

## Лицензия

Этот проект лицензирован по лицензии MIT - смотрите файл [LICENSE](LICENSE) для подробностей.