Struct OpenAIClient 

pub struct OpenAIClient { /* private fields */ }

Main OpenAI client that provides access to all APIs

Implementations

impl OpenAIClient

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

Create a new OpenAI client with an API key

pub fn with_base_url( api_key: impl Into<String>, base_url: impl Into<String>, ) -> Result<Self>

Create a new OpenAI client with custom base URL

pub async fn create_response( &self, request: &ResponseRequest, ) -> Result<ResponseResult>

Create a response using the responses API

pub async fn create_response_stream( &self, request: &ResponseRequest, ) -> Result<ResponseStream>

Create a streaming response

pub async fn generate_text( &self, model: impl Into<String>, prompt: impl Into<String>, ) -> Result<String>

Generate text from a simple prompt

pub async fn generate_text_stream( &self, model: impl Into<String>, prompt: impl Into<String>, ) -> Result<ResponseStream>

Generate text with streaming

pub async fn generate_with_instructions( &self, model: impl Into<String>, input: impl Into<String>, instructions: impl Into<String>, ) -> Result<String>

Generate text with instructions

pub async fn generate_with_instructions_stream( &self, model: impl Into<String>, input: impl Into<String>, instructions: impl Into<String>, ) -> Result<ResponseStream>

Generate text with instructions and streaming

pub async fn create_chat_completion( &self, model: impl Into<String>, messages: Vec<Message>, ) -> Result<String>

Create a chat completion from messages

pub async fn create_chat_completion_stream( &self, model: impl Into<String>, messages: Vec<Message>, ) -> Result<ResponseStream>

Create a streaming chat completion

pub async fn chat( &self, model: impl Into<String>, conversation: ChatBuilder, ) -> Result<String>

Build a conversation and get response

pub async fn chat_stream( &self, model: impl Into<String>, conversation: ChatBuilder, ) -> Result<ResponseStream>

Build a conversation and get streaming response

pub async fn create_custom_response( &self, model: impl Into<String>, input: ResponseInput, temperature: Option<f32>, max_tokens: Option<u32>, instructions: Option<String>, ) -> Result<ResponseResult>

Create a custom response with all parameters

pub fn responses(&self) -> &ResponsesApi

Get access to the responses API

pub fn responses_v2(&self) -> &ResponsesApiV2

Get access to the modern Responses API

pub async fn create_response_v2( &self, request: &CreateResponseRequest, ) -> Result<ResponseObject>

Create a response using the modern Responses API

pub async fn stream_response_v2( &self, request: &CreateResponseRequest, ) -> Result<ResponsesEventStream>

Stream a response using the modern Responses API

pub async fn retrieve_response_v2( &self, response_id: &str, ) -> Result<ResponseObject>

Retrieve a response by ID using the modern Responses API

pub async fn delete_response_v2( &self, response_id: &str, ) -> Result<DeleteResponseAck>

Delete a stored response using the modern Responses API

pub async fn cancel_response_v2( &self, response_id: &str, ) -> Result<ResponseObject>

Cancel a background response request using the modern Responses API

pub async fn list_responses_v2( &self, params: &ResponsesListParams, ) -> Result<ResponseList>

List responses for the current project using the modern Responses API

pub async fn list_response_input_items_v2( &self, response_id: &str, params: &StandardListParams, ) -> Result<ResponseInputItemList>

List input items for a particular response using the modern Responses API

pub fn streaming(&self) -> &StreamingApi

Get access to the streaming API

pub fn functions(&self) -> &FunctionsApi

Get access to the functions API

pub async fn create_function_response( &self, request: &ResponseRequest, config: &FunctionConfig, ) -> Result<FunctionResponseResult>

Create a response with function calling support

pub async fn submit_function_results( &self, results: Vec<FunctionCallOutput>, original_request: &ResponseRequest, config: &FunctionConfig, ) -> Result<FunctionResponseResult>

Submit function call results and continue the conversation

pub async fn function_conversation( &self, model: impl Into<String> + Clone, messages: Vec<Message>, tools: Vec<Tool>, max_iterations: Option<u32>, ) -> Result<Vec<FunctionResponseResult>>

Execute a complete function calling conversation

pub async fn call_function( &self, model: impl Into<String>, prompt: impl Into<String>, tools: Vec<Tool>, tool_choice: Option<ToolChoice>, ) -> Result<FunctionResponseResult>

Create a simple function call

pub async fn chat_with_tools( &self, model: impl Into<String>, conversation: ChatBuilder, tools: Option<Vec<Tool>>, tool_choice: Option<ToolChoice>, ) -> Result<FunctionResponseResult>

Create a chat completion with optional tools

pub async fn execute_function_with_result( &self, call: &FunctionCall, ) -> Result<FunctionCallOutput>

Execute a function call with automatic result handling

Trait Implementations

impl Clone for OpenAIClient

fn clone(&self) -> OpenAIClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.