Graphify ナレッジグラフガイド
プロジェクトのドキュメント・ソース・タグを 3D ナレッジグラフとして可視化し、ノード間のつながりを探索する方法を説明します。
📋 概要
Graphify は、選択したプロジェクト(csn)に属するドキュメント、ソースコード、タグを、ノードとリンクからなる 3D ナレッジグラフとして表示する画面です。ノードは種類ごとに色分けされ、重要度(加重リンク数)順に並べて表示されます。
🔍 主な要素の説明
1. 上部ヘッダー
現在レンダリングされているノード数、全ノード数、リンク数を 表示 / 全体 nodes · N links の形式で表示します。
2. ノード検索
ヘッダーの検索ボックスにラベルまたはパス(path)の一部を入力すると、全ノードから一致するノードを探し、左側に結果一覧として表示します。結果をクリックすると、そのノードがグラフに現れて選択されます。
3. 3D グラフキャンバス
ノードは種類ごとに色分けされます。左下の凡例のとおり、Doc / Spec(アンバー)、Code / Source(スカイブルー)、Tag(グリーン)です。ノードをクリックすると選択してインスペクターを開き、背景をクリックすると選択が解除されます。
4. ノードインスペクター(右パネル)
選択したノードの種類バッジ、リンク数、パスを表示し、2 種類の関係リストを提供します。
- Backlinks: このノードを指す(入ってくる)ノードの一覧
- Outgoing links: このノードが指す(出ていく)ノードの一覧
一覧の項目をクリックするとそのノードへ移動(ドリルダウン)します。前のノードに戻るには、パネル左上の戻るボタンを使います。
5. ドキュメント本文ポップアップ
インスペクターのノードタイトルをクリックすると、レイヤーポップアップが開きます。ノードが KB ドキュメント(パスが kb/<番号>)の場合、本文全体を Markdown で表示します。それ以外のノードには、表示する本文がない旨の案内が出ます。Esc キーでポップアップを閉じられます。
🛠️ 活用のヒント
- さらに読み込む: グラフはパフォーマンスのため、重要度上位 50 件のノードのみを先に表示します。下部中央の [Load N more] ボタンで次の 50 件を追加読み込みできます。
- 同期: ヘッダー右側の [Sync] ボタンを押すと、グラフデータを再読み込みします。
💡 注意事項
- プロジェクトが選択されていない場合は「No Project Selected」画面が表示されます。上部ナビゲーションからプロジェクトを選択してください。
- グラフの閲覧はログインなしでも可能ですが、KB ドキュメントの本文はログイン(認証トークン)がないと閲覧できません。
🔌 API でグラフを管理する(追加・編集・削除・再構築)
Graphify のグラフは KB エントリ(tKB)から派生します。API でエントリを追加・編集・削除したあと、再構築を呼ぶとグラフに反映されます。つながり(エッジ)は手で引くのではなく、再構築がエントリから自動生成します。
- ホスト:
https://giipfaw.azurewebsites.net - 認証: すべての書き込み API は、ヘッダー
x-api-keyにログインユーザーの AK またはプロジェクトスコープの SK が必要です。キーは 自身のcsn範囲 内でのみ追加・編集・削除・再構築できます。 - ワークフロー:
追加/編集/削除(giipKb)→再構築(giipGraphifyRebuild)→確認(giipGraphify)
1) ノード追加 — giipKb POST
curl -X POST "https://giipfaw.azurewebsites.net/api/giipKb" \
-H "x-api-key: <AK_OR_SK>" -H "Content-Type: application/json" \
-d '{"csn":47,"title":"OAuth コールバック 500","content":"## 原因\ntoken 交換タイムアウト","tags":"auth,oauth,timeout","refType":"ISSUE","extRefId":"ISSUE-1001"}'
titleがグラフの ノードラベル、contentはノードをクリックしたときの 本文ポップアップ(Markdown)になります。extRefIdを指定すると 冪等 upsert — 同じ値で再送すると新規作成せず更新します。- レスポンス:
{ "success": true, "kbSn": 844, "message": "..." }
2) ノード編集 — giipKb PUT
curl -X PUT "https://giipfaw.azurewebsites.net/api/giipKb" \
-H "x-api-key: <AK_OR_SK>" -H "Content-Type: application/json" \
-d '{"kbSn":844,"title":"OAuth コールバック 500(解決)","content":"## 対処\nタイムアウト 30s->90s","tags":"auth,oauth,resolved"}'
kbSnで対象エントリを指定します。
3) ノード削除 — giipKb DELETE
curl -X DELETE "https://giipfaw.azurewebsites.net/api/giipKb?kbSn=844" \
-H "x-api-key: <AK_OR_SK>"
4) 再構築(つながり生成)— giipGraphifyRebuild POST
エントリを追加/編集/削除したあと、変更を反映するには 必ず呼び出し ます。その csn のノード・エッジを KB エントリから再生成します。
curl -X POST "https://giipfaw.azurewebsites.net/api/giipGraphifyRebuild" \
-H "x-api-key: <AK_OR_SK>" -H "Content-Type: application/json" \
-d '{"csn":47}'
- レスポンス:
{ "success": true, "csn": 47, "nodes": 838, "edges": 11, "message": "Graph rebuilt" } - 任意パラメータ(大規模プロジェクトの性能チューニング):
maxNodes: グラフ化する最新エントリの上限(既定 400)scanLen: つながり探索時に本文先頭をスキャンする長さ(既定 1500)
-d '{"csn":47,"maxNodes":800,"scanLen":2000}'
5) グラフ取得 — giipGraphify GET
ページが内部で使う読み取り API です(認証なしで取得可能)。直接確認する場合:
curl "https://giipfaw.azurewebsites.net/api/giipGraphify?csn=47"
- レスポンス:
{ "nodes": [...], "links": [...] }
フィールドの全仕様は 📘 API リファレンス概要 を参照してください。
トラブルシューティング
| 症状 | 原因 | 解決 |
|---|---|---|
| 「No Project Selected」しか表示されない | プロジェクト(csn)が指定されていない | 上部ナビゲーションでプロジェクトを選択します。 |
| ドキュメントポップアップに「ログインが必要」と表示される | KB 本文取得の認証トークンがない | ログインしてから、もう一度ノードタイトルをクリックします。 |
| ノードに本文がないと表示される | そのノードが KB ドキュメント(kb/…)ではない | 本文は KB ドキュメントノードにのみ提供されます。正常な動作です。 |
| 一部のノードがグラフに見えない | 重要度上位 50 件のみが先に表示されている | 下部の [Load N more] で追加読み込みするか、検索でノードを表示します。 |
API Error または読み込み失敗 | セッション期限切れ、またはサーバー応答エラー | エラーバナーの [Retry] を押すか、再度ログインします。 |
バージョン: 1.0
最終更新: 2026-07-22
ソースファイル: giipv3/public/help/graphify.ja.md