From 2137416e456b7cbc7168e8d93b0a556e3bd4984d Mon Sep 17 00:00:00 2001 From: Geoff Seemueller Date: Thu, 5 Dec 2024 09:39:50 -0500 Subject: [PATCH] Update README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 19c005e..ab4dfcb 100644 --- a/README.md +++ b/README.md @@ -192,6 +192,9 @@ const operator = new WorkflowOperator('example', async state => { }); ``` +## The Secret +This documentation doesn't communicate the most critical component for understanding the funcitonality/utility of this library. The intent service evaluates the `latestHumanMessage` and/or `latestAiMessage` again after operator exection. For the most simple example of how this behavior works: to terminate workflow execution in the operator, set `latestHumanMessage` and/or `latestAiMessage` in state to empty strings in the resulting state of the operators. + ## Error Handling The library includes built-in error handling for: @@ -227,4 +230,4 @@ bun run build # Fix formatting and lint issues bun run fix -``` \ No newline at end of file +```