Struct OpenAIConfig 

#[non_exhaustive]
pub struct OpenAIConfig {
    pub api_key: String,
    pub model: String,
    pub dimensions: usize,
    pub base_url: Option<String>,
}

Configuration for the OpenAI embedding provider.

YAML example

api_key: "${OPENAI_API_KEY}"
model: "text-embedding-3-small"
dimensions: 1536

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

api_key: String

OpenAI API key. Required.

model: String

Model name. Defaults to "text-embedding-3-small".

dimensions: usize

Output vector dimensions. Defaults to 1536.

base_url: Option<String>

Base URL override for Azure OpenAI or compatible proxies. Defaults to None (uses https://api.openai.com).

Implementations

impl OpenAIConfig

pub fn validate(&self) -> Result<()>

Validate the configuration.

Errors

Returns Error::bad_request if api_key is empty, model is empty, or dimensions is zero.

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

where OpenAIConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.