Struct OpenAIChatCompletionClient 

pub struct OpenAIChatCompletionClient { /* private fields */ }

An OpenAI (or OpenAI-compatible) chat client.

Implementations

impl OpenAIChatCompletionClient

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

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

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

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>) -> Self

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

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

Set the organization header.

pub fn model(&self) -> &str

The default model id.

Trait Implementations

impl ChatClient for OpenAIChatCompletionClient

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

where Self: 'async_trait, 'life0: '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<ChatStream>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: '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 OpenAIChatCompletionClient

fn clone(&self) -> OpenAIChatCompletionClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.