Struct OpenAICompatibleConfig 

pub struct OpenAICompatibleConfig {
    pub api_key: Option<String>,
    pub base_url: String,
    pub model: String,
    pub temperature: Option<f32>,
    pub max_tokens: Option<usize>,
    pub top_p: Option<f32>,
    pub extra_headers: Vec<(String, String)>,
    /* private fields */
}

Configuration for a generic OpenAI-compatible chat endpoint.

Construct either explicitly for a private/self-hosted endpoint (OpenAICompatibleConfig::new, keyless by default — opt in with with_api_key), or through a hosted preset (groq / openrouter / xai).

Fields

api_key: Option<String>

Bearer token. None sends no Authorization header at all (keyless local servers).

base_url: String

Base URL ending at the /v1-style root; /chat/completions is appended.

model: String

Free-form model id served by the endpoint.

temperature: Option<f32>

Sampling temperature.

max_tokens: Option<usize>

Maximum number of tokens to generate.

top_p: Option<f32>

Nucleus sampling probability mass.

extra_headers: Vec<(String, String)>

Additional HTTP headers on every request (tenant headers, attribution).

Implementations

impl OpenAICompatibleConfig

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

Config for a custom (often self-hosted/private) endpoint.

Keyless by default — many local servers ignore auth, and no Authorization header is sent until with_api_key is called.

pub fn groq(api_key: impl Into<String>, model: impl Into<String>) -> Self

Groq preset: https://api.groq.com/openai/v1.

pub fn openrouter(api_key: impl Into<String>, model: impl Into<String>) -> Self

OpenRouter preset: https://openrouter.ai/api/v1.

model is a vendor-qualified id such as "anthropic/claude-sonnet-4-5" or "openai/gpt-5".

pub fn xai(api_key: impl Into<String>, model: impl Into<String>) -> Self

xAI (Grok) preset: https://api.x.ai/v1.

pub fn from_env_result() -> Result<Self, ProviderError>

Generic config from environment variables.

• OPENAI_COMPATIBLE_BASE_URL (required)
• OPENAI_COMPATIBLE_MODEL (required)
• OPENAI_COMPATIBLE_API_KEY (optional; unset ⇒ keyless local endpoint)

pub fn groq_from_env() -> Result<Self, ProviderError>

Groq preset from GROQ_API_KEY (+ optional GROQ_MODEL, GROQ_BASE_URL).

pub fn openrouter_from_env() -> Result<Self, ProviderError>

OpenRouter preset from OPENROUTER_API_KEY + OPENROUTER_MODEL.

Optional attribution: OPENROUTER_SITE_URL, OPENROUTER_SITE_NAME.

pub fn xai_from_env() -> Result<Self, ProviderError>

xAI preset from XAI_API_KEY (+ optional XAI_MODEL, XAI_BASE_URL).

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

Sets the bearer token (enables the Authorization header).

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

Overrides the base URL (preset users can point at a mirror/gateway).

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

Sets the model id.

pub fn with_temperature(self, temp: f32) -> Self

Sets the temperature parameter.

pub fn with_max_tokens(self, max: usize) -> Self

Sets the max tokens limit.

pub fn with_top_p(self, top_p: f32) -> Self

Sets the top_p parameter.

pub fn with_extra_header( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Appends one extra HTTP header sent on every request.

pub fn with_openrouter_attribution( self, site_url: impl Into<String>, site_name: impl Into<String>, ) -> Self

OpenRouter attribution headers (HTTP-Referer, X-Title) shown on the router’s analytics/leaderboard for this app.

pub fn provider(&self) -> &str

Endpoint label used in error messages.

pub fn base_url(&self) -> &str

Configured base URL.

pub fn model(&self) -> &str

Configured model id.

Trait Implementations

impl Clone for OpenAICompatibleConfig

fn clone(&self) -> OpenAICompatibleConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenAICompatibleConfig

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

Formats the value using the given formatter.