ProviderConfig

Struct ProviderConfig 

Source
pub struct ProviderConfig {
    pub name: String,
    pub api_key: String,
    pub base_url: Option<String>,
    pub timeout: Duration,
    pub max_retries: u32,
    pub retry_delay: Duration,
    pub rate_limit: Option<RateLimit>,
    pub model_mapping: HashMap<String, String>,
    pub headers: HashMap<String, String>,
    pub enabled: bool,
    pub circuit_breaker: Option<CircuitBreakerConfig>,
}
Expand description

Configuration for provider instances.

This struct contains all the configuration parameters needed to create and configure a provider instance.

§Examples

use ultrafast_models_sdk::providers::ProviderConfig;
use std::time::Duration;

let config = ProviderConfig::new("openai", "your-api-key")
    .with_timeout(Duration::from_secs(30))
    .with_max_retries(3)
    .with_base_url("https://api.openai.com/v1".to_string());

Fields§

§name: String

Provider name/identifier

§api_key: String

API key for authentication

§base_url: Option<String>

Optional base URL for the provider API

§timeout: Duration

Request timeout duration

§max_retries: u32

Maximum number of retry attempts

§retry_delay: Duration

Delay between retry attempts

§rate_limit: Option<RateLimit>

Optional rate limiting configuration

§model_mapping: HashMap<String, String>

Model name mappings (from client model names to provider model names)

§headers: HashMap<String, String>

Custom HTTP headers to include in requests

§enabled: bool

Whether this provider is enabled

§circuit_breaker: Option<CircuitBreakerConfig>

Optional circuit breaker configuration

Implementations§

Source§

impl ProviderConfig

Source

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

Create a new provider configuration.

§Arguments
  • name - Provider name/identifier
  • api_key - API key for authentication
§Examples
use ultrafast_models_sdk::providers::ProviderConfig;

let config = ProviderConfig::new("openai", "your-api-key");
Source

pub fn with_base_url(self, base_url: impl Into<String>) -> Self

Set the base URL for the provider API.

§Arguments
  • base_url - The base URL for API requests
Source

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

Set the request timeout duration.

§Arguments
  • timeout - The timeout duration
Source

pub fn with_rate_limit(self, rate_limit: RateLimit) -> Self

Set the rate limiting configuration.

§Arguments
  • rate_limit - The rate limiting configuration
Source

pub fn with_model_mapping( self, from: impl Into<String>, to: impl Into<String>, ) -> Self

Add a model name mapping.

§Arguments
  • from - The client model name
  • to - The provider model name
Source

pub fn with_header( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add a custom HTTP header.

§Arguments
  • key - The header name
  • value - The header value

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,