# 通知設計書 88-AI分析完了

## 概要

本ドキュメントは、SQL Server First Responder Kitのsp_BlitzCache.sqlにおける「AI分析完了」通知の設計を定義する。この通知は、クエリプラン分析におけるAI（人工知能）サービスへの全てのAPI呼び出しが完了したことを示す情報メッセージである。

### 本通知の処理概要

この通知は、sp_BlitzCacheストアドプロシージャがAIエンドポイントへの全てのAPI呼び出しを完了し、分析結果が##BlitzCacheProcsテーブルに格納されたことを示す。@AIパラメータが1に設定されている場合にのみ、この通知が出力される。

**業務上の目的・背景**：AI分析は外部APIへの呼び出しを伴う時間のかかる処理である。この通知により、ユーザーは全てのAI分析が正常に完了したことを確認できる。処理完了後、結果セットにはai_adviceカラムにAIからのアドバイスが含まれ、ユーザーはこれを参照してクエリ最適化の方向性を決定できる。

**通知の送信タイミング**：sp_BlitzCacheプロシージャの実行中、@AI = 1の場合に、全てのクエリに対するAIエンドポイント呼び出しが完了し、カーソルがクローズされた直後のタイミングで送信される。

**通知の受信者**：この通知はRAISERROR関数によりSQL Server Management Studio（SSMS）のメッセージウィンドウ、またはsqlcmdなどのコマンドラインツールの標準出力に表示される。主な受信者は、sp_BlitzCacheを@AI=1で実行しているDBA、データベース開発者、システム管理者である。

**通知内容の概要**：「AI analysis complete」という英語メッセージが表示され、AI分析処理が全て完了したことを示す。これにより、結果の確認が可能になったことを把握できる。

**期待されるアクション**：通知の受信者は、AI分析が完了したことを認識し、結果セットのai_adviceカラムを確認してクエリ最適化のアドバイスを参照する。必要に応じて、アドバイスに基づいてクエリやインデックスの改善を実施する。

## 通知種別

コンソール出力（RAISERROR WITH NOWAIT）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（WITH NOWAITオプションにより即座に出力） |
| 優先度 | 低（情報レベル、重大度0） |
| リトライ | なし（単発の情報メッセージ） |

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

sp_BlitzCacheを実行しているセッションのクライアント接続に対して直接出力される。送信先の動的な決定ロジックは存在せず、実行元のセッションに対して常に通知される。

## 通知テンプレート

### メール通知の場合

該当なし（コンソール出力のみ）

### 本文テンプレート

```
AI analysis complete
```

### 添付ファイル

該当なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ実行 | sp_BlitzCache内のAI分析ループ完了 | @AI = 1 | AI API呼び出しが有効な場合のみ通知 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @AI = 0または未指定 | AI機能が無効の場合は通知されない |
| @AI = 2 | プロンプト生成のみの場合は通知されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[AIエンドポイント呼び出しループ] --> B[全クエリ処理完了]
    B --> C[CLOSE ai_cursor]
    C --> D[DEALLOCATE ai_cursor]
    D --> E[RAISERROR実行]
    E --> F[メッセージ即時出力]
    F --> G{@Debug = 2?}
    G -->|Yes| H[デバッグ結果セット出力]
    G -->|No| I[結果表示処理へ]
    H --> I
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| ##BlitzCacheProcs | プランキャッシュ分析結果の格納 | グローバル一時テーブル |

### テーブル別参照項目詳細

この通知自体はテーブルの参照・更新を行わない。AI分析結果は既に##BlitzCacheProcsテーブルに格納済みである。

#### ##BlitzCacheProcs（AI分析完了時点の状態）

