Struct OpenAIClient 

pub struct OpenAIClient {
    pub client: Client,
    pub end_point: String,
    pub api_key: Option<String>,
    pub tools: HashMap<String, (Arc<dyn Tool + Send + Sync>, bool)>,
    pub model_config: Option<ModelConfig>,
}

Main client structure for interacting with the OpenAI API.

Fields

client: Client

HTTP client

end_point: String

API endpoint

api_key: Option<String>

Optional API key

tools: HashMap<String, (Arc<dyn Tool + Send + Sync>, bool)>

Registered tools: key is the tool name, value is a tuple (tool, is_enabled)

model_config: Option<ModelConfig>

Configuration for the model request.

Implementations

impl OpenAIClient

pub fn new(end_point: &str, api_key: Option<&str>) -> Self

Create a new OpenAIClient.

Arguments

• end_point - The endpoint of the OpenAI API.
• api_key - Optional API key.

pub fn set_model_config(&mut self, model_config: &ModelConfig)

Set the default model configuration.

Arguments

• model_config - The model configuration.

pub fn def_tool<T: Tool + Send + Sync + 'static>(&mut self, tool: Arc<T>)

Register a tool.

If a tool with the same name already exists, it will be overwritten.

Arguments

• tool - Reference-counted tool implementing the Tool trait.

pub fn list_tools(&self) -> Vec<(String, String, bool)>

List all registered tools.

Returns

A list of tuples containing (tool name, tool description, enabled flag).

pub fn switch_tool(&mut self, tool_name: &str, t_enable: bool)

Switch the enable/disable state of a tool.

Arguments

• tool_name - The name of the tool.
• t_enable - True to enable, false to disable.

pub fn export_tool_def(&self) -> Result<Vec<ToolDef>, ClientError>

Export the definitions of all enabled tools.

Returns

A vector of function definitions.

pub async fn send( &self, prompt: &VecDeque<Message>, model: Option<&ModelConfig>, ) -> Result<APIResult, ClientError>

Send a chat request to the API.

Arguments

• model - The model configuration.
• prompt - A vector of user and system messages.

Returns

The API result or a ClientError.

pub async fn send_can_use_tool( &self, prompt: &VecDeque<Message>, model: Option<&ModelConfig>, ) -> Result<APIResult, ClientError>

Send a chat request with tool auto-selection.

Arguments

• model - The model configuration.
• prompt - A vector of messages.

Returns

The API result or a ClientError.

pub async fn send_use_tool( &self, prompt: &VecDeque<Message>, model: Option<&ModelConfig>, ) -> Result<APIResult, ClientError>

Send a chat request requiring the use of a tool.

Arguments

• model - The model configuration.
• prompt - A vector of messages.

Returns

The API result or a ClientError.

pub async fn send_with_tool( &self, prompt: &VecDeque<Message>, tool_name: &str, model: Option<&ModelConfig>, ) -> Result<APIResult, ClientError>

Send a chat request forcing the use of a specific tool.

Arguments

• model - The model configuration.
• prompt - A vector of messages.
• tool_name - The name of the tool to force.

Returns

The API result or a ClientError.

pub async fn call_api( &self, prompt: &VecDeque<Message>, tool_choice: Option<&Value>, model_config: Option<&ModelConfig>, ) -> Result<APIResult, ClientError>

Calls the OpenAI chat completions API.

Arguments

• model - The model name; e.g. “GPT-4o”.
• prompt - The list of messages.
• function_call - Indicates function call mode:
  • “auto”
  • “none”
  • { “name”: “get_weather” }
• temp - Temperature parameter.
• max_token - Maximum tokens parameter.
• top_p - Top-p sampling parameter.

Returns

An APIResult on success or a ClientError on failure.

pub async fn request_api( &self, end_point: &str, api_key: Option<&str>, model_config: &ModelConfig, message: &VecDeque<Message>, tools: &Vec<ToolDef>, tool_choice: &Value, ) -> Result<Response, ClientError>

pub fn create_prompt(&self) -> OpenAIClientState

Create a new prompt conversation.

Returns

A new OpenAIClientState with an empty message history.

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.