update wks_deploy

EI-Stack · Nov 29, 2024 · 53a0f23 · 53a0f23
1 parent 39163f7
commit 53a0f23
Show file tree

Hide file tree

Showing 6 changed files with 54 additions and 21 deletions.
diff --git a/docs/agentfabric_create_plan.mp4 b/docs/agentfabric_create_plan.mp4
diff --git a/docs/example_meeting.md b/docs/example_meeting.md
@@ -0,0 +1,7 @@
+## 範例_會議記錄小幫手
+
+## 即時語音轉文字會議記錄平台是一個專為學校班會和企業會議設計的高效工具，旨在簡化會議記錄的過程。用戶只需將錄製的語音檔上傳至平台，系統便能自動將語音內容轉換為文字，省去手動記錄的繁瑣。該平台支持多種語言的轉錄，確保不同語言背景的用戶均能輕鬆使用。其操作簡單直觀，無需專業技術知識，適合教師、學生及各類企業用戶。平台還重視數據安全，確保上傳的會議內容不會被未經授權的第三方訪問。透過這一工具，用戶能夠專注於會議討論，而不必擔心記錄的準確性和完整性，從而提升會議的效率和效果。
+
+# 創建步驟請參考，範例_長照法規AGENT
+
+
diff --git a/docs/images/123.png b/docs/images/123.png
diff --git a/docs/images/456.png b/docs/images/456.png
diff --git a/docs/index.md b/docs/index.md
@@ -13,27 +13,6 @@ Agent Fabric 產品簡化了 Agent 開發流程，使使用者可以專注於業
 * **知識庫資料的安全與獨立性**：確保知識庫中的資料安全，提供數據加密和存取控制功能，並實現資料的獨立性，確保每個使用者的資料與其他使用者的資料隔離，防止資料洩露或未經授權的訪問。
 * **Agent 統一落地接口**：提供統一格式的 API 接口，方便使用者後續的開發工作。
 
-## 使用方法
-
-提供 RESTful API 接口進行工作室和其他服務串接：
-
-```python
-import requests
-import json
-
-url = "{host}/api/workspaces/app/{id}/chat-messages"  # id: 工作室 id
-
-payload = json.dumps({
-  "query": "今天天氣如何"
-})
-headers = {
-  'Content-Type': 'application/json'
-}
-
-response = requests.post(url, headers=headers, data=payload)
-
-print(response.text)
-```
 
 ## 文件說明
 

diff --git a/docs/wks_deploy.md b/docs/wks_deploy.md
@@ -1,2 +1,49 @@
 # 工作室接入
 
+
+提供 RESTful API 接口進行工作室和其他服務串接：
+# API KEY位置
+
+---
+
+## 步驟說明
+
+### 1. 獲取 API
+- 進入 **工作室**。
+- 點擊三個點選項，獲取 API。
+![本地圖片](./images/123.png "本地圖片示例")
+
+---
+
+### 2. 確認 API 的 URL
+- 在橘色方框中可以找到 ID的位置。
+![本地圖片](./images/456.png "本地圖片示例")
+
+### 3. 可以使用restful API的格式請求服務:
+```python
+import requests
+
+url = "https://{host}/api/workspaces/apps/{id}/chat-messages"
+
+payload = {'session': 'xxxxxxxx',
+'text': '請產生會議紀錄'}
+files=[
+  ('file',('會議記錄.mp3',open('會議記錄.mp3','rb'),'audio/mpeg'))
+]
+headers = {
+  'API-KEY': 'xxxxxxx'  
+}
+
+response = requests.request("POST", url, headers=headers, data=payload, files=files)
+
+print(response.text)
+
+```
+##### 工具註解
+
+| 參數          | 說明                                                                                         |
+|---------------|----------------------------------------------------------------------------------------------|
+| **session**   | 同一次對話的 `uuid`，類型為 `str`，非必填。                                                    |
+| **text**      | 要求服務執行的內容。如果 `file` 中有資料，可以不用填寫。例如：「請幫我整理會議記錄」。              |
+| **file**      | 要請服務處理的檔案，目前支援格式：`mp3`、`pdf`、`jpg`、`png`。                                    |
+| **API-KEY**   | 需向 AgentFabric 管理員申請 ID。