Skip to main content

CompatibleConfig

Struct CompatibleConfig 

Source
pub struct CompatibleConfig {
    pub provider_name: String,
    pub api_key: String,
    pub base_url: String,
    pub model: String,
    pub max_tokens: u32,
    pub embedding_model: Option<String>,
    pub completion_tokens_param: Option<CompletionTokensParam>,
    pub vision: Option<bool>,
}
Expand description

Configuration for CompatibleProvider.

Pass to CompatibleProvider::new instead of individual positional arguments to avoid silent parameter transposition.

§Examples

use zeph_llm::compatible::{CompatibleConfig, CompatibleProvider};

let cfg = CompatibleConfig {
    provider_name: "together-ai".into(),
    api_key: "key".into(),
    base_url: "https://api.together.xyz/v1".into(),
    model: "meta-llama/Llama-3.3-70B-Instruct-Turbo".into(),
    max_tokens: 4096,
    embedding_model: None,
    completion_tokens_param: None,
    vision: None,
};
let provider = CompatibleProvider::new(cfg);

Fields§

§provider_name: String

Human-readable provider name used in logs and LlmProvider::name.

§api_key: String

Secret API key sent in the Authorization: Bearer header.

§base_url: String

Base URL of the endpoint, e.g. "https://api.together.xyz/v1".

§model: String

Chat model identifier.

§max_tokens: u32

Upper bound on completion tokens returned by the model.

§embedding_model: Option<String>

Embedding model identifier. Set to None when the endpoint does not support embeddings.

§completion_tokens_param: Option<CompletionTokensParam>

Override which token-limit parameter is used in API requests.

When None, the provider infers the correct field from the model name via the built-in prefix table. Set explicitly for models the table does not recognise (e.g. fine-tuned reasoning models whose names do not start with o + digit).

§vision: Option<bool>

Explicit vision-capability override.

OpenAiProvider’s built-in model-name prefix table cannot recognise arbitrary compatible endpoint model names (Together AI, local vLLM, etc.), so it fails safe to false for all of them. Set this when the endpoint’s configured model actually accepts image input.

Trait Implementations§

Source§

impl Clone for CompatibleConfig

Source§

fn clone(&self) -> CompatibleConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CompatibleConfig

Source§

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

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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: Sized + 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: Sized + 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<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