update human in loop

EI-Stack · Dec 13, 2024 · 1b3ada6 · 1b3ada6
1 parent cae58f8
commit 1b3ada6
Show file tree

Hide file tree

Showing 14 changed files with 74 additions and 0 deletions.
diff --git a/docs/example_leave.md b/docs/example_leave.md
@@ -0,0 +1,62 @@
+# 請假小幫手
+---
+**在現代工作和學習環境中，請假流程的簡化對於提高效率至關重要。以下是針對請假小幫手的設計，該系統可應用於學校和公司，並由三個主要代理（agents）組成，以便快速且簡單地處理請假申請。第一個 para_checker agent，功能是讓使用者填入必要參數，包含:name-請假人姓名, start_date-請假開始日期, end_date-請假結束日期。第二個 calendar_checker agent ，確認請假者是否在當期有會議。第三個 leave_apply agent ，使用工具，送出休假申請。**
+---
+
+## 步驟指南
+
+### 1. 點選編輯
+![本地圖片](./images/T1.png "本地圖片示例")
+
+### 2. 點選標題 1 筆刷
+![本地圖片](./images/T11.png "本地圖片示例")
+### 3. 編輯第一個 `para_checker` agent 的名稱和描述
+- **範例**：
+  - 名稱：`para_checker`
+  - 描述：必要參數包含：
+    - `name` - 請假人姓名
+    - `start_date` - 請假開始日期
+    - `end_date` - 請假結束日期
+  - 按送出。
+![本地圖片](./images/T12.png "本地圖片示例")
+---
+
+### 4. 編輯第二個 `calendar_checker` agent 的名稱、描述、任務、選擇工具
+- **範例**：
+  - 名稱：`calendar_checker`
+  - 描述：使用工具，確認休假申請人在休假期間是否有會議。
+  - 任務：使用工具，確認休假申請人在休假期間是否有會議。
+  - 選擇工具：`# fake_demo./user_info`
+  - 按送出。
+![本地圖片](./images/T13.png "本地圖片示例")
+---
+
+### 5. 編輯第三個 `leave_apply` agent 的名稱、描述、任務、選擇工具
+- **範例**：
+  - 名稱：`leave_apply`
+  - 描述：使用工具，送出休假申請。
+  - 任務：使用工具，送出休假申請。
+  - 選擇工具：`# fake_demo./leave_application`
+  - 按送出。
+![本地圖片](./images/T14.png "本地圖片示例")
+---
+
+### 6. 自訂範例
+- **橘框**：預設開場白。
+- **綠框**：新增範例選項。
+- 按藍框的「儲存」。
+![本地圖片](./images/T15.png "本地圖片示例")
+---
+
+## 成果展示
+
+### 7. 點選工作室的「請假小幫手」
+進入畫面後點選紅框進行請假，並輸入以下資訊：
+- 姓名：Alice Wang
+![本地圖片](./images/T16.png "本地圖片示例")
+### 8. 輸入請假期間
+- 範例：12/1~12/10
+![本地圖片](./images/T17.png "本地圖片示例")
+### 9. 輸入「確認」
+- 完成請假程序。
+![本地圖片](./images/T18.png "本地圖片示例")
diff --git a/docs/human_in_loop.md b/docs/human_in_loop.md
@@ -0,0 +1,10 @@
+# 確認參數設定
+讓Agent確認使用者是否有輸入必要參數，確認後才會往下進行。
+
+## 設定方法
+![本地圖片](./images/eee.png "本地圖片示例")
+
+1. agent名稱**一定要**叫**para_checker**
+2. 描述的寫法: "必要參數包含:" + {參數名稱} 及 {參數說明};
+    例:必要參數包含:name-請假人姓名, start_date-請假開始日期, end_date-請假結束日期
+3. 其他agent可以依照各自的業務邏輯進行安排
diff --git a/docs/images/T1.png b/docs/images/T1.png
diff --git a/docs/images/T11.png b/docs/images/T11.png
diff --git a/docs/images/T12.png b/docs/images/T12.png
diff --git a/docs/images/T13.png b/docs/images/T13.png
diff --git a/docs/images/T14.png b/docs/images/T14.png
diff --git a/docs/images/T15.png b/docs/images/T15.png
diff --git a/docs/images/T16.png b/docs/images/T16.png
diff --git a/docs/images/T17.png b/docs/images/T17.png
diff --git a/docs/images/T18.png b/docs/images/T18.png
diff --git a/docs/images/eee.png b/docs/images/eee.png
diff --git a/docs/images/para_checker.png b/docs/images/para_checker.png
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -8,10 +8,12 @@ nav:
     - 知識庫: kdb.md
     - 工作室: wks.md
     - API工具的使用: tools.md
+    - 確認參數設定: human_in_loop.md
     - 工作室串接: wks_deploy.md
     - 範例:
         - 如何使用知識庫_長照法規 AGENT 的創建: examples_rag.md
         - 如何使用語音轉文字功能_語音轉文字_會議記錄小幫手: example_record.md
         - 如何創建讀取圖片的服務_營養師團隊: example_nutri.md
         - 如何使用API工具_會議室安排團隊: example_meeting_arr.md
+        - 如何使用確認參數_請假小幫手: example_leave.md