oino-models 1.0.1

Model registry for Oino: models.json, model resolution, auth storage, virtual models
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

//! `oino-models`: the model registry, `models.json`, model resolution, `auth.json`
//! storage and virtual models for Oino.
//!
//! Providers are WASM components: this crate never streams. It stores provider
//! *registrations* (extension-api §4.4) and their models, merges `models.json` and config
//! overrides in a fixed order, resolves credentials per request (core passes them to the
//! component as `StreamOptions.apiKey`/`headers`) and resolves `--model`/`--models`/defaults.
//! It has no async runtime; OAuth refresh is an injected [`OAuthRefresher`] future.
//!
//! # API map
//!
//! | Item | Purpose |
//! |---|---|
//! | [`ModelRegistry`] | shared catalog + auth (`Arc<RwLock>`) |
//! | [`ProviderRegistration`], [`ProviderConfigOverride`] | provider data |
//! | [`ModelsJson`] | `models.json` load with diagnostics |
//! | [`AuthStorage`], [`AuthCredential`] | `auth.json` with locking, runtime keys |
//! | [`auth::oauth`] | OAuth expiry + locked refresh |
//! | [`config_value`] | `literal \| $ENV \| ${ENV} \| !command` |
//! | [`resolver`] | `--model`, scopes, initial model, restore, cycling |
//! | [`virtual_models`] | definitions, route wire types, validation, branch state |
//! | [`auth_check`] | `oino auth check` (exit 0/1/2) |
//! | [`ModelCache`] | `<agent>/cache/models/<provider>.json` |
//! | [`auth::guidance`] | "No API key found …" texts |
//!
//! # Behaviour notes
//!
//! - No built-in catalog: models come from registrations (static or `list-models`) and
//!   `models.json`. A model is *available* only when its provider has credentials **and** a loaded
//!   component implements its API ([`ModelRegistry::diagnostics`] lists the others).
//! - Config overrides keep the provider component's registration.
//! - Registration `authHeader` is informational; `Authorization: Bearer` is injected only for
//!   `models.json`/override `authHeader: true`.
//! - Credential order: `--api-key` > `auth.json` > `models.json`/override
//!   `apiKey` > registration `authEnv` (runtime.md §13 lists env before `apiKey`).
//! - `models.json` `compat` is only checked for being an object; JSON syntax errors use
//!   `serde_json` wording; `oauth: "radius"` validates but has no flow in core.
//! - Virtual router state equal to the current state is not re-stored (no object identity
//!   across WASM).

#![forbid(unsafe_code)]
#![cfg_attr(
    test,
    allow(
        clippy::unwrap_used,
        clippy::expect_used,
        clippy::panic,
        reason = "tests assert by unwrapping"
    )
)]

pub mod auth;
pub mod auth_check;
mod cache;
mod collate;
mod compose;
pub mod config_value;
pub mod env;
mod glob;
mod json_text;
mod models_json;
mod registration;
mod registry;
pub mod resolver;
mod schema;
pub mod virtual_models;

pub use auth::credential::{
    ApiKeyCredential, AuthCredential, CredentialInfo, CredentialType, OAuthCredential,
};
pub use auth::oauth::{OAuthError, OAuthRefresher};
pub use auth::storage::{AuthStorage, AuthStorageError};
pub use cache::{CacheError, CachedModels, ModelCache};
pub use config_value::{ConfigValueError, resolve_config_value};
pub use env::{EnvSource, MapEnv, ProcessEnv};
pub use models_json::{
    ModelsJson, ModelsJsonModel, ModelsJsonModelOverride, ModelsJsonProvider, PartialCost,
    SamplingByLevel,
};
pub use registration::{
    AuthHeaderMode, ProviderConfigOverride, ProviderModelConfig, ProviderModels,
    ProviderRegistration,
};
pub use registry::{
    ApiKeyError, AuthCheck, AuthOverrides, AuthResolveError, AuthStatus, AuthStatusSource,
    ModelRegistry, ModelRegistryOptions, RegistryDiagnostic, RegistryError, RequestAuth,
    RequestAuthError, ResolvedAuth,
};
pub use virtual_models::{
    RouteReason, RouteRequest, RouteResult, VIRTUAL_MODEL_API, VirtualModelDefinition,
    VirtualModelRegistry,
};