RAGSpine
ガイド

パイプライン

静的なエンジン PipelineGraph のエクスポートと、表示専用のワークフロープレビュー v1 プロトコルとの違い。

pipeline ドメイン(src/ragspine/pipeline/)は、グラフフレームワーク(Dify、LangGraph)が提供し、素の Python エンジンでは得られない唯一のもの——パイプラインの視覚的なダイアグラム——に対する、RAGSpine のコードファーストな回答です。自分で記述したうえで現実と一致していることを祈るしかないグラフ DSL の代わりに、RAGSpine は実際の配線から静的な PipelineGraph導出 し、Mermaid、DOT、または JSON として出力します。

このドメインは小さく、リーフレベルで、厳密に読み取り専用です。オーケストレーターからは何も import しない(すべてのイントロスペクションは getattr によるダックタイピング)ため、記述対象のシステムを乱すことは決してありません。

このエンジントポロジーモデルは ワークフロープレビュー v1 とは別物です。PipelineGraph は組み立てられた RAGSpine コンポーネントを記述し、Mermaid/DOT/JSON をエクスポートします。ワークフロープレビューは、秘匿化されたノード・エッジ・ジオメトリを持つ 1 つの Dify 互換ワークフローを記述します。どちらも読み取り専用であり、いずれも実行形式ではありません。

レイアウト

graph.py
topology.py

graph.py は依存ゼロの値レイヤー(frozen dataclass + エクスポーター)で、 topology.py はライブな構成を読み取る 3 つのビルダーを保持します。公開 API は NodeEdgePipelineGraphagent_topologyretriever_topologyservice_topology の 6 つの名前を再エクスポートします。

値モデル

graph.py は 3 つの frozen dataclass を定義します:

プロパティ

PipelineGraph は 3 つのエクスポーターと 1 つの結合メソッドを備えています:

メソッド戻り値出力
to_mermaid(*, direction="TD")strflowchart — ノードの形状は kind によって選択されます(gate は {}、store は [(...)]、channel は ([...])、それ以外は長方形)。
to_dot()strGraphviz の digraphrankdir=TB)。
to_dict()dictJSON でラウンドトリップ可能な {title, nodes[...], edges[...]}
merge(other, *, group=None)PipelineGraphノードを id で重複排除し(先勝ち)、すべてのエッジを保持します。オプションで、追加されたノードに domain=group をタグ付けします。

エクスポートは実行間で決定的かつバイト単位で同一です(宣言順が安定しているため)。domain によるグルーピングは to_dict を通じてラウンドトリップしますが、v1 では to_mermaid / to_dot は subgraph/cluster ブロックを出力しません。

3 つのビルダー

topology.py は、ライブでダックタイピングされた構成からグラフを導出します——ノードは、 そのコンポーネントが実際に配線されている場合にのみ現れます。

agent_topology(*, narrative_retriever=None)

リクエストフローの全体像: parse_intent → clarify_scope(data エッジ経由で SecurityGate に問い合わせ)→ route の分岐(ダイヤモンド)→ structured / narrative / composite の各ブランチ。narrative ノードは narrative_retriever が注入されている場合にのみ現れます。

retriever_topology(retriever)

HybridRetriever のサブパイプライン: prefilter → BM25 [+vector] [+multi-query] → RRF → top_k。vector ノードは retriever.embedding_backend が設定されている場合にのみ、multi-query ノードは query_rewriter が設定されている場合にのみ現れます。再ランキング(rerank)は意図的にこのサブグラフには含めていません。

service_topology(app)

サービスのトポロジー: agent の上流にある FAQ ショートサーキットに加え、非同期インジェスションパス(routes → queue → jobs)。app.state.faq_cache と app.state.queue に対してダックタイピングします。

HybridRetriever.topology()retrieval(検索) ドメイン内)は retriever_topology への薄い委譲です——これにより、pipeline パッケージがオーケストレーターを import することなく、構成済みの retriever が自分自身を描画できます。

CLI — scripts/topology.py

scripts/topology.py は、3 つのトポロジーのいずれもオフラインかつ決定的に描画します (デフォルト/モックのアセンブリを組み立てるため、Redis も API キーも不要です)。プロジェクトルートから 実行してください:

python scripts/topology.py                                  # agent → Mermaid → stdout
python scripts/topology.py --which retriever --of dot
python scripts/topology.py --of json --out docs/generated/topology.json

フラグ:

  • --of {mermaid,dot,json} — 出力形式(デフォルトは mermaid)。
  • --which {agent,retriever,service} — 対象のトポロジー(デフォルトは agent)。
  • --out PATH — ファイルへ書き出します(親ディレクトリを作成します)。省略すると stdout に出力します。 git-ignore された docs/generated/ に書き込むことで、再生成したダイアグラムの diff がクリーンに保たれます。

内部では、CLI は各トポロジーをデフォルト/オフラインのアセンブリから組み立てます: retrieverretriever_topology(HybridRetriever([]))(空のコーパス上の純 BM25 スケルトン)、 serviceMockProvider / FakeQueue / 空の FAQCache を使った create_app(...) の後に service_topology(app)agentagent_topology(narrative_retriever=object()) (narrative/composite ブランチを表示させるためのセンチネル)。

Python API

from ragspine.pipeline import agent_topology

graph = agent_topology(narrative_retriever=object())
print(graph.to_mermaid())   # Mermaid flowchart string
print(graph.to_dot())       # Graphviz digraph string

import json
print(json.dumps(graph.to_dict(), ensure_ascii=False, indent=2))

関連ページ

このページ