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

//! Default system instructions.

use ferrin_spec::BoxFuture;
use ferrin_spec::CallOptions;
use ferrin_spec::error::ProviderError;
use ferrin_spec::language_model::prompt::PromptMessage;

use crate::middleware::LanguageModelMiddleware;
use crate::middleware::MiddlewareContext;
use crate::prompt::Instructions;

/// Middleware created by [`default_instructions`].
#[derive(Debug, Clone)]
pub struct DefaultInstructions {
    instructions: Instructions,
}

/// Prepends `instructions` as system messages when the prompt has no
/// system message.
#[must_use]
pub fn default_instructions(instructions: impl Into<Instructions>) -> DefaultInstructions {
    DefaultInstructions {
        instructions: instructions.into(),
    }
}

impl LanguageModelMiddleware for DefaultInstructions {
    fn transform_params<'a>(
        &'a self,
        mut options: CallOptions,
        _ctx: MiddlewareContext<'a>,
    ) -> BoxFuture<'a, Result<CallOptions, ProviderError>> {
        let has_system = options
            .prompt
            .iter()
            .any(|message| matches!(message, PromptMessage::System { .. }));
        if !has_system {
            options.prompt.splice(
                0..0,
                self.instructions
                    .as_messages()
                    .iter()
                    .map(|message| PromptMessage::System {
                        content: message.content.clone(),
                        provider_options: message.provider_options.clone(),
                    }),
            );
        }
        Box::pin(async move { Ok(options) })
    }
}