llm_chain/prompt/
mod.rs

1//! Module implementing prompts and prompt templates.
2//! Contains the `prompt!` macro, Prompts and PromptTemplates.
3
4mod chat;
5mod model;
6mod serialization;
7mod string_template;
8
9pub use string_template::{StringTemplate, StringTemplateError};
10
11pub use chat::{ChatMessage, ChatMessageCollection, ChatRole};
12pub use model::Data;
13
14/// A prompt template.
15///
16/// A prompt template is a template that can be used to generate a prompt.
17pub type PromptTemplate = Data<StringTemplate>;
18/// A prompt.
19///
20/// A prompt input for an LLM model.
21pub type Prompt = Data<String>;
22
23/// A chat conversation.
24///
25/// A chat conversation is a collection of chat messages.
26pub type Conversation = ChatMessageCollection<String>;
27
28/// A chat conversation of string templates.
29///
30/// A chat conversation is a collection of chat messages that contain string templates.
31pub type ConversationTemplate = ChatMessageCollection<StringTemplate>;
32
33/// Creates a `TextPrompt` or a `ChatPrompt` based on the number of arguments provided.
34///
35/// If there is only one argument, it creates a `TextPrompt` with the provided template. However,
36/// if you prefix it with system:, assistant: or user: it will create a `ChatPrompt` with the provided
37/// template as the system, assistant or user message respectively.
38/// If there are two arguments, it creates a `ChatPrompt` with the first message as the system
39/// message and the second message as the user message. You may add a "conversation: your_conversation" to include a conversation.
40/// If there are more than two arguments, a compile-time error is produced.
41///
42/// # Example
43///
44/// ```rust
45/// use llm_chain::prompt;
46/// let text_prompt = prompt!("Hello {{name}}!");
47/// assert_eq!(format!("{}", text_prompt), "Hello {{name}}!");
48///
49/// let chat_prompt = prompt!("You are a helpful assistant.", "What is the meaning of life?");
50/// assert_eq!(format!("{}", chat_prompt), "System: You are a helpful assistant.\nUser: What is the meaning of life?\n");
51///
52/// let role_prompt = prompt!(system: "You are a helpful assistant.");
53/// assert_eq!(format!("{}", role_prompt), "System: You are a helpful assistant.\n");
54/// ```
55#[macro_export]
56macro_rules! prompt {
57    (user: $user_arg:expr $(,)?) => {
58        $crate::prompt::Data::Chat(
59            $crate::prompt::ChatMessageCollection::<$crate::prompt::StringTemplate>::new()
60                .with_user_template($user_arg),
61        )
62    };
63    (assistant: $assistant_arg:expr $(,)?) => {
64        $crate::prompt::Data::Chat(
65            $crate::prompt::ChatMessageCollection::<$crate::prompt::StringTemplate>::new()
66                .with_assistant_template($assistant_arg),
67        )
68    };
69    (system: $system_arg:expr $(,)?) => {
70        $crate::prompt::Data::Chat(
71            $crate::prompt::ChatMessageCollection::<$crate::prompt::StringTemplate>::new()
72                .with_system_template($system_arg),
73        )
74    };
75    ($single_arg:expr) => {
76        $crate::prompt::Data::Text($crate::prompt::StringTemplate::tera($single_arg))
77    };
78    ($system_arg:expr, $user_arg:expr $(,)?) => {
79        $crate::prompt::Data::Chat(
80            $crate::prompt::ChatMessageCollection::<$crate::prompt::StringTemplate>::new()
81                .with_system_template($system_arg)
82                .with_user_template($user_arg),
83        )
84    };
85    ($($extra_tokens:expr),+ $(,)?) => {
86        compile_error!("The 'prompt!' macro takes at most 2 arguments.")
87    };
88}
llm_chain/prompt/mod.rs

llm_chain/prompt/
mod.rs
