Struct OpenAIConfig 

pub struct OpenAIConfig {
    pub api_key: SecretString,
    pub model: String,
    pub base_url: Option<Url>,
    pub organization: Option<String>,
    pub project: Option<String>,
    pub http: HttpConfig,
    pub embedding_model: Option<String>,
}

Configuration for the OpenAI provider.

Fields

api_key: SecretString

OpenAI API key

model: String

Model to use (e.g., “gpt-4”, “gpt-3.5-turbo”)

base_url: Option<Url>

Base URL for the OpenAI API (defaults to https://api.openai.com/v1)

organization: Option<String>

Organization ID (optional)

project: Option<String>

Project ID (optional)

http: HttpConfig

HTTP client configuration

embedding_model: Option<String>

Embedding model to use (e.g., “text-embedding-ada-002”)

Implementations

impl OpenAIConfig

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

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

pub fn builder() -> OpenAIConfigBuilder

Create a configuration builder.

pub fn base_url(&self) -> &str

Get the base URL for API requests.

pub fn chat_url(&self) -> String

Get the chat completions endpoint URL.

pub fn completions_url(&self) -> String

Get the completions endpoint URL.

pub fn embeddings_url(&self) -> String

Get the embeddings endpoint URL.

pub fn images_url(&self) -> String

Get the images endpoint URL.

pub fn transcriptions_url(&self) -> String

Get the audio transcriptions endpoint URL.

pub fn speech_url(&self) -> String

Get the audio speech endpoint URL.

pub fn from_env() -> Result<Self, ConfigError>

Load configuration from environment variables.

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

Formats the value using the given formatter.

impl Default for OpenAIConfig

fn default() -> Self

Returns the “default value” for a type.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ProviderConfig for OpenAIConfig

type Provider = OpenAIProvider

The provider type that this configuration creates

fn build(self) -> Result<Self::Provider, ConfigError>

Build a provider instance from this configuration.

fn validate(&self) -> Result<(), ConfigError>

Validate the configuration without building a provider.

impl Serialize for OpenAIConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.