Struct ProviderId 

pub struct ProviderId(/* private fields */);

Validated vendor and protocol-family pair from this build’s dialect tables, a catalog-only provider the registry cannot configure, or a vendor declared at run time (Self::declare). Construction and deserialization reject unregistered pairs; only ProviderId::catalog, ProviderId::declare and the model catalog produce a catalog-only or declared id, which has no format and no preset. Equality and hashing use the pair, not dialect options; display emits vendor/format, or the vendor alone for a catalog-only or declared id.

Implementations

impl ProviderId

pub fn all() -> impl Iterator<Item = ProviderId>

Every selection this build registers: one per OpenAI-shaped dialect, one per Messages-format dialect, and Gemini. Catalog-only providers are not selections.

pub fn new(vendor: &str, format: Format) -> Option<Self>

The selection vendor names in format, or None when this build registers no such pair.

pub fn catalog(vendor: &str) -> Option<Self>

The id the model catalog files vendor’s models under: its primary selection, or a catalog-only id for a provider the registry cannot configure (aws_bedrock, vertexai, gemini-grpc, candle, voyageai). None for a vendor this build does not know.

A vendor registered in one family has that family as its primary. The vendors registered in two declare theirs: Anthropic’s for minimax, OpenAI’s for zai, moonshot and xiaomimimo. A model reference that names no family is reached by its catalog row’s, which is the primary unless the row says otherwise.

pub fn declare(vendor: &str) -> Result<Self, SelectionError>

Declare vendor, a provider this build has no preset for, such as a company gateway (corp) or a local server under a name of its own, and return the id the catalog files its models under. From then on Self::catalog finds it, so corp/big resolves, parses and reads back like a built-in reference once the catalog lists the model (Catalog::insert). The registry cannot configure it: whoever declares it says how its models are reached, such as with Connector::provide or by building a ProviderConfig from a dialect of its own.

Declaring is idempotent and process-wide. A vendor this build already knows comes back as Self::catalog gives it.

use rig_core::catalog::{Catalog, ModelSpec};
use rig_core::providers::registry::ProviderId;

let corp = ProviderId::declare("corp")?;
let mut catalog = Catalog::builtin().clone();
catalog.insert(ModelSpec::new(corp, "big").with_tools(true));
assert_eq!(catalog.resolve("corp/big").map_err(|e| e.to_string())?.spec.provider, corp);
assert_eq!(ProviderId::declare("anthropic")?, ProviderId::catalog("anthropic").ok_or("known")?);

Errors

SelectionError::Malformed for an empty name, or one with a / or whitespace, which a vendor/model reference could not spell.

pub fn vendor(&self) -> &'static str

The vendor, spelled as the provider’s own descriptor name.

pub fn format(&self) -> Option<Format>

The protocol family, or None for a catalog-only or declared provider.

pub fn is_registered(&self) -> bool

Whether the registry can configure this provider. A catalog-only provider is served by its companion crate instead, and a declared one by whoever declared it.

pub fn is_declared(&self) -> bool

Whether this is a vendor declared at run time (Self::declare).

pub fn vendor_selections(vendor: &str) -> impl Iterator<Item = ProviderId> + '_

Every selection registered for vendor, in registration order.

pub fn resolve(selection: &str) -> Result<Self, SelectionError>

Resolve vendor or vendor/format.

A bare vendor is accepted only when this build registers exactly one family for it; otherwise the error names the qualified alternatives, each of which this resolver accepts. A catalog-only provider is not a selection, so it does not resolve.

pub fn config(&self, api_key: impl Into<Secret>) -> Option<ProviderConfig>

Build this selection’s preset with api_key, or None for a catalog-only or declared provider. Copilot requires an exchanged session token, not a GitHub OAuth token.

pub fn api_key_envs(&self) -> Vec<&'static str>

The environment variables tried for the key, in order: the dialect’s own, then its alternative credential’s (Azure’s AZURE_TOKEN). An empty value counts as unset. Empty for a catalog-only provider, whose companion crate reads its own credentials, and for a declared one.

pub fn requires_credential(&self) -> bool

Whether this selection needs a credential at all. false for a declared provider: whoever reaches it holds what it needs.

A local llama-server authenticates optionally, so naming its variable is a hint rather than a requirement.

Trait Implementations

impl Clone for ProviderId

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ProviderId

impl Debug for ProviderId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProviderId

Reads a selection as ProviderId::resolve does, and a catalog-only or declared provider by its vendor name, so a catalog id reads back. A declared vendor reads back only once this process declared it.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for ProviderId

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

Formats the value using the given formatter.

impl Eq for ProviderId

impl Hash for ProviderId

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ProviderId

Identity is the (vendor, format) pair, never the dialect’s payload: two ids that name the same selection are the same id.

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ProviderId

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.