Skip to main content

OpenAiClient

Struct OpenAiClient 

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

Client for OpenAI Responses API

Implementations§

Source§

impl OpenAiClient

Source

pub fn new(api_key: String) -> OpenAiClient

Create a new OpenAI client with the given API key

Source

pub fn new_with_base_url(api_key: String, base_url: String) -> OpenAiClient

Create a new OpenAI client with an explicit base URL

Source

pub fn new_with_optional_api_key_and_base_url( api_key: Option<String>, base_url: String, ) -> OpenAiClient

Create a new OpenAI client with an optional API key and explicit base URL.

Source

pub fn with_extra_headers(self, headers: Vec<(String, String)>) -> OpenAiClient

Install a set of (name, value) headers to include on every request.

ChatGPT-backend callers pass ChatGPT-Account-ID and optionally X-OpenAI-Fedramp here.

Source

pub fn with_responses_path(self, path: impl Into<String>) -> OpenAiClient

Set the Responses endpoint path relative to base_url.

Public OpenAI uses /v1/responses; the ChatGPT Codex backend uses /responses under https://chatgpt.com/backend-api/codex.

Source

pub fn with_chatgpt_backend_wire(self) -> OpenAiClient

Source

pub fn with_authorizer( self, authorizer: Arc<dyn HttpAuthorizer>, ) -> OpenAiClient

Attach a dynamic authorizer. When set, overrides the Authorization: Bearer <api_key> path on every request with HttpAuthorizer::authorize. Extra headers (ChatGPT-Account-ID etc.) still flow through unchanged.

Source

pub fn extra_headers(&self) -> &[(String, String)]

Source

pub fn with_base_url(self, url: String) -> OpenAiClient

Set custom base URL

Trait Implementations§

Source§

impl ImageGenerationExecutor for OpenAiClient

Source§

fn execute_image_generation<'life0, 'async_trait>( &'life0 self, request: ProviderImageGenerationRequest, ) -> Pin<Box<dyn Future<Output = Result<ProviderImageGenerationOutput, LlmError>> + Send + 'async_trait>>
where 'life0: 'async_trait, OpenAiClient: 'async_trait,

Source§

impl LlmClient for OpenAiClient

Source§

fn stream<'a>( &'a self, request: &'a LlmRequest, ) -> Pin<Box<dyn Stream<Item = Result<LlmEvent, LlmError>> + Send + 'a>>

Stream a completion request Read more
Source§

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

Get the provider name (for logging/debugging)
Source§

fn health_check<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), LlmError>> + Send + 'async_trait>>
where 'life0: 'async_trait, OpenAiClient: 'async_trait,

Check if the client is healthy/connected
Source§

fn compile_schema( &self, output_schema: &OutputSchema, ) -> Result<CompiledSchema, SchemaError>

Compile an output schema for this provider. 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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 = 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