Struct ModelRegistry 

pub struct ModelRegistry { /* private fields */ }

The shared model registry (see module docs).

Implementations

impl ModelRegistry

pub fn new(auth: Arc<AuthStorage>, options: ModelRegistryOptions) -> Self

Creates a registry and loads models.json.

pub fn in_memory(env: Arc<dyn EnvSource>) -> Self

In-memory credentials, no models.json, no cache, the given environment.

pub fn auth_storage(&self) -> &Arc<AuthStorage>

The credential store.

pub fn set_oauth_refresher(&self, refresher: Arc<dyn OAuthRefresher>)

Installs the OAuth refresher (the host’s bridge to oauth-refresh exports).

pub fn refresh(&self)

Reloads models.json and recomposes the catalog.

pub fn set_models_json(&self, models_json: ModelsJson)

Replaces the models.json configuration without touching the file (tests, embedders).

pub fn error(&self) -> Option<String>

models.json load error and per-provider composition errors, joined by blank lines.

pub fn diagnostics(&self) -> Vec<RegistryDiagnostic>

Oino diagnostics: models whose API no loaded provider component implements (these models are never available).

pub fn register_provider( &self, extension_id: &str, registration: ProviderRegistration, ) -> Result<(), RegistryError>

Registers (or replaces) a provider component’s registration registerNativeProvider). A dynamic registration starts from the cached model list.

Errors

RegistryError::EmptyProviderId.

pub fn register_api_implementor(&self, api: &str, extension_id: &str)

Declares that extension_id’s component implements api (manifest provides.apis). models.json providers using api stream through it.

pub fn set_provider_models( &self, provider: &str, models: &[Model], ) -> Result<(), RegistryError>

Sets a dynamic provider’s models (after list-models) and writes the cache.

Errors

Unknown or static provider; cache write failures (models are applied regardless).

pub fn register_provider_config( &self, provider: &str, config: ProviderConfigOverride, ) -> Result<(), RegistryError>

Validates the override on its own, then merges its defined fields over the previous override. The provider’s registration is kept.

Errors

RegistryError::InvalidConfig with the composition message; nothing is stored.

pub fn unregister_provider(&self, provider: &str)

Removes the registration and the config override (virtual models stay).

pub fn unregister_extension(&self, extension_id: &str)

Removes everything extension_id registered (providers, API implementations, virtual models), e.g. when the extension unloads.

pub fn registered_providers(&self) -> Vec<String>

Providers with an override or a component registration.

pub fn registration(&self, provider: &str) -> Option<ProviderRegistration>

A component registration.

pub fn registered_provider_config( &self, provider: &str, ) -> Option<ProviderConfigOverride>

Returns the registered provider config.

pub fn all(&self) -> Vec<Model>

Every model, providers in registration order.

pub fn available(&self) -> Vec<Model>

Models whose provider has credentials and whose API a provider component implements (virtual models: provider credentials only).

pub fn find(&self, provider: &str, id: &str) -> Option<Model>

F i n d.

pub fn find_physical(&self, provider: &str, id: &str) -> Option<Model>

A catalog model that is not virtual.

pub fn provider_ids(&self) -> Vec<String>

Provider ids of the catalog in order.

pub fn provider_display_name(&self, provider: &str) -> String

Returns the provider display name.

pub fn route_target(&self, model: &Model) -> Option<String>

The extension whose component streams model (None: no implementation loaded).

pub fn check_auth(&self, provider: &str) -> Option<AuthCheck>

How a provider is authenticated, None when it is not.

pub fn has_configured_auth(&self, provider: &str) -> bool

Returns whether configured auth is present.

pub fn is_using_oauth(&self, provider: &str) -> bool

Returns whether it is using oauth.

pub fn auth_status(&self, provider: &str) -> AuthStatus

Returns the provider auth status.

pub fn set_runtime_api_key(&self, provider: &str, key: impl Into<String>)

Sets the runtime API key (--api-key).

pub fn remove_runtime_api_key(&self, provider: &str)

R e m o v e R u n t i m e A p i K e y.

pub async fn get_auth( &self, provider: &str, overrides: &AuthOverrides, ) -> Result<Option<ResolvedAuth>, AuthResolveError>

Resolved credentials (refreshing OAuth tokens as needed).

Errors

AuthResolveError when a configured credential cannot be resolved.

pub async fn get_api_key(&self, provider: &str) -> Option<String>

The key, or None when unconfigured or failing.

pub async fn get_api_key_and_headers( &self, model: &Model, overrides: &AuthOverrides, ) -> Result<RequestAuth, RequestAuthError>

What core passes to the provider component as StreamOptions.apiKey + headers.

Errors

RequestAuthError with the message.

pub fn register_virtual_model( &self, extension_id: &str, definition: VirtualModelDefinition, ) -> Result<(), RegistryError>

Registers or replaces a virtual model.

Errors

Empty ids or a physical model with the same id.

pub fn unregister_virtual_model(&self, provider: &str, id: &str)

U n r e g i s t e r V i r t u a l M o d e l.

pub fn virtual_model( &self, provider: &str, id: &str, ) -> Option<RegisteredVirtualModel>

A registered virtual model (definition + owning extension).

pub fn route_request( &self, model: &Model, messages: Vec<Message>, reason: RouteReason, thinking_level: ThinkingLevel, failed: Option<AssistantMessage>, state: Option<JsonValue>, ) -> Result<RouteRequest, RouteError>

Builds the route request for a virtual model (before the router call): previous from the latest successful response in messages, failed from a retry.

Errors

RouteError::NotRegistered.

pub fn validate_route( &self, model: &Model, result: RouteResult, ) -> Result<ModelRoute, RouteError>

Validates a router result (after the call): the target must be a physical catalog model with credentials; the level is clamped to it.

Errors

RouteError::NotPhysical / RouteError::NoCredentials.

Trait Implementations

impl Clone for ModelRegistry

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ModelRegistry

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl ModelCatalog for ModelRegistry

fn all(&self) -> Vec<Model>

Every model.

fn available(&self) -> Vec<Model>

Models with usable credentials.

fn find(&self, provider: &str, id: &str) -> Option<Model>

A model by provider and id.

fn has_configured_auth(&self, provider: &str) -> bool

Whether the provider has usable credentials.