Umami Analytics

🚀 Umami 使用指南

Umami 是一款實用的服務工具，通過一系列安裝配置步驟，可實現自定義提示功能，滿足特定的分析需求。

🚀 快速開始

安裝依賴

運行以下命令安裝必要的 Python 包：

pip install umami python-dotenv fastapi uvicorn

配置環境變量

創建一個 .env 文件，並添加以下內容：

DB_HOST=your-database-host
DB_PORT=5432
DB_NAME=umami
DB_USER=umami_user
DB_PASSWORD=your-database-password

啟動服務

運行以下命令啟動 Umami 服務：

uvicorn --reload src.analytics_service.app:app

✨ 主要特性

• 支持自定義提示，可根據需求添加新的提示並實現相應邏輯。
• 具備清晰的消息結構說明，方便用戶理解和使用。

📦 安裝指南

安裝依賴

運行以下命令安裝必要的 Python 包：

pip install umami python-dotenv fastapi uvicorn

配置環境變量

創建一個 .env 文件，並添加以下內容：

DB_HOST=your-database-host
DB_PORT=5432
DB_NAME=umami
DB_USER=umami_user
DB_PASSWORD=your-database-password

啟動服務

運行以下命令啟動 Umami 服務：

uvicorn --reload src.analytics_service.app:app

💻 使用示例

基礎用法

添加新提示

在 src/analytics_service/server.py 中，修改 list_prompts() 函數以添加自定義提示。

@app.list_prompts()
async def list_prompts():
    return [
        # 現有提示...
        {
            "name": "Your Prompt Name",
            "description": "您的提示描述。",
            "arguments": [
                {
                    "name": "參數名稱 1",
                    "description": "參數描述。",
                    "required": True
                },
                {
                    "name": "參數名稱 2",
                    "description": "參數描述。",
                    "required": False
                }
            ]
        }
    ]

實現提示邏輯

在 src/analytics_service/server.py 中，修改 get_prompt() 函數以處理新提示。

@app.get_prompt()
async def get_prompt(name: str, arguments: Any):
    if name == "Your Prompt Name":
        return {
            "messages": [
                {
                    "role": "user",
                    "content": {
                        "type": "text",
                        "text": f"您的提示模板，包含{arguments['參數名稱']}。"
                    }
                }
            ]
        }

高級用法

消息結構說明

• 角色字段：

  • role: "user"：模擬用戶輸入或問題。
  • role: "assistant"：表示 Claude 的響應或指令。
  • role: "system"：設置上下文或提供高層次的指令。

• 內容類型：

  • "type": "text"：用於純文本內容。
  • "type": "resource"：包含外部資源，如文件、日誌等。需要指定 uri、text 和 mimeType 屬性。

📚 詳細文檔

最佳實踐

• 明確性：使提示專注且具體。
• 參數命名：使用描述性的名稱，並提供示例值。
• 錯誤處理：考慮異常情況和邊界條件。
• 測試驗證：用不同輸入測試提示，確保其有效性和可靠性。

通過以上步驟，您可以自定義 Umami 服務，滿足特定的分析需求。