Skip to main content

RemoteProviderConfig

Struct RemoteProviderConfig 

Source
pub struct RemoteProviderConfig {
    pub base_url: String,
    pub model: String,
    pub api_key: Option<SecretString>,
    pub dimension: u32,
    pub request_dimensions: bool,
    pub normalize: bool,
    pub batch_size: usize,
    pub timeout: Duration,
    pub max_retries: u32,
}
Expand description

What a deployment declares about its endpoint.

Fields§

§base_url: String

API root the /embeddings path is appended to, e.g. https://api.openai.com/v1 or http://ollama:11434/v1.

§model: String

Model name as the endpoint knows it, e.g. text-embedding-3-small.

§api_key: Option<SecretString>

Bearer credential. None for an endpoint that takes no credential (a self-hosted server on a private network).

§dimension: u32

Vector width the deployment’s column was migrated with. Every vector the endpoint returns is checked against it.

§request_dimensions: bool

Send the dimensions request field. Models that support Matryoshka truncation (text-embedding-3-*) then return exactly dimension lanes; a model of a fixed width ignores or rejects the field, and a deployment on such a model turns this off and sets dimension to the model’s native width.

§normalize: bool

L2-normalize every vector before it is stored.

§batch_size: usize

Inputs per request. The endpoint’s own limit is the ceiling; 64 is well under every known one.

§timeout: Duration

Per-request timeout. The caller’s budget shortens it, never lengthens.

§max_retries: u32

How many times a chunk is re-sent after a transient refusal — a rate limit or a gateway that is briefly unwell.

One 503 otherwise drops a whole ingest batch’s vectors, and the nodes stay unembedded until something touches them again. Zero turns retries off. The caller’s remaining budget is the real ceiling: a retry that would start after the deadline is not attempted, so this can never make a request outlive the request that asked for it.

Implementations§

Source§

impl RemoteProviderConfig

Source

pub fn new(base_url: impl Into<String>, model: impl Into<String>) -> Self

The text-embedding-3-small shape at the gear’s default width: 384 lanes requested through the dimensions field, normalized.

Source

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

Attach the bearer credential.

Trait Implementations§

Source§

impl Clone for RemoteProviderConfig

Source§

fn clone(&self) -> Self

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 RemoteProviderConfig

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 = !

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

fn try_from(value: U) -> Result<T, !>

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