Struct OpenAIProtocolChatDriver 

pub struct OpenAIProtocolChatDriver { /* private fields */ }

OpenAI Protocol Chat Driver

Base implementation of ChatDriver for OpenAI-compatible APIs. Supports streaming responses and tool calls.

Rate limit handling: On 429 errors, automatically retries with exponential backoff, respecting x-ratelimit-reset-* and retry-after headers.

This is the base protocol driver used in examples and for OpenAI-compatible endpoints. For production use with OpenAI, consider using OpenAIChatDriver from the everruns-openai crate.

Example

use everruns_core::OpenAIProtocolChatDriver;

let driver = OpenAIProtocolChatDriver::new("your-api-key");
// or with custom endpoint
let driver = OpenAIProtocolChatDriver::with_base_url("your-api-key", "https://api.example.com/v1/chat/completions");
// or with custom retry config
let driver = OpenAIProtocolChatDriver::new("your-api-key")
    .with_retry_config(LlmRetryConfig::aggressive());

Implementations

impl OpenAIProtocolChatDriver

pub fn new(api_key: impl Into<String>) -> Self

Create a new driver with the given API key

pub fn with_base_url( api_key: impl Into<String>, api_url: impl Into<String>, ) -> Self

Create a new driver with a custom API URL (for OpenAI-compatible APIs)

pub fn with_retry_config(self, config: LlmRetryConfig) -> Self

Configure retry behavior for rate limit errors

pub fn with_auth_provider(self, provider: Arc<dyn AuthHeaderProvider>) -> Self

Set a pluggable AuthHeaderProvider that overrides the default api-key / bearer auth. Used for OAuth bearer tokens (e.g. Entra ID).

pub fn api_url(&self) -> &str

Get the API URL

pub fn api_key(&self) -> &str

Get the API key (for subclass access)

pub fn client(&self) -> &Client

Get the HTTP client (for subclass access)

Trait Implementations

impl ChatDriver for OpenAIProtocolChatDriver

fn supports_parallel_tool_calls(&self, _model: &str) -> bool

OpenAI-compatible Chat Completions accept the top-level parallel_tool_calls boolean, so the preference maps directly onto the wire for every model served through this protocol.

fn chat_completion_stream<'life0, 'life1, 'async_trait>( &'life0 self, messages: Vec<LlmMessage>, config: &'life1 LlmCallConfig, ) -> Pin<Box<dyn Future<Output = Result<LlmResponseStream>> + Send + 'async_trait>>

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

Call the LLM with streaming response

fn chat_completion<'life0, 'life1, 'async_trait>( &'life0 self, messages: Vec<LlmMessage>, config: &'life1 LlmCallConfig, ) -> Pin<Box<dyn Future<Output = Result<LlmResponse>> + Send + 'async_trait>>

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

Call the LLM without streaming (convenience method)

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

where Self: 'async_trait, 'life0: 'async_trait,

List available models from the provider

fn supports_compact(&self) -> bool

Check if this driver supports the compact endpoint

fn compact<'life0, 'async_trait>( &'life0 self, _request: CompactRequest, ) -> Pin<Box<dyn Future<Output = Result<Option<CompactResponse>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Compact a conversation to reduce context size

impl Clone for OpenAIProtocolChatDriver

fn clone(&self) -> OpenAIProtocolChatDriver

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenAIProtocolChatDriver

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

Formats the value using the given formatter.