Struct OpenAIConfig 

pub struct OpenAIConfig {
    pub api_key: String,
    pub model: String,
    pub organization_id: Option<String>,
    pub project_id: Option<String>,
    pub base_url: Option<String>,
}

Available on crate feature models only.

Configuration for OpenAI API.

Fields

api_key: String

OpenAI API key.

model: String

Model name (e.g., “gpt-4o”, “gpt-4o-mini”, “gpt-4-turbo”).

organization_id: Option<String>

Optional organization ID.

project_id: Option<String>

Optional project ID.

base_url: Option<String>

Optional custom base URL for OpenAI-compatible APIs.

Implementations

impl OpenAIConfig

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

Available on crate feature openai only.

Create a new OpenAI config with the given API key and model.

pub fn compatible( api_key: impl Into<String>, base_url: impl Into<String>, model: impl Into<String>, ) -> OpenAIConfig

Available on crate feature openai only.

Create a config for an OpenAI-compatible API (e.g., Ollama, vLLM).

pub fn with_organization(self, org_id: impl Into<String>) -> OpenAIConfig

Available on crate feature openai only.

Set the organization ID.

pub fn with_project(self, project_id: impl Into<String>) -> OpenAIConfig

Available on crate feature openai only.

Set the project ID.

Trait Implementations

impl Clone for OpenAIConfig

fn clone(&self) -> OpenAIConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenAIConfig

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

Formats the value using the given formatter.

impl Default for OpenAIConfig

fn default() -> OpenAIConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OpenAIConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<OpenAIConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OpenAIConfig

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.