Skip to main content

ModelConfig

Struct ModelConfig 

Source
pub struct ModelConfig {
    pub spec: String,
    pub api_key: Option<String>,
    pub base_url: Option<String>,
    pub timeout: Option<Duration>,
}
Expand description

Configuration for creating a model from a string spec.

This allows specifying a model using the standard provider:model format while also providing custom API keys, base URLs, and other options.

§Examples

use serdes_ai_agent::ModelConfig;

// Simple: just a model spec (uses env vars for keys)
let config = ModelConfig::new("openai:gpt-4o");

// With explicit API key
let config = ModelConfig::new("anthropic:claude-3-5-sonnet-20241022")
    .with_api_key("sk-ant-your-key");

// With custom base URL (for proxies or compatible APIs)
let config = ModelConfig::new("openai:gpt-4o")
    .with_api_key("your-key")
    .with_base_url("https://your-proxy.com/v1");

Fields§

§spec: String

Model spec in provider:model format (e.g., “openai:gpt-4o”)

§api_key: Option<String>

Optional API key (overrides environment variable)

§base_url: Option<String>

Optional base URL (for custom endpoints)

§timeout: Option<Duration>

Optional request timeout

Implementations§

Source§

impl ModelConfig

Source

pub fn new(spec: impl Into<String>) -> ModelConfig

Create a new model config from a spec string.

The spec should be in provider:model format, e.g.:

  • "openai:gpt-4o"
  • "anthropic:claude-3-5-sonnet-20241022"
  • "groq:llama-3.1-70b-versatile"
  • "ollama:llama3.1"

If no provider prefix is given, OpenAI is assumed.

Source

pub fn with_api_key(self, api_key: impl Into<String>) -> ModelConfig

Set an explicit API key (overrides environment variable).

Source

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

Set a custom base URL (for proxies or compatible APIs).

Source

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

Set a request timeout.

Source

pub fn build_model(&self) -> Result<Arc<dyn Model>, ModelError>

Build a model from this configuration.

This creates the appropriate model type based on the provider, applying any custom API key, base URL, or timeout settings.

§Note

This method delegates to serdes_ai_models::infer_model_with_config when using default settings (no custom API key/base URL), or creates the model directly when custom configuration is provided.

The available providers depend on the features enabled in serdes-ai-models:

  • openai (default) - OpenAI models (gpt-4o, gpt-4, etc.)
  • anthropic - Anthropic models (claude-3-5-sonnet, etc.)
  • groq - Groq models
  • mistral - Mistral models
  • ollama - Local Ollama models
  • google - Google/Gemini models

Trait Implementations§

Source§

impl Clone for ModelConfig

Source§

fn clone(&self) -> ModelConfig

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 ModelConfig

Source§

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

Formats the value using the given formatter. 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> Same for T

Source§

type Output = T

Should always be Self
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> GraphState for T
where T: Clone + Send + Sync + Debug + 'static,