Skip to main content

OpenAIBackend

Struct OpenAIBackend 

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

OpenAI Chat Completions backend. Composes OpenAICompatibleBackend with the OpenAI preset + a capability override for Vision on the gpt-4o family.

Implementations§

Source§

impl OpenAIBackend

Source

pub fn from_env() -> Self

Construct from env. OPENAI_API_KEY is read at construction time; None is permitted (auth check fires at first call).

Source

pub fn with_api_key(api_key: Option<String>) -> Self

Construct with an explicit API key (or None).

Source

pub fn with_base_url(self, base_url: impl Into<String>) -> Self

Override the base URL (test fixtures, mock servers, Azure OpenAI-compatible deployments). Returns self for builder chaining.

Source

pub fn with_default_model(self, model: impl Into<String>) -> Self

Override the default model.

Source

pub fn inner(&self) -> &OpenAICompatibleBackend

Borrow the underlying OpenAICompatibleBackend (for testing fixtures that need access to the composed inner state).

Trait Implementations§

Source§

impl Backend for OpenAIBackend

Source§

fn name(&self) -> &str

Short provider name used as the registry key. E.g. "anthropic", "openai", "kimi".
Source§

fn default_model(&self) -> &str

Default model used when ChatRequest::model is empty.
Source§

fn complete<'life0, 'async_trait>( &'life0 self, request: ChatRequest, ) -> Pin<Box<dyn Future<Output = Result<ChatResponse, BackendError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Synchronous-result chat completion (non-streaming).
Source§

fn stream<'life0, 'async_trait>( &'life0 self, request: ChatRequest, ) -> Pin<Box<dyn Future<Output = Result<ChatStream, BackendError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Streaming chat completion. Adopter consumes the returned stream; per-chunk text arrives in ChatChunk::delta, finish reason + usage in the final chunk.
Source§

fn count_tokens(&self, model: &str, text: &str) -> usize

Best-effort token count for text against a specific model on this provider. Default impl delegates to the unified tokens::count_tokens dispatch; per-provider overrides may consult the provider’s HTTP count_tokens endpoint when an exact answer is required + a network round-trip is acceptable.
Source§

fn supports(&self, capability: Capability, model: &str) -> bool

Capability discovery — does this backend support capability for the given model? Default returns false for everything; per-provider impls override.
Source§

impl Default for OpenAIBackend

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
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, 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