Skip to main content

OpenAIChat

Struct OpenAIChat 

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

Adapter for POST /v1/chat/completions.

OpenAIChat speaks OpenAI’s Chat Completions protocol: neutral ChatRequests are normalized and mapped onto the /v1/chat/completions body, and responses (including reasoning content and tool calls) are mapped back to a neutral ChatResponse. Together with OpenAIChat::base_url, it also serves as the base protocol for third-party OpenAI-compatible endpoints.

Streaming uses server-sent events and requests usage reporting via stream_options.include_usage. Requests are authorized with Authorization: Bearer <key>, where the key comes from OpenAIChat::api_key or the OPENAI_API_KEY environment variable.

Implementations§

Source§

impl OpenAIChat

Source

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

Creates a Chat Completions adapter for model, defaulting to OpenAI’s public endpoint.

Source

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

Sets the API key sent as Authorization: Bearer <key>.

When unset, the OPENAI_API_KEY environment variable is used.

Source

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

Overrides the API base URL (default https://api.openai.com/v1).

The /chat/completions path is appended, so this can point at any OpenAI-compatible endpoint.

Source

pub fn retry_policy(self, retry_policy: RetryPolicy) -> Self

Overrides the retry policy applied to transient transport failures.

Source

pub fn transport(self, transport: TransportConfig) -> Self

Sets the transport configuration used when preparing outgoing requests.

Trait Implementations§

Source§

impl ModelAdapter for OpenAIChat

Source§

fn provider_name(&self) -> &'static str

Stable identifier of the provider behind this adapter, e.g. "anthropic-messages".
Source§

fn model_name(&self) -> &str

Model identifier used for this adapter, e.g. "claude-sonnet-4".
Source§

fn complete_with<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, request: &'life1 ChatRequest, options: &'life2 RequestOptions, ) -> Pin<Box<dyn Future<Output = Result<ChatResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Complete a request with explicit RequestOptions. Read more
Source§

fn stream_with<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, request: &'life1 ChatRequest, options: &'life2 RequestOptions, ) -> Pin<Box<dyn Future<Output = Result<ModelStream>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Start a streaming response. Read more
Source§

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

Complete a request with default RequestOptions. Read more
Source§

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

Start a streaming response with default request options.

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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