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 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
//! Botrs library
pub mod context;
/// Prompt generation logic
pub mod prompt;
/// Toolbox for sapiens
pub mod tools;
/// Runner for sapiens
pub mod runner;
/// OpenAI API client
pub mod openai;
use std::fmt::Debug;
use std::sync::{Arc, Weak};
use async_openai::types::Role;
use runner::Chain;
use tokio::sync::Mutex;
use tools::toolbox;
use tracing::debug;
use crate::context::{ChatEntry, ChatHistory};
use crate::openai::{Client, OpenAIError};
use crate::runner::{ModelResponse, TaskChain, Usage};
use crate::tools::toolbox::InvokeResult;
use crate::tools::TerminationMessage;
/// The error type for the bot
#[derive(thiserror::Error, Debug)]
pub enum Error {
/// Failed to add to the chat history
#[error("Failed to add to the chat history")]
ChatHistoryError(#[from] context::Error),
/// No response from the model
#[error("No response from the model")]
NoResponseFromModel,
/// The model returned an error
#[error("Model invocation failed")]
OpenAIError(#[from] OpenAIError),
/// Reached the maximum number of steps
#[error("Maximal number of steps reached")]
MaxStepsReached,
/// The response is too long
#[error("The response is too long: {0}")]
ActionResponseTooLong(String),
}
/// Configuration for the bot
#[derive(Debug, Clone)]
pub struct Config {
/// The model to use
pub model: String,
/// The maximum number of steps
pub max_steps: usize,
/// The minimum number of tokens that need to be available for completion
pub min_token_for_completion: usize,
/// The OpenAI chat completion request temperature
/// min: 0, max: 2, default: 1,
/// The higher the temperature, the crazier the text.
pub temperature: Option<f32>,
}
impl Default for Config {
fn default() -> Self {
Self {
model: "gpt-3.5-turbo".to_string(),
max_steps: 10,
min_token_for_completion: 512,
temperature: None,
}
}
}
/// An update from the model
#[derive(Debug, Clone)]
pub struct ModelUpdateNotification {
/// The message from the model
pub chat_entry: ChatEntry,
/// The number of tokens used by the model
pub usage: Option<Usage>,
}
impl From<ModelResponse> for ModelUpdateNotification {
fn from(res: ModelResponse) -> Self {
Self {
chat_entry: ChatEntry {
role: Role::Assistant,
msg: res.msg,
},
usage: res.usage,
}
}
}
/// Invocation success notification
pub struct InvocationSuccessNotification {
/// The tool name
pub tool_name: String,
/// The input
pub assistant_message: ChatEntry,
/// The result
pub res: Result<ChatEntry, Error>,
/// The number of tokens used by the model
pub usage: Option<Usage>,
/// Number of invocation blocks in the message
pub available_invocation_count: usize,
/// The input that was extracted from the message and passed to `tool_name`
pub extracted_input: String,
}
/// Invocation failure notification
pub struct InvocationFailureNotification {
/// The tool name
pub tool_name: String,
/// The input
pub assistant_message: ChatEntry,
/// The result
pub res: Result<ChatEntry, Error>,
/// The number of tokens used by the model
pub usage: Option<Usage>,
/// Number of invocation blocks in the message
pub available_invocation_count: usize,
/// The input that was extracted from the message and passed to `tool_name`
pub extracted_input: String,
}
/// Invalid invocation notification
pub struct InvalidInvocationNotification {
/// The input
pub assistant_message: ChatEntry,
/// The result
pub res: Result<ChatEntry, Error>,
/// The number of tokens used by the model
pub usage: Option<Usage>,
/// Number of invocation blocks in the message
pub available_invocation_count: usize,
}
/// Termination notification
pub struct TerminationNotification {
/// The messages
pub messages: Vec<TerminationMessage>,
}
/// Observer for the step progresses
#[async_trait::async_trait]
pub trait StepObserver: Send {
/// Called when the task is submitted
async fn on_task(&mut self, _task: &str) {}
/// Called when the task starts
async fn on_start(&mut self, _chat_history: &ChatHistory) {}
/// Called when the model updates the chat history
async fn on_model_update(&mut self, _event: ModelUpdateNotification) {}
/// Called when the tool invocation was successful
async fn on_invocation_success(&mut self, _event: InvocationSuccessNotification) {}
/// Called when no valid tool invocation was found
async fn on_invalid_invocation(&mut self, _event: InvalidInvocationNotification) {}
/// Called when the tool invocation failed
async fn on_invocation_failure(&mut self, _event: InvocationFailureNotification) {}
/// Called when the task is done
async fn on_termination(&mut self, _event: TerminationNotification) {}
}
/// A step in the task
pub struct Step {
task_chain: TaskChain,
observer: WeakStepObserver,
}
impl Step {
/// Run the task for a single step
async fn step(mut self) -> Result<StepOrStop, Error> {
debug!("Running step");
let model_response = self.task_chain.query_model().await?;
// Wrap the response as the chat history entry
let model_update = ModelUpdateNotification::from(model_response);
let usage = model_update.usage.clone();
// Show the message from the assistant
if let Some(observer) = self.observer.upgrade() {
observer
.lock()
.await
.on_model_update(model_update.clone())
.await;
}
// pass the message to the tools and get the response
let assistant_message = model_update.chat_entry;
let resp = self.task_chain.invoke_tool(&assistant_message.msg).await;
// report on the tool invocation
match resp {
InvokeResult::NoInvocationsFound { e } => {
let res = self
.task_chain
.on_invocation_failure(assistant_message.clone(), e);
if let Some(observer) = self.observer.upgrade() {
observer
.lock()
.await
.on_invalid_invocation(InvalidInvocationNotification {
assistant_message,
res,
usage,
available_invocation_count: 0,
})
.await;
}
}
InvokeResult::NoValidInvocationsFound {
e,
invocation_count: available_invocation_count,
} => {
let res = self
.task_chain
.on_invocation_failure(assistant_message.clone(), e);
if let Some(observer) = self.observer.upgrade() {
observer
.lock()
.await
.on_invalid_invocation(InvalidInvocationNotification {
assistant_message,
res,
usage,
available_invocation_count,
})
.await;
}
}
InvokeResult::Error {
invocation_count: available_invocation_count,
tool_name,
extracted_input,
e,
} => {
let res = self
.task_chain
.on_tool_failure(&tool_name, assistant_message.clone(), e);
if let Some(observer) = self.observer.upgrade() {
observer
.lock()
.await
.on_invocation_failure(InvocationFailureNotification {
assistant_message,
tool_name,
res,
usage,
available_invocation_count,
extracted_input,
})
.await;
}
}
InvokeResult::Success {
available_invocation_count,
tool_name,
extracted_input,
result,
} => {
// Got a response from the tool but the task is not done yet
let res = self.task_chain.on_tool_success(
&tool_name,
available_invocation_count,
assistant_message.clone(),
result,
);
if let Some(observer) = self.observer.upgrade() {
observer
.lock()
.await
.on_invocation_success(InvocationSuccessNotification {
assistant_message,
tool_name,
res,
usage,
available_invocation_count,
extracted_input,
})
.await;
}
}
}
// check if the task is done
if let Some(termination_messages) = self.task_chain.is_terminal().await {
if let Some(observer) = self.observer.upgrade() {
observer
.lock()
.await
.on_termination(TerminationNotification {
messages: termination_messages.clone(),
})
.await;
}
return Ok(StepOrStop::Stop {
stop: Stop {
termination_messages,
},
});
}
Ok(StepOrStop::Step { step: self })
}
}
/// The task is done
pub struct Stop {
/// The termination messages
pub termination_messages: Vec<TerminationMessage>,
}
/// A step or the task is done
pub enum StepOrStop {
/// The task is not done yet
Step {
/// The actual step task
step: Step,
},
/// The task is done
Stop {
/// the actual stopped task
stop: Stop,
},
}
/// Wrap an observer into the a [`StrongStepObserver<O>`] = [`Rc<Mutex<O>>`]
///
/// Use [`Arc::downgrade`] to get a [`Weak<Mutex<dyn StepObserver>>`] and pass
/// it to [`run_to_the_end`] for example.
pub fn wrap_observer<O: StepObserver + 'static>(observer: O) -> StrongStepObserver<O> {
Arc::new(Mutex::new(observer))
}
/// A strong reference to the observer
pub type StrongStepObserver<O> = Arc<Mutex<O>>;
/// A weak reference to the observer
pub type WeakStepObserver = Weak<Mutex<dyn StepObserver>>;
/// A void observer
pub struct VoidTaskProgressUpdateObserver;
#[async_trait::async_trait]
impl StepObserver for VoidTaskProgressUpdateObserver {}
impl StepOrStop {
/// Create a new [`StepOrStop`] for a `task`.
pub fn new(chain: Chain, task: String) -> Result<Self, Error> {
let task_chain = chain.start_task(task)?;
let observer = wrap_observer(VoidTaskProgressUpdateObserver {});
let observer = Arc::downgrade(&observer);
Ok(StepOrStop::Step {
step: Step {
task_chain,
observer,
},
})
}
}
impl StepOrStop {
/// Create a new [`StepOrStop`] for a `task`.
///
/// The `observer` will be called when the task starts and when a step is
/// completed - either successfully or not. The `observer` will be called
/// with the latest chat history element. It is also called on error.
pub async fn with_observer(
chain: Chain,
task: String,
observer: WeakStepObserver,
) -> Result<Self, Error> {
if let Some(observer) = observer.upgrade() {
observer.lock().await.on_task(&task).await;
}
let task_chain = chain.start_task(task)?;
// call the observer
if let Some(observer) = observer.upgrade() {
observer
.lock()
.await
.on_start(task_chain.chat_history())
.await;
}
Ok(StepOrStop::Step {
step: Step {
task_chain,
observer,
},
})
}
/// Run the task for the given number of steps
pub async fn run(mut self, max_steps: usize) -> Result<Stop, Error> {
debug!("run task for {} steps", max_steps);
for _ in 0..max_steps {
match self {
StepOrStop::Step { step } => {
self = step.step().await?;
}
StepOrStop::Stop { stop } => {
return Ok(stop);
}
}
}
Err(Error::MaxStepsReached)
}
/// Run the task for a single step
pub async fn step(self) -> Result<Self, Error> {
match self {
StepOrStop::Step { step } => step.step().await,
StepOrStop::Stop { stop } => Ok(StepOrStop::Stop { stop }),
}
}
/// is the task done?
pub fn is_done(&self) -> Option<Vec<TerminationMessage>> {
match self {
StepOrStop::Step { step: _ } => None,
StepOrStop::Stop { stop } => Some(stop.termination_messages.clone()),
}
}
}
/// Run until the task is done or the maximum number of steps is reached
///
/// See ['StepOrStop::new'], [`StepOrStop::step`] and ['StepOrStop::run] for
/// more flexible ways to run a task
#[tracing::instrument(skip(toolbox, openai_client, observer, config))]
pub async fn run_to_the_end(
toolbox: toolbox::Toolbox,
openai_client: Client,
config: Config,
task: String,
observer: WeakStepObserver,
) -> Result<Vec<TerminationMessage>, Error> {
let chain = Chain::new(toolbox, config.clone(), openai_client).await;
let step_or_stop = StepOrStop::with_observer(chain, task, observer).await?;
let stop = step_or_stop.run(config.max_steps).await?;
Ok(stop.termination_messages)
}