# 通知設計書 50-AI設定不完全

## 概要

本ドキュメントは、sp_BlitzCacheストアドプロシージャにおいて、AI機能（@AI = 1）が有効化されているが、必要な設定が不足している場合に発生するエラー通知の設計を記載する。

### 本通知の処理概要

本通知は、sp_BlitzCacheのAI分析機能を使用しようとした際に、必要な構成パラメータ（@AIModel、@AIURL、@AISystemPrompt、@AICredential、@AIPayloadTemplate）のいずれかが設定されていない場合にエラーメッセージを出力し、処理を中断する機能を提供する。

**業務上の目的・背景**：sp_BlitzCacheはバージョン8.xから、AIを活用したクエリプラン分析機能を提供している。この機能は外部のAIエンドポイント（Azure OpenAI等）を呼び出してクエリプランの問題点を分析する。AIエンドポイントへの接続には、モデル名、URL、認証情報、システムプロンプト、ペイロードテンプレートなどの設定が必要である。これらの設定が不完全な状態でAI機能を使用しようとすると、実行時エラーが発生するため、事前にパラメータ検証を行いユーザーに通知する。

**通知の送信タイミング**：sp_BlitzCacheプロシージャの実行開始後、AI設定の検証フェーズにおいて@AI = 1であり、かつ必要なパラメータのいずれかがNULLの場合に送信される。

**通知の受信者**：sp_BlitzCacheを実行したSQL Serverクライアントセッション。RAISERRORステートメントによりクライアントに直接エラーメッセージが返される。

**通知内容の概要**：エラーメッセージには、@AIが1に設定されているが、必要な構成のすべてが含まれていないことが明示される。

**期待されるアクション**：ユーザーは通知内容を確認し、(1) @AIModel、@AIURL、@AISystemPrompt、@AICredential、@AIPayloadTemplateのすべてを正しく設定する、(2) @AI = 0に設定してAI機能を無効化する、のいずれかのアクションを取る。

## 通知種別

RAISERRORによるSQL Server警告メッセージ（クライアント通知）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中（Severity 12） |
| リトライ | なし |

### 送信先決定ロジック

sp_BlitzCacheを実行したクライアントセッションに対して、RAISERRORステートメントにより直接エラーメッセージを送信する。

## 通知テンプレート

### エラーメッセージ

| 項目 | 内容 |
|-----|------|
| メッセージレベル | 12 |
| 状態 | 1 |
| 形式 | テキスト |

### 本文テンプレート

```
@AI is set to 1, but not all of the necessary configuration is included.
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | 固定メッセージのため変数なし | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ実行 | sp_BlitzCache実行 | @AI = 1 AND (@AIModel IS NULL OR @AIURL IS NULL OR @AISystemPrompt IS NULL OR @AICredential IS NULL OR @AIPayloadTemplate IS NULL) | AI設定検証フェーズで検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @AI = 0または未指定の場合 | AI機能が無効のため検証不要 |
| すべてのAI関連パラメータがNOT NULLの場合 | 設定が完了しているため正常処理 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sp_BlitzCache実行開始] --> B[AIパラメータデフォルト設定]
    B --> C{@Debug = 2?}
    C -->|Yes| D[AI設定情報をSELECT出力]
    C -->|No| E{@AI = 1?}
    D --> E
    E -->|No| F[通常処理へ]
    E -->|Yes| G{必要パラメータがすべてNOT NULL?}
    G -->|Yes| F
    G -->|No| H[RAISERROR: AI設定不完全]
    H --> I[RETURN - 処理中断]
```

## データベース参照・更新仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし | パラメータ検証のみのためテーブル参照なし | - |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | なし | エラー発生時は即座にRETURNするため更新なし |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| AI設定不完全 | @AI = 1 かつ必要パラメータのいずれかがNULL | エラーメッセージを出力し処理中断 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライなし） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし（プロシージャ実行時に即時送信）

## セキュリティ考慮事項

- AI認証情報（@AICredential）の値はエラーメッセージに含めない
- エラーメッセージにはシステム内部情報は含まれない
- @Debug = 2の場合のみAI設定情報が出力されるため、本番環境では使用しない

