Skip to main content

OpenAIChatDriver

Struct OpenAIChatDriver 

Source
pub struct OpenAIChatDriver { /* private fields */ }
Expand description

OpenAI Chat Driver using Open Responses API

Production driver for OpenAI using the Open Responses specification (https://www.openresponses.org/). This is the recommended driver for new projects, offering:

  • Better performance with reasoning models (o1, o3, GPT-5)
  • Provider-agnostic streaming events
  • Native agentic loop support
  • 40-80% better cache utilization

For backward compatibility with the Chat Completions API, use OpenAICompletionsChatDriver instead.

§Example

use everruns_openai::OpenAIChatDriver;

let driver = OpenAIChatDriver::new("your-api-key");

// With custom endpoint
let driver = OpenAIChatDriver::with_base_url(
    "your-api-key",
    "https://api.example.com/v1/responses",
);

Implementations§

Source§

impl OpenAIChatDriver

Source

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

Create a new driver with the given API key

Source

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

Source

pub fn api_url(&self) -> &str

Get the API URL

Source

pub fn uses_custom_url(&self) -> bool

Check if using a custom base URL

Source

pub async fn compact_conversation( &self, request: CompactRequest, ) -> Result<CompactResponse>

Compact a conversation to reduce context size

This method calls the /v1/responses/compact endpoint to compress the conversation history. User messages are kept verbatim, while assistant messages, tool calls, and tool results are replaced by an encrypted compaction item.

§Arguments
  • request - The compact request containing the model and input items
§Returns

Returns a CompactResponse containing the compacted output items. The output can be used directly as input for the next /v1/responses call.

Source

pub fn can_compact(&self) -> bool

Check if this driver supports the compact endpoint

Returns true for OpenAI’s Responses API. Custom endpoints may or may not support compaction.

Trait Implementations§

Source§

impl ChatDriver for OpenAIChatDriver

Source§

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
Source§

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 Read more
Source§

fn supports_compact(&self) -> bool

Check if this driver supports the compact endpoint Read more
Source§

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

Whether this driver can express the request-level parallel_tool_calls preference on the wire for model. Read more
Source§

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 Read more
Source§

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

Call the LLM without streaming (convenience method)
Source§

fn supports_stateful_responses(&self) -> bool

Whether this driver persists Responses API state and can resolve tool calls that are reachable only through previous_response_id. Read more
Source§

fn effective_context_window(&self, _model: &str) -> Option<usize>

Effective context window for model, when the driver has authoritative model metadata that is not represented by Everruns’ built-in profiles. Read more
Source§

impl Clone for OpenAIChatDriver

Source§

fn clone(&self) -> OpenAIChatDriver

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OpenAIChatDriver

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more