Struct ConnectOptions 

#[non_exhaustive]
pub struct ConnectOptions { /* private fields */ }

How Catalog::connect_with connects: an explicit key and the account it belongs to, an HTTP client, a protocol family and a base URL. Each one left unset takes its default: the key from the environment, the shared reqwest client, the family the catalog row is reached by, and the dialect’s base URL.

use rig_core::catalog::Catalog;
use rig_core::providers::registry::{ConnectOptions, Format};

let options = ConnectOptions::new().format(Format::Anthropic);
let model = Catalog::builtin().connect_with("zai/glm-5", options)?;

Implementations

impl ConnectOptions

pub fn new() -> Self

No option set.

pub fn api_key(self, api_key: impl Into<Secret>) -> Self

Credential with api_key instead of reading the environment. Only the key is given: no other variable is read either.

pub fn account_id(self, account_id: impl Into<String>) -> Self

Name account_id as the account the key belongs to, as a ChatGPT subscription credential needs (the ChatGPT-Account-Id header). Only the OpenAI family sends it; the others ignore it.

use rig_core::catalog::Catalog;
use rig_core::providers::registry::ConnectOptions;

let options = ConnectOptions::new().api_key("access-token").account_id("account");
let model = Catalog::builtin().connect_with("chatgpt/gpt-5.5", options)?;

pub fn http(self, http: impl HttpClientExt + 'static) -> Self

Send through http instead of the shared reqwest client.

pub fn format(self, format: Format) -> Self

Speak format instead of the family the catalog row is reached by. The vendor must be registered for it.

pub fn base_url(self, base_url: impl Into<String>) -> Self

Send to base_url, such as a proxy, instead of the dialect’s.

Trait Implementations

impl Clone for ConnectOptions

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 ConnectOptions

Never shows the key.

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

Formats the value using the given formatter.

impl Default for ConnectOptions

fn default() -> Self

Returns the “default value” for a type.

impl Provide for ConnectOptions

The vendor’s models connect as Catalog::connect_with connects them with these options, on their HTTP client, else the shared one, wrapped by the transport.

fn handler( &self, spec: &ModelSpec, catalog: &Catalog, transport: &Transport, ) -> Result<ErasedHandler, ConnectError>

The handler serving spec, a model of catalog. A handler that sends HTTP sends through transport: its shared client, or a client of its own that it wraps.