pub struct OpenAIClient { /* private fields */ }Expand description
Unified OpenAI client that supports both the Chat and Responses APIs.
The client internally manages two separate clients for the different API modes and delegates requests based on the configured default mode.
Implementations§
Source§impl OpenAIClient
impl OpenAIClient
Sourcepub fn with_mode(api_key: String, mode: OpenAIMode) -> Result<Self, ApiError>
pub fn with_mode(api_key: String, mode: OpenAIMode) -> Result<Self, ApiError>
Create a new OpenAI client with a specific mode.
Sourcepub fn with_base_url_mode(
api_key: String,
base_url: Option<String>,
mode: OpenAIMode,
) -> Result<Self, ApiError>
pub fn with_base_url_mode( api_key: String, base_url: Option<String>, mode: OpenAIMode, ) -> Result<Self, ApiError>
Create a new OpenAI client with a custom base URL and mode.
pub fn with_directive( directive: OpenAiResponsesAuth, base_url: Option<String>, ) -> Result<Self, ApiError>
Trait Implementations§
Source§impl Provider for OpenAIClient
impl Provider for OpenAIClient
fn name(&self) -> &'static str
fn complete<'life0, 'life1, 'async_trait>(
&'life0 self,
model_id: &'life1 ModelId,
messages: Vec<Message>,
system: Option<SystemContext>,
tools: Option<Vec<ToolSchema>>,
call_options: Option<ModelParameters>,
token: CancellationToken,
) -> Pin<Box<dyn Future<Output = Result<CompletionResponse, ApiError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn stream_complete<'life0, 'life1, 'async_trait>(
&'life0 self,
model_id: &'life1 ModelId,
messages: Vec<Message>,
system: Option<SystemContext>,
tools: Option<Vec<ToolSchema>>,
call_options: Option<ModelParameters>,
token: CancellationToken,
) -> Pin<Box<dyn Future<Output = Result<CompletionStream, ApiError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn create_auth_flow( &self, _storage: Arc<dyn AuthStorage>, ) -> Option<Box<dyn DynAuthenticationFlow>>
Auto Trait Implementations§
impl Freeze for OpenAIClient
impl !RefUnwindSafe for OpenAIClient
impl Send for OpenAIClient
impl Sync for OpenAIClient
impl Unpin for OpenAIClient
impl !UnwindSafe for OpenAIClient
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T in a tonic::Request