ferrin-core 0.2.0

Ferrin core: text generation loop, streaming pipeline, structured output, agents, middleware, registry.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

//! Default embedding call settings.

use ferrin_spec::BoxFuture;
use ferrin_spec::Headers;
use ferrin_spec::ProviderOptions;
use ferrin_spec::embedding_model::EmbedOptions;
use ferrin_spec::error::ProviderError;

use super::default_settings::merge_provider_options;
use crate::middleware::EmbeddingMiddlewareContext;
use crate::middleware::EmbeddingModelMiddleware;

/// Settings applied when the embedding call does not set them.
///
/// `headers` and `provider_options` are merged with the call's values taking
/// precedence (provider options merge recursively).
#[derive(Debug, Clone, Default)]
pub struct EmbeddingDefaults {
    /// See [`EmbedOptions::headers`].
    pub headers: Headers,
    /// See [`EmbedOptions::provider_options`].
    pub provider_options: ProviderOptions,
}

/// Middleware created by [`default_embedding_settings`].
#[derive(Debug, Clone)]
pub struct DefaultEmbeddingSettings {
    defaults: EmbeddingDefaults,
}

/// Fills unset embedding call options from `defaults`.
#[must_use]
pub fn default_embedding_settings(defaults: EmbeddingDefaults) -> DefaultEmbeddingSettings {
    DefaultEmbeddingSettings { defaults }
}

impl DefaultEmbeddingSettings {
    /// Applies the defaults to `options`.
    #[must_use]
    pub fn apply(&self, mut options: EmbedOptions) -> EmbedOptions {
        let defaults = &self.defaults;
        if !defaults.headers.is_empty() {
            let mut headers = defaults.headers.clone();
            headers.merge(&options.headers);
            options.headers = headers;
        }
        if !defaults.provider_options.is_empty() {
            options.provider_options =
                merge_provider_options(&defaults.provider_options, options.provider_options);
        }
        options
    }
}

impl EmbeddingModelMiddleware for DefaultEmbeddingSettings {
    fn transform_params<'a>(
        &'a self,
        options: EmbedOptions,
        _ctx: EmbeddingMiddlewareContext<'a>,
    ) -> BoxFuture<'a, Result<EmbedOptions, ProviderError>> {
        let options = self.apply(options);
        Box::pin(async move { Ok(options) })
    }
}