ProviderConfig

Struct ProviderConfig 

Source
pub struct ProviderConfig {
    pub base_url: String,
    pub api_key_env: String,
    pub chat_endpoint: String,
    pub chat_model: String,
    pub multimodal_model: Option<String>,
    pub upload_endpoint: Option<String>,
    pub upload_size_limit: Option<u64>,
    pub models_endpoint: Option<String>,
    pub headers: HashMap<String, String>,
    pub field_mapping: FieldMapping,
}
Expand description

Provider configuration template defining API access parameters

This struct contains all necessary configuration for connecting to an AI provider, including base URL, API endpoints, authentication, and model specifications.

Fields§

§base_url: String

Base URL for the provider’s API

§api_key_env: String

Environment variable name for the API key

§chat_endpoint: String

Chat completion endpoint path

§chat_model: String

Default chat model for this provider

§multimodal_model: Option<String>

Optional multimodal model for this provider (if supported)

§upload_endpoint: Option<String>

Optional file upload endpoint path (e.g. OpenAI: “/v1/files”)

§upload_size_limit: Option<u64>

Optional file size limit (bytes) above which files should be uploaded instead of inlined

§models_endpoint: Option<String>

Model list endpoint path

§headers: HashMap<String, String>

Request headers template

§field_mapping: FieldMapping

Field mapping configuration

Implementations§

Source§

impl ProviderConfig

Source

pub fn openai_compatible( base_url: &str, api_key_env: &str, chat_model: &str, multimodal_model: Option<&str>, ) -> Self

OpenAI-compatible configuration template

Creates a standard OpenAI-compatible configuration with default models. The default chat model is “gpt-3.5-turbo” and multimodal model is “gpt-4o”.

§Arguments
  • base_url - The base URL for the provider’s API
  • api_key_env - Environment variable name for the API key
  • chat_model - Default chat model name
  • multimodal_model - Optional multimodal model name
Source

pub fn openai_compatible_default(base_url: &str, api_key_env: &str) -> Self

OpenAI-compatible configuration template with default models

This is a convenience method that uses standard default models. For custom models, use openai_compatible() with explicit model names.

Source

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

Validate the configuration for completeness and correctness

§Returns
  • Result<(), AiLibError> - Ok on success, error information on failure
Source

pub fn chat_url(&self) -> String

Get the complete chat completion URL

Source

pub fn models_url(&self) -> Option<String>

Get the complete models list URL

Source

pub fn upload_url(&self) -> Option<String>

Get the complete file upload URL

Source

pub fn default_chat_model(&self) -> &str

Get the default chat model for this provider

Source

pub fn multimodal_model(&self) -> Option<&str>

Get the multimodal model if available

Trait Implementations§

Source§

impl Clone for ProviderConfig

Source§

fn clone(&self) -> ProviderConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ProviderConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ProviderConfig

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ProviderConfig

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,