## 備考

- AI機能はsp_BlitzCache 8.x以降で追加された新機能
- @AIのデフォルト値は0（無効）
- @AIPayloadTemplateはJSON形式でAIエンドポイントへのリクエストボディを定義
- @AISystemPromptはAIへのシステムプロンプト（分析方法の指示）を含む
- @AICredentialはDATABASE SCOPED CREDENTIALの名前を指定

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

AI関連のパラメータ定義を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | @AI、@AIModel、@AIURL、@AISystemPrompt、@AICredential、@AIPayloadTemplateパラメータの定義 |

**読解のコツ**: @AIはTINYINT型で0/1/2の値を取り、0=無効、1=有効、2=自動（sp_invoke_external_rest_endpointの存在確認後に決定）。

#### Step 2: AIペイロードテンプレートのデフォルト設定

AIリクエストのペイロード構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | @AIPayloadTemplateのデフォルト設定（行985-997） |

**主要処理フロー**:
1. **行985-997**: JSON形式のペイロードテンプレート定義
2. テンプレート内の@AISystemPromptと@CurrentAIPromptがプレースホルダーとして使用される

#### Step 3: AI設定検証ロジック

AI設定の検証と本エラーの発生条件を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | AI設定検証セクション（行999-1010） |

**主要処理フロー**:
1. **行999**: IF @Debug = 2 OR (@AI = 1 AND 必要パラメータのいずれかがNULL)
2. **行1001-1003**: AI設定情報をSELECT出力（デバッグ用）
3. **行1006**: IF @AI = 1 AND 必要パラメータのいずれかがNULL
4. **行1008**: RAISERROR('@AI is set to 1, but not all of the necessary configuration is included.', 12, 1)
5. **行1009**: RETURN

### プログラム呼び出し階層図

```
sp_BlitzCache
    │
    ├─ パラメータ初期化
    │
    ├─ AIパラメータ初期化
    │      ├─ @AISystemPromptデフォルト設定
    │      └─ @AIPayloadTemplateデフォルト設定（行985-997）
    │
    ├─ AI設定検証（行999-1010）
    │      │
    │      ├─ @Debug = 2の場合
    │      │      └─ AI設定情報をSELECT出力
    │      │
    │      └─ @AI = 1の場合
    │             │
    │             ├─ 必要パラメータがすべてNOT NULL?
    │             │      │
    │             │      ├─ Yes → 処理継続
    │             │      │
    │             │      └─ No → RAISERROR（本通知）
    │             │               └─ RETURN
    │             │
    │             └─ 処理継続
    │
    └─ メイン分析処理
           │
           └─ AI分析（@AI = 1の場合）
                  ├─ AIプロンプト構築
                  ├─ AIエンドポイント呼び出し
                  └─ AI分析結果処理
```

### データフロー図

```
[入力]                         [処理]                              [出力]

@AI ──────────────────┐
                      │
@AIModel ─────────────┤
                      │
@AIURL ───────────────┼──▶ NULL判定 ──▶ @AI = 1?
                      │                     │
@AISystemPrompt ──────┤                     ▼
                      │              必要パラメータ
@AICredential ────────┤              NULLチェック
                      │                     │
@AIPayloadTemplate ───┘        ┌────────────┴────────────┐
                               ▼                         ▼
                        [すべてNOT NULL]           [いずれかNULL]
                               │                         │
                               ▼                         ▼
                          処理継続              RAISERROR → クライアント
                               │                "@AI is set to 1, but
                               │                 not all of the necessary
                               ▼                 configuration is included."
                         AI分析実行
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzCache.sql | `sp_BlitzCache.sql` | ソース | キャッシュ分析プロシージャ、通知発生元（行1008） |
| Install-All-Scripts.sql | `Install-All-Scripts.sql` | ソース | 全スクリプトインストーラー（同一ロジック含む、行14164） |
| Install-Azure.sql | `Install-Azure.sql` | ソース | Azure用インストーラー（同一ロジック含む、行1899） |
