Skip to main content

OpenAiCompatibleClient

Struct OpenAiCompatibleClient 

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

A client for any OpenAI-compatible /chat/completions endpoint (OpenAI, Azure-OpenAI-compatible gateways, vLLM, Ollama, LM Studio, …).

Uses reqwest with rustls; no default TLS features.

Transient failures are retried with capped, jittered exponential backoff (same classification policy as crate::remote::RemoteNode): connect errors, timeouts, and HTTP 5xx / 408 / 429 are retryable; a Retry-After header (integer seconds) floors the delay. Other 4xx statuses and request/response decode errors are fatal. Configure with OpenAiCompatibleClient::with_retries / OpenAiCompatibleClient::with_backoff.

Implementations§

Source§

impl OpenAiCompatibleClient

Source

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

A client for base_url (e.g. https://api.openai.com/v1) serving model. Trailing slashes on base_url are trimmed.

Source

pub fn from_env( base_url: impl Into<String>, api_key_env: &str, model: impl Into<String>, ) -> Self

Read the API key from an environment variable.

A missing variable maps to “no key” (requests go out unauthenticated and typically fail 401 far from the cause), so a warning is logged at construction time to keep the cause close to the effect.

Source

pub fn with_http_client(self, client: Client) -> Self

Override the underlying reqwest::Client (timeouts, proxies, …).

Source

pub fn with_retries(self, max_retries: u32) -> Self

Override the number of retries after the initial attempt (0 = single attempt, no retries).

Source

pub fn with_backoff(self, base_backoff: Duration) -> Self

Override the base backoff delay (attempt n waits roughly base * 2^n, exponent capped and jittered).

Source

pub fn model(&self) -> &str

The model this client requests.

Trait Implementations§

Source§

impl ChatModel for OpenAiCompatibleClient

Source§

fn chat<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, messages: &'life1 [ChatMessage], tools: &'life2 [Value], ) -> Pin<Box<dyn Future<Output = Result<ChatResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Produce the next assistant message for the conversation.
Source§

fn chat_stream<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, messages: &'life1 [ChatMessage], tools: &'life2 [Value], on_token: &'life3 mut (dyn FnMut(TokenChunk) + Send), ) -> Pin<Box<dyn Future<Output = Result<ChatResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Produce the next assistant message, streaming token deltas through on_token as they arrive. Read more
Source§

fn effect(&self) -> Effect

The declared effect classification of calling this model (Flight Recorder, R0.5): recorded on model-call journal events and used by retry/replay policy. Read more
Source§

impl Clone for OpenAiCompatibleClient

Source§

fn clone(&self) -> OpenAiCompatibleClient

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 OpenAiCompatibleClient

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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