Struct OpenAiCompatibleModelProvider 

pub struct OpenAiCompatibleModelProvider {
    pub alias: String,
    pub name: String,
    pub base_url: String,
    pub credential: Option<String>,
    pub auth_header: AuthStyle,
    /* private fields */
}

A model_provider that speaks the OpenAI-compatible chat completions API. Used by: Venice, Vercel AI Gateway, Cloudflare AI Gateway, Moonshot, Synthetic, OpenCode Zen, OpenCode Go, Z.AI, GLM, MiniMax, Bedrock, Qianfan, Groq, Mistral, xAI, etc.

Fields

alias: String

[providers.models.<alias>] key this provider was constructed under. Used by the Attributable impl so log emissions carry the real composite (<type>.<alias>) instead of the bare type.

name: String

base_url: String

credential: Option<String>

auth_header: AuthStyle

Implementations

impl OpenAiCompatibleModelProvider

pub fn builder(alias: &str) -> OpenAiCompatibleBuilder

Entry point for constructing an OpenAI-compatible provider.

Only alias is taken as a positional argument; every other field is set via labelled chain methods on the returned OpenAiCompatibleBuilder so call sites remain readable. See OpenAiCompatibleBuilder::build for the fields that must be set before calling build().

Trait Implementations

impl Attributable for OpenAiCompatibleModelProvider

fn role(&self) -> Role

fn alias(&self) -> &str

impl Clone for OpenAiCompatibleModelProvider

fn clone(&self) -> OpenAiCompatibleModelProvider

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ModelProvider for OpenAiCompatibleModelProvider

fn capabilities(&self) -> ProviderCapabilities

Query model_provider capabilities.

fn list_models<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, OpenAiCompatibleModelProvider: 'async_trait,

fn list_models_with_pricing<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<ModelInfo>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, OpenAiCompatibleModelProvider: 'async_trait,

Fetch the list of available models with pricing data for this model_provider. Default delegates to list_models and returns no pricing. Concrete providers that receive pricing from their /models endpoint override this to return enriched data.

fn chat_with_system<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, system_prompt: Option<&'life1 str>, message: &'life2 str, model: &'life3 str, temperature: Option<f64>, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, OpenAiCompatibleModelProvider: 'async_trait,

One-shot chat with optional system prompt. See simple_chat for the temperature contract.

fn chat_with_history<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, messages: &'life1 [ChatMessage], model: &'life2 str, temperature: Option<f64>, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, OpenAiCompatibleModelProvider: 'async_trait,

Multi-turn conversation. See simple_chat for the temperature contract.

fn chat_with_tools<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, messages: &'life1 [ChatMessage], tools: &'life2 [Value], model: &'life3 str, temperature: Option<f64>, ) -> Pin<Box<dyn Future<Output = Result<ChatResponse, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, OpenAiCompatibleModelProvider: 'async_trait,

Chat with tool definitions for native function calling support. See simple_chat for the temperature contract.

fn chat<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, request: ChatRequest<'life1>, model: &'life2 str, temperature: Option<f64>, ) -> Pin<Box<dyn Future<Output = Result<ChatResponse, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, OpenAiCompatibleModelProvider: 'async_trait,

Structured chat API for agent loop callers. See simple_chat for the temperature contract.

fn supports_native_tools(&self) -> bool

Whether model_provider supports native tool calls over API.

fn supports_streaming(&self) -> bool

Whether model_provider supports streaming responses.

fn supports_streaming_tool_events(&self) -> bool

Whether model_provider can emit structured tool-call stream events.

fn stream_chat( &self, request: ChatRequest<'_>, model: &str, temperature: Option<f64>, options: StreamOptions, ) -> Pin<Box<dyn Stream<Item = Result<StreamEvent, StreamError>> + Send>>

Structured streaming chat interface. See simple_chat for the temperature contract.

fn stream_chat_with_system( &self, system_prompt: Option<&str>, message: &str, model: &str, temperature: Option<f64>, options: StreamOptions, ) -> Pin<Box<dyn Stream<Item = Result<StreamChunk, StreamError>> + Send>>

Streaming chat with optional system prompt. See simple_chat for the temperature contract.

fn stream_chat_with_history( &self, messages: &[ChatMessage], model: &str, temperature: Option<f64>, options: StreamOptions, ) -> Pin<Box<dyn Stream<Item = Result<StreamChunk, StreamError>> + Send>>

Streaming chat with history. See simple_chat for the temperature contract.

fn warmup<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, OpenAiCompatibleModelProvider: 'async_trait,

Warm up the HTTP connection pool.

fn capabilities_for_model(&self, _model: &str) -> ProviderCapabilities

Query the effective capabilities for the model that will be dispatched.

fn default_temperature(&self) -> f64

Family-preferred temperature default. Override per family. Documented for introspection only; never use to convert None into a wire value.

fn default_max_tokens(&self) -> u32

Max output tokens used when the caller / config doesn’t set one.

fn default_timeout_secs(&self) -> u64

HTTP timeout (seconds) used when the caller / config doesn’t set one.

fn default_base_url(&self) -> Option<&str>

Canonical public API endpoint, when there is one. Returned as a string slice so model_provider impls can serve from const &'static strs without allocations. None = model_provider has no universal endpoint (local model_providers, auth-less CLIs, user-BYO endpoints).

fn default_wire_api(&self) -> &str

Wire protocol variant. Either "responses" (OpenAI Codex-style) or "chat_completions" (everything else). Providers override to their native format.

fn convert_tools(&self, tools: &[ToolSpec]) -> ToolsPayload

Convert tool specifications to provider-native format.

fn simple_chat<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, message: &'life1 str, model: &'life2 str, temperature: Option<f64>, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Simple one-shot chat (single user message, no explicit system prompt). temperature == None means the field is omitted on the wire.

fn supports_vision(&self) -> bool

Whether model_provider supports multimodal vision input.