Struct OpenAIChat 

pub struct OpenAIChat { /* private fields */ }

OpenAI chat client for GPT models.

Implementations

impl OpenAIChat

pub fn new(config: OpenAIConfig) -> Self

Creates a new OpenAIChat with the given configuration.

pub fn from_env_result() -> Result<Self, OpenAIError>

Creates an OpenAIChat from environment variables, returning a Result.

pub fn bind_tools(&self, tools: Vec<ToolDefinition>) -> Self

Binds tool definitions for function calling.

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

Sets the tool choice strategy.

pub fn with_structured_output<T: DeserializeOwned + JsonSchema>( &self, ) -> StructuredOutputMethod<T>

Enables structured JSON output with schema validation.

pub fn with_json_schema_output<T: DeserializeOwned + JsonSchema>( &self, ) -> StructuredOutputMethod<T>

0.21.0 S3.1: enables engine-constrained structured output via the response_format: { type: "json_schema", ... } request field (OpenAI strict mode).

The schema is generated from T via schemars and normalized for strict mode (additionalProperties: false, all properties required — see crate::openai::response_format::make_strict_schema). The engine guarantees schema-valid JSON, so the returned method parses the message content directly; no tool-binding round trip is involved.

Unlike Self::with_structured_output (tool-based, works on any OpenAI-compatible backend), this path requires provider-side json_schema support; unsupported providers return a 4xx error.

impl OpenAIChat

OpenAI multimodal extensions.

These methods are on OpenAIChat directly (not through the trait) because they require provider-specific parameters (voice, size, etc.).

pub async fn whisper_transcribe( &self, audio: AudioContent, ) -> Result<String, MultimodalError>

Transcribes audio using Whisper.

Sends audio to the /v1/audio/transcriptions endpoint.

pub async fn tts_generate( &self, text: &str, voice: TtsVoice, ) -> Result<Vec<u8>, MultimodalError>

Generates speech using OpenAI TTS.

Sends text to the /v1/audio/speech endpoint and returns raw audio bytes.

pub async fn dalle_generate( &self, prompt: &str, size: DallEImageSize, ) -> Result<ImageContent, MultimodalError>

Generates an image using DALL-E.

Sends a prompt to the /v1/images/generations endpoint.

Trait Implementations

impl BaseChatModel for OpenAIChat

fn chat<'life0, 'async_trait>( &'life0 self, messages: Vec<Message>, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<LLMResult, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Chat with the model.

fn stream_chat<'life0, 'async_trait>( &'life0 self, messages: Vec<Message>, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<StreamChunk, Self::Error>> + Send>>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Stream chat with the model.

fn bind_tools( &self, tools: Vec<ToolDefinition>, ) -> Option<Box<dyn BaseChatModel<Error = Self::Error> + Send + Sync>>

Bind tool definitions for function calling.

fn chat_with_system<'life0, 'async_trait>( &'life0 self, system: String, messages: Vec<Message>, ) -> Pin<Box<dyn Future<Output = Result<LLMResult, Self::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

Chat with system prompt.

impl BaseLanguageModel<Vec<Message>, LLMResult> for OpenAIChat

fn model_name(&self) -> &str

Returns the model name.

fn get_num_tokens(&self, text: &str) -> usize

Calculates token count for text.

fn temperature(&self) -> Option<f32>

Returns the temperature parameter.

fn max_tokens(&self) -> Option<usize>

Returns the max tokens limit.

fn with_temperature(self, temp: f32) -> Self

Sets the temperature parameter.

fn with_max_tokens(self, max: usize) -> Self

Sets the max tokens limit.

impl Clone for OpenAIChat

fn clone(&self) -> OpenAIChat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl MultimodalModel for OpenAIChat

Implement MultimodalModel trait for OpenAIChat.

fn transcribe<'life0, 'async_trait>( &'life0 self, audio: AudioContent, ) -> Pin<Box<dyn Future<Output = Result<String, MultimodalError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Transcribes audio to text (Speech-to-Text).

fn generate_speech<'life0, 'life1, 'async_trait>( &'life0 self, text: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, MultimodalError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Generates audio from text (Text-to-Speech).

fn generate_image<'life0, 'life1, 'async_trait>( &'life0 self, prompt: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<ImageContent, MultimodalError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Generates an image from a text prompt.

impl Runnable<Vec<Message>, LLMResult> for OpenAIChat

type Error = OpenAIError

Error type.

fn invoke<'life0, 'async_trait>( &'life0 self, input: Vec<Message>, _config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<LLMResult, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Transforms single input to output.

fn stream<'life0, 'async_trait>( &'life0 self, input: Vec<Message>, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<LLMResult, Self::Error>> + Send>>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Streaming output - for real-time responses (LLM, etc).

fn batch<'life0, 'async_trait>( &'life0 self, inputs: Vec<Input>, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<Vec<Output>, Self::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Batch processing - transforms multiple inputs to outputs.

fn batch_as_completed<'life0, 'async_trait>( &'life0 self, inputs: Vec<Input>, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<Vec<(usize, Output)>, Self::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Batch processing that returns results in completion order.

fn transform<'life0, 'async_trait>( &'life0 self, input: Pin<Box<dyn Stream<Item = Result<Input, Self::Error>> + Send>>, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<Output, Self::Error>> + Send + 'life0>>, Self::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Stream-to-stream transformation - the core of LCEL streaming.