このチュートリアルでは、調査から Runbook を作成するようにエージェントに依頼し、ポータル UI を使用してファイルをアップロードする 2 つの方法を使用して、Azure SRE エージェントのナレッジ ベースにナレッジ ドキュメントをアップロードします。
エージェントは、調査中に検出された知識をキャプチャし、将来の使用のために保存し、機関の知識を自動的に構築できます。 詳細については、「 ナレッジ ドキュメントのアップロード」を参照してください。
このチュートリアルでは、以下の内容を学習します。
- 調査を構造化された Runbook に変換し、ナレッジ ベースに保存する
- ポータル UI を使用してファイルを手動でアップロードする
- アップロードされたドキュメントのインデックスが作成され、使用可能であることを確認する
- エージェントが新しい会話でアップロードされたナレッジを取得することを確認する
推定時間: 15 分
前提条件
作業を開始する前に、次の準備ができていることを確認します。
- 実行中の状態の Azure SRE エージェント。
- エージェントに対する書き込みアクセス許可。
- エージェント実行モードが [確認 ] または [自律] に設定されている。
調査から始める
最高の知識ドキュメントは、実際の調査から得られたものです。 最初からコンテンツを作成する代わりに、エージェントが既に学習したことをキャプチャします。
- sre.azure.com に移動し、エージェントを選択します。
- 左側のサイドバーの [ チャット] で、エージェントが問題を診断または解決した以前の調査スレッドを見つけて選択します。
調査スレッドがまだない場合は、新しいチャットを開始し、エージェントに調査を依頼します。
Investigate high memory usage on our container apps
調査が完了するまで待ってから、次の手順に進みます。
調査に基づいてランブックを作成する
同じ調査スレッドで、その結果を Runbook に変換してナレッジ ベースに保存するようにエージェントに依頼します。 ファイル名について具体的に指定します。
Create a runbook from the investigation we just did. Include the root cause
analysis, the diagnostic steps, mitigations, and escalation triggers.
Save it to the knowledge base as high-memory-runbook.md
エージェントは、次のアクションを実行します。
- 調査コンテキストを構造化された手順書に合成します。
- 根本原因分析、診断手順、軽減策、エスカレーション トリガーなどのセクションを生成します。
- ドキュメントをナレッジ ベースに保存し、アップロードを確認します。
エージェントは、ドキュメントが保存されたことを確認し、ダウンロード リンクを提供します。 これで、Runbook はナレッジ ベースに格納され、検索用にインデックスが作成されます。
ヒント
拡張子が .md または .txt ファイル名を指定します。 これにより、ドキュメントのナレッジ ベースでの名前付け方法が制御され、後で簡単に見つけることができます。
注
エージェントが レビュー モードの場合は、アップロードを実行する前に承認を求められます。 [ 承認] を 選択して続行します。
この時点で、次の点を確認します。
- エージェントは、調査から構造化された Runbook を生成しました。
- エージェントは、ドキュメントが保存されたことを確認しました。
ナレッジ ベースでドキュメントを確認する
ナレッジ ベースに移動して、ドキュメントのインデックスが作成されたことを確認します。
- 左側のサイドバーで[ ビルダー ]を選択してセクションを展開します。
- ナレッジ ベースを選択します。
ナレッジ ベース ページには、ドキュメントがテーブルに表示され、 ファイル名、 状態、 種類、 最終更新日時の列が表示されます。 状態 列は、ドキュメントのインデックスが作成されて検索の準備が整うと、インデックス済みと表示されます。
状態が [保留中] と表示されている場合は、[ 最新の情報に更新] を選択します。 インデックス作成は通常、数秒以内に完了します。
ポータルを使用してファイルをアップロードする
ファイルを直接アップロードすることもできます。 この方法は、チームが既に持っている既存の Runbook、ドキュメント、または参照資料に役立ちます。
- [ ナレッジ ベース ] ページで、[ ファイルの追加] を選択します。
- ドロップ ゾーンにファイルをドラッグするか、[ ファイルの参照 ] を選択してファイルを選択します。
- ファイルを追加 を選択してアップロードします。
ポータルでは、次のファイルの種類を受け入れます。
-
テキスト:
.md、.txt、.csv、.json、.xml、.yaml、.yml、.log、.ini、.cfg、.conf、.config、.properties -
ドキュメント:
.pdf、.docx、.pptx、.xlsx、.doc、.ppt、.xls -
画像:
.png、.jpg、.jpeg、.gif、.bmp、.webp、.tiff、.tif
最大ファイル サイズはファイルあたり 16 MB で、アップロードあたり最大 100 MB です。
新しい会話での取得をテストする
エージェントがアップロードされたドキュメントを検索して使用できることを確認します。
- サイドバーで [新しいチャット スレッド ] を選択します。
- アップロードしたドキュメントが回答する必要がある質問をします。
例えば次が挙げられます。
What are the steps for troubleshooting high memory usage on container apps?
エージェントがナレッジベースを検索し、アップロードしたランブックを見つけ、それを応答で参照します。 これにより、ナレッジのインデックスが作成され、取得可能であることが確認されます。
インシデント後に知識を収集する
問題を解決したら、エージェントに学習内容を保持するよう依頼します。
Create a runbook from the steps we just used to resolve this incident.
Include the root cause, investigation steps, and the fix.
Save it as incident-12345-resolution.md in the knowledge base.
時間の経過とともに、これにより、検索可能な機関知識のライブラリが構築されます。 過去のすべてのインシデントは、将来のインシデントのリソースになります。
既存のドキュメントを更新する
以前のバージョンを置き換えるために、同じファイル名のドキュメントをアップロードします。
Update the high-memory-runbook.md document in the knowledge base.
Add a new section about container memory limits as a common cause.
CLI を使用したバッチ アップロード
CLI を使用して複数のドキュメントを一度にインポートします。
# Upload a single file
srectl doc upload --file ./runbooks/high-memory-guide.md
# Upload all .md and .txt files in a folder (recursive)
srectl doc upload --file ./runbooks
Troubleshooting
ナレッジ ドキュメントのアップロードに関する一般的な問題を解決するには、次の表を使用します。
| エラー | 原因 | 修正 |
|---|---|---|
| "エージェント メモリが無効になっています。 ドキュメントをアップロードできません。" | エージェントでナレッジ ベースが有効になっていません。 | ナレッジ ベースを有効にするには、管理者に問い合わせてください。 |
| "ナレッジ ベースへの書き込みアクセス権がありません" | エージェントがアップロード ツールを見つけることができませんでした。 | 要求の言い換え: "filename.md としてナレッジ ベースに保存する" |
| "ファイル拡張子が無効です。 .md ファイルと .txt ファイルのみが許可されます。" | ファイル名が .md または .txt (チャットのアップロード) で終わることはありません。 |
エージェントに保存を依頼するときは、 .md または .txt 拡張機能を使用します。 |
| "ドキュメント コンテンツの最大サイズが 16 MB を超えています" | 1 つのドキュメントに対してコンテンツが大きすぎます。 | 複数の小さなドキュメントに分割します。 |
| "ファイル名を空にすることはできません" | ファイル名が指定されていません。 | プロンプトにファイル名を含めます (例: runbook.md)。 |