Umami Analytics

🚀 Umami 使用指南

Umamiは、特定の分析ニーズを満たすためにカスタマイズ可能なサービスです。このガイドでは、Umamiのインストール、設定、カスタマイズ方法を説明します。

🚀 クイックスタート

Umamiを使用するためには、まずインストールと設定を行う必要があります。以下の手順に従って進めてください。

📦 インストール

1.1 依存関係のインストール

必要なPythonパッケージをインストールするには、以下のコマンドを実行します。

pip install umami python-dotenv fastapi uvicorn

1.2 環境変数の設定

.envファイルを作成し、以下の内容を追加します。

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

1.3 サービスの起動

以下のコマンドを実行して、Umamiサービスを起動します。

uvicorn --reload src.analytics_service.app:app

💻 使用例

2.1 新しいプロンプトの追加

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
                }
            ]
        }
    ]

2.2 プロンプトロジックの実装

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['参数名称']}。"
                    }
                }
            ]
        }

2.3 メッセージ構造の説明

• ロールフィールド：

  • role: "user"：ユーザーの入力または質問をシミュレートします。
  • role: "assistant"：Claudeの応答または命令を表します。
  • role: "system"：コンテキストを設定するか、高レベルの命令を提供します。

• コンテンツタイプ：

  • "type": "text"：純粋なテキストコンテンツに使用します。
  • "type": "resource"：外部リソース（ファイル、ログなど）を含みます。uri、text、mimeType 属性を指定する必要があります。

📚 ドキュメント

3. ベストプラクティス

• 明確性：プロンプトを集中的かつ具体的にします。
• パラメータ名：説明的な名前を使用し、サンプル値を提供します。
• エラー処理：異常な状況や境界条件を考慮します。
• テスト検証：さまざまな入力でプロンプトをテストし、その有効性と信頼性を確保します。

以上の手順に従って、Umamiサービスをカスタマイズし、特定の分析ニーズを満たすことができます。