Struct OpenAIChatClient 

pub struct OpenAIChatClient { /* private fields */ }

An OpenAI Responses API chat client (POST /v1/responses).

Implementations

impl OpenAIChatClient

pub fn new( api_key: impl Into<String>, model: impl Into<String>, ) -> OpenAIChatClient

Create a client for the given API key and default model.

pub fn from_env(model: impl Into<String>) -> Result<OpenAIChatClient, Error>

Build a client from the OPENAI_API_KEY (and optional OPENAI_BASE_URL) environment variables.

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

Override the base URL (for Azure OpenAI or compatible servers).

pub fn with_organization(self, org: impl Into<String>) -> OpenAIChatClient

Set the organization header.

pub fn model(&self) -> &str

The default model id.

Trait Implementations

impl ChatClient for OpenAIChatClient

fn get_response<'life0, 'async_trait>( &'life0 self, messages: Vec<Message>, options: ChatOptions, ) -> Pin<Box<dyn Future<Output = Result<ChatResponse, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, OpenAIChatClient: 'async_trait,

Get a complete (non-streaming) response.

fn get_streaming_response<'life0, 'async_trait>( &'life0 self, messages: Vec<Message>, options: ChatOptions, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<ChatResponseUpdate, Error>> + Send>>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, OpenAIChatClient: 'async_trait,

Get a streaming response as a sequence of updates.

fn model(&self) -> Option<&str>

The default model id for this client, if any.

impl Clone for OpenAIChatClient

fn clone(&self) -> OpenAIChatClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpenAIChatClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.