| 参照項目（カラム名） | 用途 | 備考 |
|-------------------|------|---------|
| ai_prompt | 生成されたプロンプト | 分析に使用されたプロンプト |
| ai_advice | AIからのアドバイス | OpenAI/Geminiからの応答内容 |
| ai_raw_response | APIレスポンスJSON | デバッグ・検証用 |
| ai_payload | 送信ペイロード | デバッグ・検証用 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | この通知時点では更新なし |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | この通知はエラー処理後に出力される | - |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（sp_BlitzCache実行時に即座に出力）

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

- 通知内容に機密情報は含まれない
- VIEW SERVER STATE権限が必要（sp_BlitzCache実行の前提条件）
- AI分析結果（ai_advice）にはクエリ固有の情報が含まれる可能性がある

## 備考

- この通知はsp_BlitzCacheのAI機能の一部であり、@AI = 1の場合にのみ表示される
- WITH NOWAITオプションにより、バッファリングなしで即座にクライアントに送信される
- 重大度0は情報メッセージを意味し、エラーではない
- @Debug = 2の場合、この通知の直後にai_prompt、ai_advice、ai_raw_responseを含むデバッグ結果セットが出力される
- この通知はAI分析のマイルストーンであり、後続の結果表示処理に進む合図となる

---

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

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

### 推奨読解順序

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

まず、AI分析結果が格納されるカラムの構造を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | ##BlitzCacheProcsテーブルのai_prompt、ai_advice、ai_raw_response、ai_payloadカラムの内容を確認 |

**読解のコツ**: AI分析完了後、これらのカラムには各クエリに対するAIからの応答が格納されている。

#### Step 2: エントリーポイントを理解する

処理の完了ポイントを把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | カーソルクローズ後のRAISERROR呼び出し位置 |

**主要処理フロー**:
1. **行5451**: FETCH NEXTでカーソルループ継続
2. **行5453**: CLOSE ai_cursor でカーソルクローズ
3. **行5454**: DEALLOCATE ai_cursor でカーソル解放
4. **行5456**: RAISERROR('AI analysis complete', 0, 1) WITH NOWAITでメッセージ出力

#### Step 3: デバッグ出力を理解する

@Debug = 2の場合の追加出力を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | IF @Debug = 2による条件付きSELECT出力 |

**主要処理フロー**:
- **行5458-5461**: @Debug = 2の場合、ai_stage = 'After Calling AI'として結果セットを出力

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

```
sp_BlitzCache
    |
    +-- IF @AI = 1
            |
            +-- RAISERROR('Calling AI endpoint... - starting loop')
            |
            +-- CURSOR ai_cursor
            |       |
            |       +-- WHILE @@FETCH_STATUS = 0
            |               |
            |               +-- RAISERROR('Calling AI endpoint... on query:')
            |               |
            |               +-- sp_invoke_external_rest_endpoint
            |               |
            |               +-- UPDATE ##BlitzCacheProcs (ai_advice等)
            |
            +-- CLOSE ai_cursor
            |
            +-- DEALLOCATE ai_cursor
            |
            +-- RAISERROR('AI analysis complete')  <-- 本通知
            |
            +-- IF @Debug = 2
                    |
                    +-- SELECT 'After Calling AI', ai_prompt, ai_advice, ai_raw_response
```

### データフロー図

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

ai_cursorループ完了        --> CLOSE ai_cursor               --> カーソルリソース解放
                               |
                               v
                           DEALLOCATE ai_cursor
                               |
                               v
                           コンソール出力 <-- RAISERROR
                           "AI analysis complete"
                               |
                               v
                           @Debug = 2の場合
                               |
                               v
##BlitzCacheProcs          --> SELECT結果セット出力
- SqlHandle                     - ai_stage = 'After Calling AI'
- QueryHash                     - SqlHandle
- PlanHandle                    - QueryHash
- QueryPlan                     - PlanHandle
- ai_prompt                     - QueryPlan
- ai_advice                     - ai_prompt
- ai_raw_response               - ai_advice
                                - ai_raw_response
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzCache.sql | `sp_BlitzCache.sql` | ソース | AI分析完了通知を含むメインストアドプロシージャ |
