Struct OpenAIChatModel 

pub struct OpenAIChatModel { /* private fields */ }

Available on crate feature openai only.

OpenAI Chat Completions model.

Implementations

impl OpenAIChatModel

pub fn new( model_name: impl Into<String>, api_key: impl Into<String>, ) -> OpenAIChatModel

Create a new OpenAI chat model.

pub fn from_env( model_name: impl Into<String>, ) -> Result<OpenAIChatModel, ModelError>

Create from environment variable OPENAI_API_KEY.

pub fn with_base_url(self, url: impl Into<String>) -> OpenAIChatModel

Set the base URL.

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

Set the organization ID.

pub fn with_project(self, project: impl Into<String>) -> OpenAIChatModel

Set the project ID.

pub fn with_client(self, client: Client) -> OpenAIChatModel

Set a custom HTTP client.

pub fn with_timeout(self, timeout: Duration) -> OpenAIChatModel

Set the default timeout.

pub fn with_profile(self, profile: ModelProfile) -> OpenAIChatModel

Set a custom profile.

pub fn convert_response_to_message(&self, resp: &ModelResponse) -> ChatMessage

Convert a ModelResponse to an assistant ChatMessage.

pub fn add_response_to_messages( &self, messages: &mut Vec<ChatMessage>, response: &ModelResponse, )

Add an assistant response to messages (for multi-turn conversations).

Trait Implementations

impl Clone for OpenAIChatModel

fn clone(&self) -> OpenAIChatModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenAIChatModel

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

Formats the value using the given formatter.

impl Model for OpenAIChatModel

fn name(&self) -> &str

Get the model name.

fn system(&self) -> &str

Get the model system/provider (openai, anthropic, etc).

fn profile(&self) -> &ModelProfile

Get the model profile (capabilities, schema transforms).

fn request<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, messages: &'life1 [ModelRequest], settings: &'life2 ModelSettings, params: &'life3 ModelRequestParameters, ) -> Pin<Box<dyn Future<Output = Result<ModelResponse, ModelError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, OpenAIChatModel: 'async_trait,

Make a request to the model.

fn request_stream<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, messages: &'life1 [ModelRequest], settings: &'life2 ModelSettings, params: &'life3 ModelRequestParameters, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<ModelResponseStreamEvent, ModelError>> + Send>>, ModelError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, OpenAIChatModel: 'async_trait,

Make a streaming request to the model.

fn identifier(&self) -> String

Get the full model identifier.

fn count_tokens<'life0, 'life1, 'async_trait>( &'life0 self, _messages: &'life1 [ModelRequest], ) -> Pin<Box<dyn Future<Output = Result<u64, ModelError>> + Send + 'async_trait>>

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

Count tokens for messages (if supported).

fn supports(&self, capability: ModelCapability) -> bool

Check if the model supports a specific capability.