Struct OpenAiProvider 

pub struct OpenAiProvider { /* private fields */ }

Stable since 0.63.0

OpenAI-compatible provider

Implementations

impl OpenAiProvider

pub fn new() -> OpenAiProvider

Create a new OpenAI provider without an API key.

API keys are resolved at request time via auth.json or StreamOptions. Use with_api_key() for explicit key injection.

pub fn with_api_key(api_key: impl Into<String>) -> OpenAiProvider

Create with explicit API key (public API for external consumers)

pub fn with_base_url(base_url: &str) -> OpenAiProvider

Create with a custom base URL (API key resolved from auth storage).

Used for built-in OpenAI-compatible providers like Groq, Cerebras, etc.

pub fn with_base_url_and_key( base_url: &str, api_key: Option<String>, ) -> OpenAiProvider

Create with a custom base URL and optional API key.

Used for registering custom OpenAI-compatible providers (Minimax, ZAI, etc.).

pub fn with_config( base_url: &str, api_key: Option<String>, extra_headers: Vec<(String, String)>, ) -> OpenAiProvider

Create with a custom base URL, optional API key, and extra headers.

Used for providers that require specific HTTP headers (OpenRouter, etc.).

Trait Implementations

impl Clone for OpenAiProvider

fn clone(&self) -> OpenAiProvider

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for OpenAiProvider

fn default() -> OpenAiProvider

Returns the “default value” for a type.

impl Provider for OpenAiProvider

fn stream<'a>( &'a self, model: &'a Model, context: &'a Context, options: Option<StreamOptions>, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = ProviderEvent> + Send>>, ProviderError>> + Send + 'a>>

Stream assistant message events