Skip to main content

CliModelRegistry

Struct CliModelRegistry 

Source
pub struct CliModelRegistry { /* private fields */ }
Expand description

CLI-specific model registry with auth storage integration.

This extends the base model data from oxi_ai::model_db with:

  • API key resolution via AuthStorage
  • models.json file parsing
  • OAuth token detection
  • Available model filtering (only models with configured auth)

For SDK usage without CLI-specific features, use oxi_ai::ModelRegistry instead.

Implementations§

Source§

impl CliModelRegistry

Source

pub fn create( auth_storage: AuthStorage, models_json_path: Option<PathBuf>, ) -> CliModelRegistry

Create a new ModelRegistry that loads models from the given path.

If models_json_path is None, falls back to $HOME/.oxi/models.json (or the XDG config dir equivalent).

Source

pub fn in_memory(auth_storage: AuthStorage) -> CliModelRegistry

Create an in-memory registry (no models.json loading).

Source

pub fn refresh(&self)

Reload models from disk (built-in + custom from models.json).

Source

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

Get any error from loading models.json.

Source

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

Get all models (built-in + custom).

Source

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

Get only models that have auth configured.

Source

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

Find a model by provider and ID.

Source

pub fn resolve_model(&self, model_str: &str) -> Option<Model>

Resolve a model string (e.g. "anthropic/claude-sonnet-4-20250514") into a Model object.

Supports:

  • "provider/model-id"
  • "model-id" (searches all providers)
Source

pub fn has_configured_auth(&self, model: &Model) -> bool

Check if a model has auth configured.

Source

pub fn get_api_key_and_headers(&self, model: &Model) -> ResolvedRequestAuth

Get API key and request headers for a model.

Source

pub fn is_using_oauth(&self, model: &Model) -> bool

Check if a model is using OAuth credentials.

Source

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

Get display name for a provider.

Returns a static string for known providers, or the raw provider string.

Source

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

Get the display name for a provider, allocating if necessary for dynamically registered names.

Source

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

Return auth status for a provider, including request auth configured in models.json.

Source

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

Get API key for a provider.

Source

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

Get all unique providers from loaded models.

Source

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

Get all providers that have credentials configured.

Source

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

Get all models that have credentials configured.

Source

pub fn get_default_model(&self) -> Option<Model>

Get the user’s default model.

Returns the first available model, preferring:

  1. Anthropic Claude Sonnet 4
  2. OpenAI GPT-4o
  3. Any available model
Source

pub fn register_provider( &self, provider_name: &str, config: ProviderConfigInput, )

Register a provider dynamically (from extensions).

Source

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

Unregister a previously registered provider.

Source

pub fn filter_by_provider(&self, provider: &str) -> Vec<Model>

Filter models by provider.

Source

pub fn filter_by_capability(&self, reasoning: bool) -> Vec<Model>

Filter models by capability (reasoning).

Source

pub fn filter_by_modality(&self, modality: InputModality) -> Vec<Model>

Filter models by input modality (e.g., vision/image support).

Source

pub fn search(&self, pattern: &str) -> Vec<Model>

Search models by pattern (case-insensitive substring match on id or name).

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> GetSetFdFlags for T

Source§

fn get_fd_flags(&self) -> Result<FdFlags, Error>
where T: AsFilelike,

Query the “status” flags for the self file descriptor.
Source§

fn new_set_fd_flags(&self, fd_flags: FdFlags) -> Result<SetFdFlags<T>, Error>
where T: AsFilelike,

Create a new SetFdFlags value for use with set_fd_flags. Read more
Source§

fn set_fd_flags(&mut self, set_fd_flags: SetFdFlags<T>) -> Result<(), Error>
where T: AsFilelike,

Set the “status” flags for the self file descriptor. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Pointee for T

Source§

type Pointer = u32

Source§

fn debug( pointer: <T as Pointee>::Pointer, f: &mut Formatter<'_>, ) -> Result<(), Error>

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more