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 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
//! Prompts templating and management
//!
//! Prompts are first class citizens in Swiftide and use [tera] under the hood. tera
//! uses jinja style templates which allows for a lot of flexibility.
//!
//! Conceptually, a [Prompt] is something you send to i.e.
//! [`SimplePrompt`][crate::traits::SimplePrompt]. A prompt can have
//! added context for substitution and other templating features.
//!
//! Transformers in Swiftide come with default prompts, and they can be customized or replaced as
//! needed.
//!
//! [`PromptTemplate`] can be added with [`PromptTemplate::try_compiled_from_str`]. Prompts can also be
//! created on the fly from anything that implements [`Into<String>`]. Compiled prompts are stored in
//! an internal repository.
//!
//! Additionally, `PromptTemplate::String` and `PromptTemplate::Static` can be used to create
//! templates on the fly as well.
//!
//! It's recommended to precompile your templates.
//!
//! # Example
//!
//! ```
//! #[tokio::main]
//! # async fn main() {
//! # use swiftide_core::prompt::PromptTemplate;
//! let template = PromptTemplate::try_compiled_from_str("hello {{world}}").await.unwrap();
//! let prompt = template.to_prompt().with_context_value("world", "swiftide");
//!
//! assert_eq!(prompt.render().await.unwrap(), "hello swiftide");
//! # }
//! ```
use anyhow::{Context as _, Result};
use lazy_static::lazy_static;
use tera::Tera;
use tokio::sync::RwLock;
use uuid::Uuid;
use crate::node::Node;
lazy_static! {
/// Tera repository for templates
static ref TEMPLATE_REPOSITORY: RwLock<Tera> = {
let prefix = env!("CARGO_MANIFEST_DIR");
let path = format!("{prefix}/src/transformers/prompts/**/*.prompt.md");
match Tera::new(&path)
{
Ok(t) => RwLock::new(t),
Err(e) => {
tracing::error!("Parsing error(s): {e}");
::std::process::exit(1);
}
}
};
}
/// A Prompt can be used with large language models to prompt.
#[derive(Clone, Debug)]
pub struct Prompt {
template: PromptTemplate,
context: Option<tera::Context>,
}
/// A `PromptTemplate` defines a template for a prompt
#[derive(Clone, Debug)]
pub enum PromptTemplate {
CompiledTemplate(String),
String(String),
Static(&'static str),
}
impl PromptTemplate {
/// Creates a reference to a template already stored in the repository
pub fn from_compiled_template_name(name: impl Into<String>) -> PromptTemplate {
PromptTemplate::CompiledTemplate(name.into())
}
pub fn from_string(template: impl Into<String>) -> PromptTemplate {
PromptTemplate::String(template.into())
}
/// Extends the prompt repository with a custom [`tera::Tera`] instance.
///
/// If you have your own prompt templates or want to add other functionality, you can extend
/// the repository with your own [`tera::Tera`] instance.
///
/// WARN: Do not use this inside a pipeline or any form of load, as it will lock the repository
///
/// # Errors
///
/// Errors if the repository could not be extended
pub async fn extend(tera: &Tera) -> Result<()> {
TEMPLATE_REPOSITORY
.write()
.await
.extend(tera)
.context("Could not extend prompt repository with custom Tera instance")
}
/// Compiles a template from a string and returns a `PromptTemplate` with a reference to the
/// string.
///
/// WARN: Do not use this inside a pipeline or any form of load, as it will lock the repository
///
/// # Errors
///
/// Errors if the template fails to compile
pub async fn try_compiled_from_str(
template: impl AsRef<str> + Send + 'static,
) -> Result<PromptTemplate> {
let id = Uuid::new_v4().to_string();
let mut lock = TEMPLATE_REPOSITORY.write().await;
lock.add_raw_template(&id, template.as_ref())
.context("Failed to add raw template")?;
Ok(PromptTemplate::CompiledTemplate(id))
}
/// Renders a template with an optional `tera::Context`
///
/// # Errors
///
/// - Template cannot be found
/// - One-off template has errors
/// - Context is missing that is required by the template
pub async fn render(&self, context: &Option<tera::Context>) -> Result<String> {
use PromptTemplate::{CompiledTemplate, Static, String};
let template = match self {
CompiledTemplate(id) => {
let context = match &context {
Some(context) => context,
None => &tera::Context::default(),
};
let lock = TEMPLATE_REPOSITORY.read().await;
let available = lock.get_template_names().collect::<Vec<_>>().join(", ");
tracing::debug!(id, available, "Rendering template ...");
let result = lock.render(id, context);
if result.is_err() {
tracing::error!(
error = result.as_ref().unwrap_err().to_string(),
available,
"Error rendering template {id}"
);
}
result.with_context(|| format!("Failed to render template '{id}'"))?
}
String(template) => {
if let Some(context) = context {
Tera::one_off(template, context, false)
.context("Failed to render one-off template")?
} else {
template.to_string()
}
}
Static(template) => {
if let Some(context) = context {
Tera::one_off(template, context, false)
.context("Failed to render one-off template")?
} else {
(*template).to_string()
}
}
};
Ok(template)
}
/// Builds a Prompt from a template with an empty context
pub fn to_prompt(&self) -> Prompt {
Prompt {
template: self.clone(),
context: Some(tera::Context::default()),
}
}
}
impl From<&'static str> for PromptTemplate {
fn from(template: &'static str) -> Self {
PromptTemplate::Static(template)
}
}
impl From<String> for PromptTemplate {
fn from(template: String) -> Self {
PromptTemplate::String(template)
}
}
impl Prompt {
/// Adds an `ingestion::Node` to the context of the Prompt
#[must_use]
pub fn with_node(mut self, node: &Node) -> Self {
let context = self.context.get_or_insert_with(tera::Context::default);
context.insert("node", &node);
self
}
/// Adds anything that implements [Into<tera::Context>], like `Serialize` to the Prompt
#[must_use]
pub fn with_context(mut self, new_context: impl Into<tera::Context>) -> Self {
let context = self.context.get_or_insert_with(tera::Context::default);
context.extend(new_context.into());
self
}
/// Adds a key-value pair to the context of the Prompt
#[must_use]
pub fn with_context_value(mut self, key: &str, value: impl Into<tera::Value>) -> Self {
let context = self.context.get_or_insert_with(tera::Context::default);
context.insert(key, &value.into());
self
}
/// Renders a prompt
///
/// # Errors
///
/// See `PromptTemplate::render`
pub async fn render(&self) -> Result<String> {
self.template.render(&self.context).await
}
}
impl From<&'static str> for Prompt {
fn from(prompt: &'static str) -> Self {
Prompt {
template: PromptTemplate::Static(prompt),
context: None,
}
}
}
impl From<String> for Prompt {
fn from(prompt: String) -> Self {
Prompt {
template: PromptTemplate::String(prompt),
context: None,
}
}
}
#[cfg(test)]
mod test {
use super::*;
#[tokio::test]
async fn test_prompt() {
let template = PromptTemplate::try_compiled_from_str("hello {{world}}")
.await
.unwrap();
let prompt = template.to_prompt().with_context_value("world", "swiftide");
assert_eq!(prompt.render().await.unwrap(), "hello swiftide");
}
#[tokio::test]
async fn test_prompt_with_node() {
let template = PromptTemplate::try_compiled_from_str("hello {{node.chunk}}")
.await
.unwrap();
let node = Node::new("test");
let prompt = template.to_prompt().with_node(&node);
assert_eq!(prompt.render().await.unwrap(), "hello test");
}
#[tokio::test]
async fn test_one_off_from_string() {
let mut prompt: Prompt = "hello {{world}}".into();
prompt = prompt.with_context_value("world", "swiftide");
assert_eq!(prompt.render().await.unwrap(), "hello swiftide");
}
#[tokio::test]
async fn test_extending_with_custom_repository() {
let mut custom_tera = Tera::new("**/some/prompts.md").unwrap();
custom_tera
.add_raw_template("hello", "hello {{world}}")
.unwrap();
PromptTemplate::extend(&custom_tera).await.unwrap();
let prompt = PromptTemplate::from_compiled_template_name("hello")
.to_prompt()
.with_context_value("world", "swiftide");
assert_eq!(prompt.render().await.unwrap(), "hello swiftide");
}
#[tokio::test]
async fn test_coercion_to_prompt() {
// str
let raw: &str = "hello {{world}}";
let prompt: Prompt = raw.into();
assert_eq!(
prompt
.with_context_value("world", "swiftide")
.render()
.await
.unwrap(),
"hello swiftide"
);
let prompt: Prompt = raw.to_string().into();
assert_eq!(
prompt
.with_context_value("world", "swiftide")
.render()
.await
.unwrap(),
"hello swiftide"
);
}
#[tokio::test]
async fn test_coercion_to_template() {
let raw: &str = "hello {{world}}";
let prompt: PromptTemplate = raw.into();
assert_eq!(
prompt
.to_prompt()
.with_context_value("world", "swiftide")
.render()
.await
.unwrap(),
"hello swiftide"
);
let prompt: PromptTemplate = raw.to_string().into();
assert_eq!(
prompt
.to_prompt()
.with_context_value("world", "swiftide")
.render()
.await
.unwrap(),
"hello swiftide"
);
}
}