Встраивание SDK

​

Что входит в крейт

• Идентификации. Пользователи, API-ключи, организации, команды, права, подписки, лимиты запросов и OAuth issuer принадлежат gproxy-app, который читает ту же устойчивую ревизию из того же пакета.
• Аутентификации нижестоящих клиентов. sdk не решает, кто вызывающий; его права передаются извне.
• Сервера: нет слушающего сокета, маршрутизатора, middleware и CLI.
• Консоли. Крейт генерирует типы TypeScript, по которым пишется UI; сам UI остаётся за приложением.
• Выполнения. Попытки, преобразование, перезапись, наблюдение, бюджеты и расчёт выполняет движок (gproxy-core); sdk решает только, что ему передать.

​

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

[dependencies]
gproxy-sdk = { git = "https://github.com/LeenHawk/gproxy", tag = "v4.0.0" }

​

Сборка дескриптора

use gproxy_sdk::{GproxyBuilder, SyncMode};

let gproxy = GproxyBuilder::sqlite("gproxy.db")
    .await?
    .master_key([0u8; 32])
    .sync_mode(SyncMode::Background)
    .build()
    .await?;

for channel in gproxy.channels() {
    println!("{} ({})", channel.display_name, channel.id);
}
println!("serving revision {}", gproxy.revision().0);

​

Cargo features

​

Вызовы

let execution = gproxy
    .call(
        OperationKey { operation: Operation::GenerateContent, dialect: Dialect::OpenAi },
        request,
    )
    .scope("user:u-1")
    .attribution(UsageAttribution { user_id: Some("u-1".into()), ..Default::default() })
    .budgets(vec![BudgetOwner::new("user", "u-1")])
    .credentials(["cred-1".to_owned()].into())
    .send()
    .await?;

let (response, usage) = execution.into_parts();

• .attribution(...): на кого записывается использование.
• .budgets(...): цепочка владельцев бюджетов, с которых списывается расход.
• .providers(...) и .credentials(...): идентификаторы провайдеров и учётных данных, доступные вызывающему. None означает отсутствие ограничений, пустой набор — что не разрешено ничего.
• .session(...), .session_id(...), .agent_session_id(...): идентификатор сессии для привязки.
• .model(...): имя модели, если его нет в теле запроса.
• .max_attempts(...), .deadline(...), .cancellation(...), .request_id(...).

​

Политика загрузки ресурсов

​

Вход

• Код авторизации: authcode_start возвращает URL для открытия; authcode_complete принимает обратный вызов и создаёт учётные данные.
• Код устройства: device_start возвращает код, который вводит пользователь; device_poll выполняет один опрос и возвращает ответ апстрима, в том числе время ожидания до следующего опроса. sdk не спит и не крутит цикл — частотой опроса управляет вызывающий.

​

Управление

​

Запросы к данным

​

Агрегаты использования

​

Постраничный вывод

​

Маскирование

​

Синхронизация

• reload(): перечитать конфигурацию и опубликовать новый снимок.
• reload_credentials(ids): перечитать только данные учётных данных.
• sync_now(): один опрос ревизии; перезагрузка, если устойчивая ревизия новее.
• drain_notifications(): применить уже пришедшие уведомления, не обращаясь к базе. В SyncMode::Background ничего не делает.
• tick(): drain_notifications(), затем sync_now().

// tick() = drain the delivered notifications, then poll the revision once.
instance.tick().await;

​

Экспорт типов TypeScript

GPROXY_TS_OUT=console/src/generated \
  cargo test -p gproxy-sdk --features ts export_types

​

Слои над sdk